The python export class for CosmeticVertex. More...

#include <CosmeticVertexPy.h>

Public Types

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

Public Member Functions

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

Protected Member Functions

 ~CosmeticVertexPy ()
 
- 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 getPoint (void) const
 getter for the Point attribute More...
 
void setPoint (Py::Object arg)
 setter for the Point attribute More...
 
Py::Boolean getShow (void) const
 getter for the Show attribute More...
 
void setShow (Py::Boolean arg)
 setter for the Show attribute More...
 
Py::Object getColor (void) const
 getter for the Color attribute More...
 
void setColor (Py::Object arg)
 setter for the Color attribute More...
 
Py::Object getSize (void) const
 getter for the Size attribute More...
 
void setSize (Py::Object arg)
 setter for the Size attribute More...
 
Py::Object getStyle (void) const
 getter for the Style attribute More...
 
void setStyle (Py::Object arg)
 setter for the Style 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...
 
CosmeticVertexgetCosmeticVertexPtr (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_getPoint (PyObject *self, void *closure)
 getter callback for the Point attribute More...
 
static int staticCallback_setPoint (PyObject *self, PyObject *value, void *closure)
 setter callback for the Point attribute More...
 
static PyObjectstaticCallback_getShow (PyObject *self, void *closure)
 getter callback for the Show attribute More...
 
static int staticCallback_setShow (PyObject *self, PyObject *value, void *closure)
 setter callback for the Show attribute More...
 
static PyObjectstaticCallback_getColor (PyObject *self, void *closure)
 getter callback for the Color attribute More...
 
static int staticCallback_setColor (PyObject *self, PyObject *value, void *closure)
 setter callback for the Color attribute More...
 
static PyObjectstaticCallback_getSize (PyObject *self, void *closure)
 getter callback for the Size attribute More...
 
static int staticCallback_setSize (PyObject *self, PyObject *value, void *closure)
 setter callback for the Size attribute More...
 
static PyObjectstaticCallback_getStyle (PyObject *self, void *closure)
 getter callback for the Style attribute More...
 
static int staticCallback_setStyle (PyObject *self, PyObject *value, void *closure)
 setter callback for the Style attribute More...
 

Additional Inherited Members

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

Detailed Description

The python export class for CosmeticVertex.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~CosmeticVertexPy()

CosmeticVertexPy::~CosmeticVertexPy ( )
protected

◆ CosmeticVertexPy()

CosmeticVertexPy::CosmeticVertexPy ( CosmeticVertex pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ clone()

◆ copy()

PyObject * CosmeticVertexPy::copy ( PyObject args)

implementer for the copy() method

References TechDraw::CosmeticVertex::copy(), getCosmeticVertexPtr(), and GetType().

Referenced by staticCallback_copy().

◆ getColor()

Py::Object CosmeticVertexPy::getColor ( void  ) const

◆ getCosmeticVertexPtr()

◆ getCustomAttributes()

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

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

◆ getPoint()

◆ getShow()

Py::Boolean CosmeticVertexPy::getShow ( void  ) const

getter for the Show attribute

References getCosmeticVertexPtr(), and TechDraw::CosmeticVertex::visible.

Referenced by staticCallback_getShow().

◆ getSize()

Py::Object CosmeticVertexPy::getSize ( void  ) const

getter for the Size attribute

References getCosmeticVertexPtr(), and TechDraw::CosmeticVertex::size.

Referenced by staticCallback_getSize().

◆ getStyle()

Py::Object CosmeticVertexPy::getStyle ( void  ) const

getter for the Style attribute

References getCosmeticVertexPtr(), and TechDraw::CosmeticVertex::style.

Referenced by staticCallback_getStyle().

◆ getTag()

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

getter for the Tag attribute

References getCosmeticVertexPtr().

Referenced by staticCallback_getTag().

◆ GetType()

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

Reimplemented from Base::PyObjectBase.

Referenced by clone(), and copy().

◆ PyInit()

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

◆ representation()

◆ setColor()

void CosmeticVertexPy::setColor ( Py::Object  arg)

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setPoint()

◆ setShow()

void CosmeticVertexPy::setShow ( Py::Boolean  arg)

setter for the Show attribute

References getCosmeticVertexPtr(), and TechDraw::CosmeticVertex::visible.

Referenced by staticCallback_setShow().

◆ setSize()

void CosmeticVertexPy::setSize ( Py::Object  arg)

setter for the Size attribute

References getCosmeticVertexPtr(), and TechDraw::CosmeticVertex::size.

Referenced by staticCallback_setSize().

◆ setStyle()

void CosmeticVertexPy::setStyle ( Py::Object  arg)

setter for the Style attribute

References getCosmeticVertexPtr(), and TechDraw::CosmeticVertex::style.

Referenced by staticCallback_setStyle().

◆ staticCallback_clone()

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

◆ staticCallback_copy()

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

◆ staticCallback_getColor()

PyObject * CosmeticVertexPy::staticCallback_getColor ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getPoint()

PyObject * CosmeticVertexPy::staticCallback_getPoint ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getShow()

PyObject * CosmeticVertexPy::staticCallback_getShow ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getSize()

PyObject * CosmeticVertexPy::staticCallback_getSize ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getStyle()

PyObject * CosmeticVertexPy::staticCallback_getStyle ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getTag()

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

◆ staticCallback_setColor()

int CosmeticVertexPy::staticCallback_setColor ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setPoint()

int CosmeticVertexPy::staticCallback_setPoint ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setShow()

int CosmeticVertexPy::staticCallback_setShow ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setSize()

int CosmeticVertexPy::staticCallback_setSize ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setStyle()

int CosmeticVertexPy::staticCallback_setStyle ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setTag()

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

Attribute structure of CosmeticVertexPy.

◆ Methods

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

Methods structure of CosmeticVertexPy.

◆ Type


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