The python export class for GroupExtension. More...

#include <GroupExtensionPy.h>

Public Types

typedef GroupExtensionPointerType
 
- Public Types inherited from App::DocumentObjectExtensionPy
typedef DocumentObjectExtensionPointerType
 
- Public Types inherited from App::ExtensionPy
typedef ExtensionPointerType
 
- Public Types inherited from Base::PyObjectBase
typedef void * PointerType
 
enum  Status { Valid = 0 , Immutable = 1 , Notify = 2 , NoTrack = 3 }
 

Public Member Functions

virtual PyTypeObject * GetType (void)
 
 GroupExtensionPy (GroupExtension *pcObject, PyTypeObject *T=&Type)
 
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
 
callbacks and implementers for the python object attributes
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...
 
GroupExtensiongetGroupExtensionPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from App::DocumentObjectExtensionPy
 DocumentObjectExtensionPy (DocumentObjectExtension *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
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...
 
DocumentObjectExtensiongetDocumentObjectExtensionPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from App::ExtensionPy
 ExtensionPy (Extension *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
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...
 
ExtensiongetExtensionPtr (void) const
 getter for the object handled by this class More...
 
- 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 App::DocumentObjectExtensionPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from App::ExtensionPy
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 GroupExtensionPy. More...
 
static PyMethodDef Methods []
 Methods structure of GroupExtensionPy. More...
 
static PyTypeObject Type
 Type structure of GroupExtensionPy. More...
 
- Static Public Attributes inherited from App::DocumentObjectExtensionPy
static PyGetSetDef GetterSetter []
 Attribute structure of DocumentObjectExtensionPy. More...
 
static PyMethodDef Methods []
 Methods structure of DocumentObjectExtensionPy. More...
 
static PyTypeObject Type
 Type structure of DocumentObjectExtensionPy. More...
 
- Static Public Attributes inherited from App::ExtensionPy
static PyGetSetDef GetterSetter []
 Attribute structure of ExtensionPy. More...
 
static PyMethodDef Methods []
 Methods structure of ExtensionPy. More...
 
static PyTypeObject Type
 Type structure of ExtensionPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~GroupExtensionPy ()
 
- Protected Member Functions inherited from App::DocumentObjectExtensionPy
 ~DocumentObjectExtensionPy ()
 
- Protected Member Functions inherited from App::ExtensionPy
 ~ExtensionPy ()
 
- 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

PyObjectnewObject (PyObject *args)
 implementer for the newObject() method More...
 
PyObjectaddObject (PyObject *args)
 implementer for the addObject() method More...
 
PyObjectaddObjects (PyObject *args)
 implementer for the addObjects() method More...
 
PyObjectsetObjects (PyObject *args)
 implementer for the setObjects() method More...
 
PyObjectremoveObject (PyObject *args)
 implementer for the removeObject() method More...
 
PyObjectremoveObjects (PyObject *args)
 implementer for the removeObjects() method More...
 
PyObjectremoveObjectsFromDocument (PyObject *args)
 implementer for the removeObjectsFromDocument() method More...
 
PyObjectgetObject (PyObject *args)
 implementer for the getObject() method More...
 
PyObjecthasObject (PyObject *args)
 implementer for the hasObject() method More...
 
static PyObjectstaticCallback_newObject (PyObject *self, PyObject *args)
 callback for the newObject() method More...
 
static PyObjectstaticCallback_addObject (PyObject *self, PyObject *args)
 callback for the addObject() method More...
 
static PyObjectstaticCallback_addObjects (PyObject *self, PyObject *args)
 callback for the addObjects() method More...
 
static PyObjectstaticCallback_setObjects (PyObject *self, PyObject *args)
 callback for the setObjects() method More...
 
static PyObjectstaticCallback_removeObject (PyObject *self, PyObject *args)
 callback for the removeObject() method More...
 
static PyObjectstaticCallback_removeObjects (PyObject *self, PyObject *args)
 callback for the removeObjects() method More...
 
static PyObjectstaticCallback_removeObjectsFromDocument (PyObject *self, PyObject *args)
 callback for the removeObjectsFromDocument() method More...
 
static PyObjectstaticCallback_getObject (PyObject *self, PyObject *args)
 callback for the getObject() method More...
 
static PyObjectstaticCallback_hasObject (PyObject *self, PyObject *args)
 callback for the hasObject() method More...
 

Additional Inherited Members

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

Detailed Description

The python export class for GroupExtension.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~GroupExtensionPy()

GroupExtensionPy::~GroupExtensionPy ( )
protected

◆ GroupExtensionPy()

GroupExtensionPy::GroupExtensionPy ( GroupExtension pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ addObject()

◆ addObjects()

◆ getCustomAttributes()

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

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

◆ getGroupExtensionPtr()

GroupExtension * GroupExtensionPy::getGroupExtensionPtr ( void  ) const

◆ getObject()

PyObject * GroupExtensionPy::getObject ( PyObject args)

◆ GetType()

virtual PyTypeObject* App::GroupExtensionPy::GetType ( void  )
virtual

◆ hasObject()

◆ newObject()

◆ PyInit()

int GroupExtensionPy::PyInit ( PyObject ,
PyObject  
)
virtual

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

Reimplemented from App::DocumentObjectExtensionPy.

Reimplemented in App::OriginGroupExtensionPy, and App::GeoFeatureGroupExtensionPy.

◆ PyMake()

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

◆ removeObject()

◆ removeObjects()

◆ removeObjectsFromDocument()

PyObject * GroupExtensionPy::removeObjectsFromDocument ( PyObject args)

◆ representation()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setObjects()

◆ staticCallback_addObject()

◆ staticCallback_addObjects()

◆ staticCallback_getObject()

◆ staticCallback_hasObject()

◆ staticCallback_newObject()

◆ staticCallback_removeObject()

◆ staticCallback_removeObjects()

◆ staticCallback_removeObjectsFromDocument()

◆ staticCallback_setObjects()

Member Data Documentation

◆ GetterSetter

PyGetSetDef GroupExtensionPy::GetterSetter
static
Initial value:
= {
{NULL, NULL, NULL, NULL, NULL}
}

Attribute structure of GroupExtensionPy.

◆ Methods

PyMethodDef GroupExtensionPy::Methods
static

Methods structure of GroupExtensionPy.

◆ Type


The documentation for this class was generated from the following files:
  • Sources/FreeCAD-SourceDocs/src/App/GroupExtensionPy.h
  • Sources/FreeCAD/src/App/GroupExtensionPyImp.cpp
  • Sources/FreeCAD-SourceDocs/src/App/GroupExtensionPy.cpp