The python export class for GeomFormat. More...

#include <GeomFormatPy.h>

Public Types

typedef GeomFormatPointerType
 
- Public Types inherited from Base::PyObjectBase
typedef void * PointerType
 
enum  Status { Valid = 0 , Immutable = 1 , Notify = 2 , NoTrack = 3 }
 

Public Member Functions

 GeomFormatPy (GeomFormat *pcObject, PyTypeObject *T=&Type)
 
virtual PyTypeObject * GetType (void)
 
virtual int PyInit (PyObject *args, PyObject *k)
 PyInit method Override this method to initialize a newly created instance of the class (Constructor) More...
 
std::string representation (void) const
 
- Public Member Functions inherited from Base::PyObjectBase
PyObjectBaseDecRef (void)
 decref method wrapper (see python extending manual) More...
 
PyObjectBaseIncRef (void)
 incref method wrapper (see python extending manual) More...
 
bool isConst ()
 
bool isNotTracking () const
 
bool isValid ()
 
 PyObjectBase (void *, PyTypeObject *T)
 Constructor Sets the Type of the object (for inheritance) and decrease the the reference count of the PyObject. More...
 
void setConst ()
 
void setInvalid ()
 
void setNotTracking (bool on=true)
 
void setShouldNotify (bool on)
 
bool shouldNotify () const
 
void startNotify ()
 

Static Public Member Functions

static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from Base::PyObjectBase
static void PyDestructor (PyObject *P)
 Wrapper for the Python destructor. More...
 

Static Public Attributes

static PyGetSetDef GetterSetter []
 Attribute structure of GeomFormatPy. More...
 
static PyMethodDef Methods []
 Methods structure of GeomFormatPy. More...
 
static PyTypeObject Type
 Type structure of GeomFormatPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~GeomFormatPy ()
 
- Protected Member Functions inherited from Base::PyObjectBase
void setTwinPointer (void *ptr)
 Overrides the pointer to the twin object. More...
 
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObjectclone (PyObject *args)
 implementer for the clone() method More...
 
PyObjectcopy (PyObject *args)
 implementer for the copy() method More...
 
static PyObjectstaticCallback_clone (PyObject *self, PyObject *args)
 callback for the clone() method More...
 
static PyObjectstaticCallback_copy (PyObject *self, PyObject *args)
 callback for the copy() method More...
 

callbacks and implementers for the python object attributes

Py::String getTag (void) const
 getter for the Tag attribute More...
 
PyObjectgetCustomAttributes (const char *attr) const
 getter method for special attributes (e.g. dynamic ones) More...
 
int setCustomAttributes (const char *attr, PyObject *obj)
 setter for special attributes (e.g. More...
 
GeomFormatgetGeomFormatPtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_getTag (PyObject *self, void *closure)
 getter callback for the Tag attribute More...
 
static int staticCallback_setTag (PyObject *self, PyObject *value, void *closure)
 setter callback for the Tag attribute More...
 

Additional Inherited Members

- Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 > StatusBits
 

Detailed Description

The python export class for GeomFormat.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~GeomFormatPy()

GeomFormatPy::~GeomFormatPy ( )
protected

◆ GeomFormatPy()

GeomFormatPy::GeomFormatPy ( GeomFormat pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ clone()

◆ copy()

PyObject * GeomFormatPy::copy ( PyObject args)

implementer for the copy() method

References TechDraw::GeomFormat::copy(), getGeomFormatPtr(), and GetType().

Referenced by staticCallback_copy().

◆ getCustomAttributes()

PyObject * GeomFormatPy::getCustomAttributes ( const char *  attr) const

getter method for special attributes (e.g. dynamic ones)

◆ getGeomFormatPtr()

GeomFormat * GeomFormatPy::getGeomFormatPtr ( void  ) const

getter for the object handled by this class

Referenced by clone(), copy(), getTag(), and TechDraw::PropertyGeomFormatList::setPyObject().

◆ getTag()

Py::String GeomFormatPy::getTag ( void  ) const

getter for the Tag attribute

References getGeomFormatPtr().

Referenced by staticCallback_getTag().

◆ GetType()

virtual PyTypeObject* TechDraw::GeomFormatPy::GetType ( void  )
virtual

Reimplemented from Base::PyObjectBase.

Referenced by clone(), and copy().

◆ PyInit()

int GeomFormatPy::PyInit ( PyObject ,
PyObject  
)
virtual

PyInit method Override this method to initialize a newly created instance of the class (Constructor)

Reimplemented from Base::PyObjectBase.

◆ PyMake()

PyObject * GeomFormatPy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
)
static

◆ representation()

◆ setCustomAttributes()

int GeomFormatPy::setCustomAttributes ( const char *  attr,
PyObject obj 
)

setter for special attributes (e.g.

dynamic ones) Output: Success=1, Failure=-1, Ignore=0

◆ staticCallback_clone()

PyObject * GeomFormatPy::staticCallback_clone ( PyObject self,
PyObject args 
)
static

◆ staticCallback_copy()

PyObject * GeomFormatPy::staticCallback_copy ( PyObject self,
PyObject args 
)
static

◆ staticCallback_getTag()

PyObject * GeomFormatPy::staticCallback_getTag ( PyObject self,
void *  closure 
)
static

◆ staticCallback_setTag()

int GeomFormatPy::staticCallback_setTag ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Tag attribute

References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().

Member Data Documentation

◆ GetterSetter

PyGetSetDef GeomFormatPy::GetterSetter
static
Initial value:
= {
{"Tag",
"Gives the tag of the GeomFormat as string.",
NULL
},
{NULL, NULL, NULL, NULL, NULL}
}
static PyObject * staticCallback_getTag(PyObject *self, void *closure)
getter callback for the Tag attribute
Definition: GeomFormatPy.cpp:243
static int staticCallback_setTag(PyObject *self, PyObject *value, void *closure)
setter callback for the Tag attribute
Definition: GeomFormatPy.cpp:261

Attribute structure of GeomFormatPy.

◆ Methods

PyMethodDef GeomFormatPy::Methods
static
Initial value:
= {
{"clone",
reinterpret_cast<PyCFunction>( staticCallback_clone ),
METH_VARARGS,
"Create a clone of this geomformat"
},
{"copy",
reinterpret_cast<PyCFunction>( staticCallback_copy ),
METH_VARARGS,
"Create a copy of this geomformat"
},
{NULL, NULL, 0, NULL}
}
static PyObject * staticCallback_copy(PyObject *self, PyObject *args)
callback for the copy() method
Definition: GeomFormatPy.cpp:182
static PyObject * staticCallback_clone(PyObject *self, PyObject *args)
callback for the clone() method
Definition: GeomFormatPy.cpp:121

Methods structure of GeomFormatPy.

◆ Type


The documentation for this class was generated from the following files:
  • Sources/FreeCAD-SourceDocs/src/Mod/TechDraw/App/GeomFormatPy.h
  • Sources/FreeCAD/src/Mod/TechDraw/App/GeomFormatPyImp.cpp
  • Sources/FreeCAD-SourceDocs/src/Mod/TechDraw/App/GeomFormatPy.cpp