The python export class for CosmeticEdge. More...

#include <CosmeticEdgePy.h>

Public Types

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

Public Member Functions

 CosmeticEdgePy (CosmeticEdge *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 CosmeticEdgePy. More...
 
static PyMethodDef Methods []
 Methods structure of CosmeticEdgePy. More...
 
static PyTypeObject Type
 Type structure of CosmeticEdgePy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~CosmeticEdgePy ()
 
- 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...
 
Py::Object getStart (void) const
 getter for the Start attribute More...
 
void setStart (Py::Object arg)
 setter for the Start attribute More...
 
Py::Object getEnd (void) const
 getter for the End attribute More...
 
void setEnd (Py::Object arg)
 setter for the End attribute More...
 
Py::Object getCenter (void) const
 getter for the Center attribute More...
 
void setCenter (Py::Object arg)
 setter for the Center attribute More...
 
Py::Object getRadius (void) const
 getter for the Radius attribute More...
 
void setRadius (Py::Object arg)
 setter for the Radius attribute More...
 
Py::Object getFormat (void) const
 getter for the Format attribute More...
 
void setFormat (Py::Object arg)
 setter for the Format 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...
 
CosmeticEdgegetCosmeticEdgePtr (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...
 
static PyObjectstaticCallback_getStart (PyObject *self, void *closure)
 getter callback for the Start attribute More...
 
static int staticCallback_setStart (PyObject *self, PyObject *value, void *closure)
 setter callback for the Start attribute More...
 
static PyObjectstaticCallback_getEnd (PyObject *self, void *closure)
 getter callback for the End attribute More...
 
static int staticCallback_setEnd (PyObject *self, PyObject *value, void *closure)
 setter callback for the End attribute More...
 
static PyObjectstaticCallback_getCenter (PyObject *self, void *closure)
 getter callback for the Center attribute More...
 
static int staticCallback_setCenter (PyObject *self, PyObject *value, void *closure)
 setter callback for the Center attribute More...
 
static PyObjectstaticCallback_getRadius (PyObject *self, void *closure)
 getter callback for the Radius attribute More...
 
static int staticCallback_setRadius (PyObject *self, PyObject *value, void *closure)
 setter callback for the Radius attribute More...
 
static PyObjectstaticCallback_getFormat (PyObject *self, void *closure)
 getter callback for the Format attribute More...
 
static int staticCallback_setFormat (PyObject *self, PyObject *value, void *closure)
 setter callback for the Format attribute More...
 

Additional Inherited Members

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

Detailed Description

The python export class for CosmeticEdge.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~CosmeticEdgePy()

CosmeticEdgePy::~CosmeticEdgePy ( )
protected

◆ CosmeticEdgePy()

CosmeticEdgePy::CosmeticEdgePy ( CosmeticEdge pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ clone()

◆ copy()

PyObject * CosmeticEdgePy::copy ( PyObject args)

implementer for the copy() method

References TechDraw::CosmeticEdge::copy(), getCosmeticEdgePtr(), and GetType().

Referenced by staticCallback_copy().

◆ getCenter()

Py::Object CosmeticEdgePy::getCenter ( void  ) const

◆ getCosmeticEdgePtr()

CosmeticEdge * CosmeticEdgePy::getCosmeticEdgePtr ( void  ) const

◆ getCustomAttributes()

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

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

◆ getEnd()

Py::Object CosmeticEdgePy::getEnd ( void  ) const

◆ getFormat()

◆ getRadius()

Py::Object CosmeticEdgePy::getRadius ( void  ) const

◆ getStart()

Py::Object CosmeticEdgePy::getStart ( void  ) const

◆ getTag()

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

getter for the Tag attribute

References getCosmeticEdgePtr().

Referenced by staticCallback_getTag().

◆ GetType()

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

Reimplemented from Base::PyObjectBase.

Referenced by clone(), and copy().

◆ PyInit()

int CosmeticEdgePy::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 * CosmeticEdgePy::PyMake ( struct _typeobject *  ,
PyObject ,
PyObject  
)
static

◆ representation()

◆ setCenter()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setEnd()

◆ setFormat()

◆ setRadius()

◆ setStart()

◆ staticCallback_clone()

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

◆ staticCallback_copy()

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

◆ staticCallback_getCenter()

PyObject * CosmeticEdgePy::staticCallback_getCenter ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getEnd()

PyObject * CosmeticEdgePy::staticCallback_getEnd ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getFormat()

PyObject * CosmeticEdgePy::staticCallback_getFormat ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getRadius()

PyObject * CosmeticEdgePy::staticCallback_getRadius ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getStart()

PyObject * CosmeticEdgePy::staticCallback_getStart ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getTag()

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

◆ staticCallback_setCenter()

int CosmeticEdgePy::staticCallback_setCenter ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setEnd()

int CosmeticEdgePy::staticCallback_setEnd ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setFormat()

int CosmeticEdgePy::staticCallback_setFormat ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setRadius()

int CosmeticEdgePy::staticCallback_setRadius ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setStart()

int CosmeticEdgePy::staticCallback_setStart ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setTag()

int CosmeticEdgePy::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 CosmeticEdgePy::GetterSetter
static

Attribute structure of CosmeticEdgePy.

◆ Methods

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

Methods structure of CosmeticEdgePy.

◆ Type


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