The python export class for ViewProviderDocumentObject. More...

#include <ViewProviderDocumentObjectPy.h>

Public Types

typedef ViewProviderDocumentObjectPointerType
 
- Public Types inherited from Gui::ViewProviderPy
typedef ViewProviderPointerType
 
- Public Types inherited from App::ExtensionContainerPy
typedef ExtensionContainerPointerType
 
- Public Types inherited from App::PropertyContainerPy
typedef PropertyContainerPointerType
 
- Public Types inherited from Base::PersistencePy
typedef PersistencePointerType
 
- Public Types inherited from Base::BaseClassPy
typedef BaseClassPointerType
 
- 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)
 
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
 
 ViewProviderDocumentObjectPy (ViewProviderDocumentObject *pcObject, PyTypeObject *T=&Type)
 
- Public Member Functions inherited from Gui::ViewProviderPy
std::string representation (void) const
 
 ViewProviderPy (ViewProvider *pcObject, PyTypeObject *T=&Type)
 
PyObjectaddProperty (PyObject *args)
 implementer for the addProperty() method More...
 
PyObjectremoveProperty (PyObject *args)
 implementer for the removeProperty() method More...
 
PyObjectsupportedProperties (PyObject *args)
 implementer for the supportedProperties() method More...
 
PyObjectshow (PyObject *args)
 implementer for the show() method More...
 
PyObjecthide (PyObject *args)
 implementer for the hide() method More...
 
PyObjectisVisible (PyObject *args)
 implementer for the isVisible() method More...
 
PyObjectcanDragObject (PyObject *args)
 implementer for the canDragObject() method More...
 
PyObjectdragObject (PyObject *args)
 implementer for the dragObject() method More...
 
PyObjectcanDropObject (PyObject *args)
 implementer for the canDropObject() method More...
 
PyObjectdropObject (PyObject *args)
 implementer for the dropObject() method More...
 
PyObjectcanDragAndDropObject (PyObject *args)
 implementer for the canDragAndDropObject() method More...
 
PyObjectreplaceObject (PyObject *args)
 implementer for the replaceObject() method More...
 
PyObjectdoubleClicked (PyObject *args)
 implementer for the doubleClicked() method More...
 
PyObjectaddDisplayMode (PyObject *args)
 implementer for the addDisplayMode() method More...
 
PyObjectlistDisplayModes (PyObject *args)
 implementer for the listDisplayModes() method More...
 
PyObjecttoString (PyObject *args)
 implementer for the toString() method More...
 
PyObjectsetTransformation (PyObject *args)
 implementer for the setTransformation() method More...
 
PyObjectclaimChildren (PyObject *args)
 implementer for the claimChildren() method More...
 
PyObjectpartialRender (PyObject *args)
 implementer for the partialRender() method More...
 
PyObjectgetElementColors (PyObject *args)
 implementer for the getElementColors() method More...
 
PyObjectsetElementColors (PyObject *args)
 implementer for the setElementColors() method More...
 
PyObjectgetElementPicked (PyObject *args)
 implementer for the getElementPicked() method More...
 
PyObjectgetDetailPath (PyObject *args)
 implementer for the getDetailPath() method More...
 
PyObjectsignalChangeIcon (PyObject *args)
 implementer for the signalChangeIcon() method More...
 
PyObjectgetBoundingBox (PyObject *args)
 implementer for the getBoundingBox() method More...
 
Py::Object getAnnotation (void) const
 getter for the Annotation attribute More...
 
void setAnnotation (Py::Object arg)
 setter for the Annotation attribute More...
 
Py::Object getIcon (void) const
 getter for the Icon attribute More...
 
Py::Object getRootNode (void) const
 getter for the RootNode attribute More...
 
void setRootNode (Py::Object arg)
 setter for the RootNode attribute More...
 
Py::Object getSwitchNode (void) const
 getter for the SwitchNode attribute More...
 
void setSwitchNode (Py::Object arg)
 setter for the SwitchNode attribute More...
 
Py::Int getDefaultMode (void) const
 getter for the DefaultMode attribute More...
 
void setDefaultMode (Py::Int arg)
 setter for the DefaultMode attribute More...
 
Py::String getIV (void) const
 getter for the IV attribute More...
 
Py::Boolean getCanRemoveChildrenFromRoot (void) const
 getter for the CanRemoveChildrenFromRoot attribute More...
 
Py::Boolean getLinkVisibility (void) const
 getter for the LinkVisibility attribute More...
 
void setLinkVisibility (Py::Boolean arg)
 setter for the LinkVisibility attribute More...
 
Py::String getDropPrefix (void) const
 getter for the DropPrefix 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...
 
ViewProvidergetViewProviderPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from App::ExtensionContainerPy
 ExtensionContainerPy (ExtensionContainer *pcObject, PyTypeObject *T=&Type)
 
int finalization ()
 
int initialization ()
 
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...
 
ExtensionContainergetExtensionContainerPtr (void) const
 getter for the object handled by this class More...
 
PyObjectaddExtension (PyObject *args)
 implementer for the addExtension() method More...
 
PyObjecthasExtension (PyObject *args)
 implementer for the hasExtension() method More...
 
- Public Member Functions inherited from App::PropertyContainerPy
 PropertyContainerPy (PropertyContainer *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObjectgetPropertyByName (PyObject *args)
 implementer for the getPropertyByName() method More...
 
PyObjectgetPropertyTouchList (PyObject *args)
 implementer for the getPropertyTouchList() method More...
 
PyObjectgetTypeOfProperty (PyObject *args)
 implementer for the getTypeOfProperty() method More...
 
PyObjectgetTypeIdOfProperty (PyObject *args)
 implementer for the getTypeIdOfProperty() method More...
 
PyObjectsetEditorMode (PyObject *args)
 implementer for the setEditorMode() method More...
 
PyObjectgetEditorMode (PyObject *args)
 implementer for the getEditorMode() method More...
 
PyObjectgetGroupOfProperty (PyObject *args)
 implementer for the getGroupOfProperty() method More...
 
PyObjectsetPropertyStatus (PyObject *args)
 implementer for the setPropertyStatus() method More...
 
PyObjectgetPropertyStatus (PyObject *args)
 implementer for the getPropertyStatus() method More...
 
PyObjectgetDocumentationOfProperty (PyObject *args)
 implementer for the getDocumentationOfProperty() method More...
 
PyObjectdumpPropertyContent (PyObject *args, PyObject *kwd)
 implementer for the dumpPropertyContent() method More...
 
PyObjectrestorePropertyContent (PyObject *args)
 implementer for the restorePropertyContent() method More...
 
Py::List getPropertiesList (void) const
 getter for the PropertiesList 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...
 
PropertyContainergetPropertyContainerPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Base::PersistencePy
 PersistencePy (Persistence *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObjectdumpContent (PyObject *args, PyObject *kwd)
 implementer for the dumpContent() method More...
 
PyObjectrestoreContent (PyObject *args)
 implementer for the restoreContent() method More...
 
Py::String getContent (void) const
 getter for the Content attribute More...
 
Py::Int getMemSize (void) const
 getter for the MemSize 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...
 
PersistencegetPersistencePtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Base::BaseClassPy
 BaseClassPy (BaseClass *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObjectisDerivedFrom (PyObject *args)
 implementer for the isDerivedFrom() method More...
 
PyObjectgetAllDerivedFrom (PyObject *args)
 implementer for the getAllDerivedFrom() method More...
 
Py::String getTypeId (void) const
 getter for the TypeId attribute More...
 
Py::String getModule (void) const
 getter for the Module 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...
 
BaseClassgetBaseClassPtr (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 Gui::ViewProviderPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_addProperty (PyObject *self, PyObject *args)
 callback for the addProperty() method More...
 
static PyObjectstaticCallback_removeProperty (PyObject *self, PyObject *args)
 callback for the removeProperty() method More...
 
static PyObjectstaticCallback_supportedProperties (PyObject *self, PyObject *args)
 callback for the supportedProperties() method More...
 
static PyObjectstaticCallback_show (PyObject *self, PyObject *args)
 callback for the show() method More...
 
static PyObjectstaticCallback_hide (PyObject *self, PyObject *args)
 callback for the hide() method More...
 
static PyObjectstaticCallback_isVisible (PyObject *self, PyObject *args)
 callback for the isVisible() method More...
 
static PyObjectstaticCallback_canDragObject (PyObject *self, PyObject *args)
 callback for the canDragObject() method More...
 
static PyObjectstaticCallback_dragObject (PyObject *self, PyObject *args)
 callback for the dragObject() method More...
 
static PyObjectstaticCallback_canDropObject (PyObject *self, PyObject *args)
 callback for the canDropObject() method More...
 
static PyObjectstaticCallback_dropObject (PyObject *self, PyObject *args)
 callback for the dropObject() method More...
 
static PyObjectstaticCallback_canDragAndDropObject (PyObject *self, PyObject *args)
 callback for the canDragAndDropObject() method More...
 
static PyObjectstaticCallback_replaceObject (PyObject *self, PyObject *args)
 callback for the replaceObject() method More...
 
static PyObjectstaticCallback_doubleClicked (PyObject *self, PyObject *args)
 callback for the doubleClicked() method More...
 
static PyObjectstaticCallback_addDisplayMode (PyObject *self, PyObject *args)
 callback for the addDisplayMode() method More...
 
static PyObjectstaticCallback_listDisplayModes (PyObject *self, PyObject *args)
 callback for the listDisplayModes() method More...
 
static PyObjectstaticCallback_toString (PyObject *self, PyObject *args)
 callback for the toString() method More...
 
static PyObjectstaticCallback_setTransformation (PyObject *self, PyObject *args)
 callback for the setTransformation() method More...
 
static PyObjectstaticCallback_claimChildren (PyObject *self, PyObject *args)
 callback for the claimChildren() method More...
 
static PyObjectstaticCallback_partialRender (PyObject *self, PyObject *args)
 callback for the partialRender() method More...
 
static PyObjectstaticCallback_getElementColors (PyObject *self, PyObject *args)
 callback for the getElementColors() method More...
 
static PyObjectstaticCallback_setElementColors (PyObject *self, PyObject *args)
 callback for the setElementColors() method More...
 
static PyObjectstaticCallback_getElementPicked (PyObject *self, PyObject *args)
 callback for the getElementPicked() method More...
 
static PyObjectstaticCallback_getDetailPath (PyObject *self, PyObject *args)
 callback for the getDetailPath() method More...
 
static PyObjectstaticCallback_signalChangeIcon (PyObject *self, PyObject *args)
 callback for the signalChangeIcon() method More...
 
static PyObjectstaticCallback_getBoundingBox (PyObject *self, PyObject *args)
 callback for the getBoundingBox() method More...
 
static PyObjectstaticCallback_getAnnotation (PyObject *self, void *closure)
 getter callback for the Annotation attribute More...
 
static int staticCallback_setAnnotation (PyObject *self, PyObject *value, void *closure)
 setter callback for the Annotation attribute More...
 
static PyObjectstaticCallback_getIcon (PyObject *self, void *closure)
 getter callback for the Icon attribute More...
 
static int staticCallback_setIcon (PyObject *self, PyObject *value, void *closure)
 setter callback for the Icon attribute More...
 
static PyObjectstaticCallback_getRootNode (PyObject *self, void *closure)
 getter callback for the RootNode attribute More...
 
static int staticCallback_setRootNode (PyObject *self, PyObject *value, void *closure)
 setter callback for the RootNode attribute More...
 
static PyObjectstaticCallback_getSwitchNode (PyObject *self, void *closure)
 getter callback for the SwitchNode attribute More...
 
static int staticCallback_setSwitchNode (PyObject *self, PyObject *value, void *closure)
 setter callback for the SwitchNode attribute More...
 
static PyObjectstaticCallback_getDefaultMode (PyObject *self, void *closure)
 getter callback for the DefaultMode attribute More...
 
static int staticCallback_setDefaultMode (PyObject *self, PyObject *value, void *closure)
 setter callback for the DefaultMode attribute More...
 
static PyObjectstaticCallback_getIV (PyObject *self, void *closure)
 getter callback for the IV attribute More...
 
static int staticCallback_setIV (PyObject *self, PyObject *value, void *closure)
 setter callback for the IV attribute More...
 
static PyObjectstaticCallback_getCanRemoveChildrenFromRoot (PyObject *self, void *closure)
 getter callback for the CanRemoveChildrenFromRoot attribute More...
 
static int staticCallback_setCanRemoveChildrenFromRoot (PyObject *self, PyObject *value, void *closure)
 setter callback for the CanRemoveChildrenFromRoot attribute More...
 
static PyObjectstaticCallback_getLinkVisibility (PyObject *self, void *closure)
 getter callback for the LinkVisibility attribute More...
 
static int staticCallback_setLinkVisibility (PyObject *self, PyObject *value, void *closure)
 setter callback for the LinkVisibility attribute More...
 
static PyObjectstaticCallback_getDropPrefix (PyObject *self, void *closure)
 getter callback for the DropPrefix attribute More...
 
static int staticCallback_setDropPrefix (PyObject *self, PyObject *value, void *closure)
 setter callback for the DropPrefix attribute More...
 
- Static Public Member Functions inherited from App::ExtensionContainerPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_addExtension (PyObject *self, PyObject *args)
 callback for the addExtension() method More...
 
static PyObjectstaticCallback_hasExtension (PyObject *self, PyObject *args)
 callback for the hasExtension() method More...
 
- Static Public Member Functions inherited from App::PropertyContainerPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_getPropertyByName (PyObject *self, PyObject *args)
 callback for the getPropertyByName() method More...
 
static PyObjectstaticCallback_getPropertyTouchList (PyObject *self, PyObject *args)
 callback for the getPropertyTouchList() method More...
 
static PyObjectstaticCallback_getTypeOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeOfProperty() method More...
 
static PyObjectstaticCallback_getTypeIdOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeIdOfProperty() method More...
 
static PyObjectstaticCallback_setEditorMode (PyObject *self, PyObject *args)
 callback for the setEditorMode() method More...
 
static PyObjectstaticCallback_getEditorMode (PyObject *self, PyObject *args)
 callback for the getEditorMode() method More...
 
static PyObjectstaticCallback_getGroupOfProperty (PyObject *self, PyObject *args)
 callback for the getGroupOfProperty() method More...
 
static PyObjectstaticCallback_setPropertyStatus (PyObject *self, PyObject *args)
 callback for the setPropertyStatus() method More...
 
static PyObjectstaticCallback_getPropertyStatus (PyObject *self, PyObject *args)
 callback for the getPropertyStatus() method More...
 
static PyObjectstaticCallback_getDocumentationOfProperty (PyObject *self, PyObject *args)
 callback for the getDocumentationOfProperty() method More...
 
static PyObjectstaticCallback_dumpPropertyContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpPropertyContent() method More...
 
static PyObjectstaticCallback_restorePropertyContent (PyObject *self, PyObject *args)
 callback for the restorePropertyContent() method More...
 
static PyObjectstaticCallback_getPropertiesList (PyObject *self, void *closure)
 getter callback for the PropertiesList attribute More...
 
static int staticCallback_setPropertiesList (PyObject *self, PyObject *value, void *closure)
 setter callback for the PropertiesList attribute More...
 
- Static Public Member Functions inherited from Base::PersistencePy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_dumpContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpContent() method More...
 
static PyObjectstaticCallback_restoreContent (PyObject *self, PyObject *args)
 callback for the restoreContent() method More...
 
static PyObjectstaticCallback_getContent (PyObject *self, void *closure)
 getter callback for the Content attribute More...
 
static int staticCallback_setContent (PyObject *self, PyObject *value, void *closure)
 setter callback for the Content attribute More...
 
static PyObjectstaticCallback_getMemSize (PyObject *self, void *closure)
 getter callback for the MemSize attribute More...
 
static int staticCallback_setMemSize (PyObject *self, PyObject *value, void *closure)
 setter callback for the MemSize attribute More...
 
- Static Public Member Functions inherited from Base::BaseClassPy
static PyObjectPyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObjectstaticCallback_isDerivedFrom (PyObject *self, PyObject *args)
 callback for the isDerivedFrom() method More...
 
static PyObjectstaticCallback_getAllDerivedFrom (PyObject *self, PyObject *args)
 callback for the getAllDerivedFrom() method More...
 
static PyObjectstaticCallback_getTypeId (PyObject *self, void *closure)
 getter callback for the TypeId attribute More...
 
static int staticCallback_setTypeId (PyObject *self, PyObject *value, void *closure)
 setter callback for the TypeId attribute More...
 
static PyObjectstaticCallback_getModule (PyObject *self, void *closure)
 getter callback for the Module attribute More...
 
static int staticCallback_setModule (PyObject *self, PyObject *value, void *closure)
 setter callback for the Module attribute More...
 
- 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 ViewProviderDocumentObjectPy. More...
 
static PyMethodDef Methods []
 Methods structure of ViewProviderDocumentObjectPy. More...
 
static PyTypeObject Type
 Type structure of ViewProviderDocumentObjectPy. More...
 
- Static Public Attributes inherited from Gui::ViewProviderPy
static PyGetSetDef GetterSetter []
 Attribute structure of ViewProviderPy. More...
 
static PyMethodDef Methods []
 Methods structure of ViewProviderPy. More...
 
static PyTypeObject Type
 Type structure of ViewProviderPy. More...
 
- Static Public Attributes inherited from App::ExtensionContainerPy
static PyGetSetDef GetterSetter []
 Attribute structure of ExtensionContainerPy. More...
 
static PyMethodDef Methods []
 Methods structure of ExtensionContainerPy. More...
 
static PyTypeObject Type
 Type structure of ExtensionContainerPy. More...
 
- Static Public Attributes inherited from App::PropertyContainerPy
static PyGetSetDef GetterSetter []
 Attribute structure of PropertyContainerPy. More...
 
static PyMethodDef Methods []
 Methods structure of PropertyContainerPy. More...
 
static PyTypeObject Type
 Type structure of PropertyContainerPy. More...
 
- Static Public Attributes inherited from Base::PersistencePy
static PyGetSetDef GetterSetter []
 Attribute structure of PersistencePy. More...
 
static PyMethodDef Methods []
 Methods structure of PersistencePy. More...
 
static PyTypeObject Type
 Type structure of PersistencePy. More...
 
- Static Public Attributes inherited from Base::BaseClassPy
static PyGetSetDef GetterSetter []
 Attribute structure of BaseClassPy. More...
 
static PyMethodDef Methods []
 Methods structure of BaseClassPy. More...
 
static PyTypeObject Type
 Type structure of BaseClassPy. More...
 
- Static Public Attributes inherited from Base::PyObjectBase
static PyMethodDef Methods []
 
static PyTypeObject Type
 Py_Header struct from python.h. More...
 

Protected Member Functions

 ~ViewProviderDocumentObjectPy ()
 
- Protected Member Functions inherited from Gui::ViewProviderPy
 ~ViewProviderPy ()
 
- Protected Member Functions inherited from App::ExtensionContainerPy
 ~ExtensionContainerPy ()
 
- Protected Member Functions inherited from App::PropertyContainerPy
 ~PropertyContainerPy ()
 
- Protected Member Functions inherited from Base::PersistencePy
 ~PersistencePy ()
 
- Protected Member Functions inherited from Base::BaseClassPy
 ~BaseClassPy ()
 
- 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

PyObjectupdate (PyObject *args)
 implementer for the update() method More...
 
static PyObjectstaticCallback_update (PyObject *self, PyObject *args)
 callback for the update() method More...
 

callbacks and implementers for the python object attributes

Py::Object getObject (void) const
 getter for the Object attribute More...
 
void setObject (Py::Object arg)
 setter for the Object attribute More...
 
Py::Boolean getForceUpdate (void) const
 getter for the ForceUpdate attribute More...
 
void setForceUpdate (Py::Boolean arg)
 setter for the ForceUpdate attribute More...
 
Py::Object getDocument (void) const
 getter for the Document 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...
 
ViewProviderDocumentObjectgetViewProviderDocumentObjectPtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_getObject (PyObject *self, void *closure)
 getter callback for the Object attribute More...
 
static int staticCallback_setObject (PyObject *self, PyObject *value, void *closure)
 setter callback for the Object attribute More...
 
static PyObjectstaticCallback_getForceUpdate (PyObject *self, void *closure)
 getter callback for the ForceUpdate attribute More...
 
static int staticCallback_setForceUpdate (PyObject *self, PyObject *value, void *closure)
 setter callback for the ForceUpdate attribute More...
 
static PyObjectstaticCallback_getDocument (PyObject *self, void *closure)
 getter callback for the Document attribute More...
 
static int staticCallback_setDocument (PyObject *self, PyObject *value, void *closure)
 setter callback for the Document attribute More...
 

Additional Inherited Members

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

Detailed Description

The python export class for ViewProviderDocumentObject.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~ViewProviderDocumentObjectPy()

ViewProviderDocumentObjectPy::~ViewProviderDocumentObjectPy ( )
protected

◆ ViewProviderDocumentObjectPy()

ViewProviderDocumentObjectPy::ViewProviderDocumentObjectPy ( ViewProviderDocumentObject pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ getCustomAttributes()

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

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

◆ getDocument()

Py::Object ViewProviderDocumentObjectPy::getDocument ( void  ) const

◆ getForceUpdate()

Py::Boolean ViewProviderDocumentObjectPy::getForceUpdate ( void  ) const

getter for the ForceUpdate attribute

References getViewProviderDocumentObjectPtr().

Referenced by staticCallback_getForceUpdate().

◆ getObject()

Py::Object ViewProviderDocumentObjectPy::getObject ( void  ) const

◆ GetType()

virtual PyTypeObject* Gui::ViewProviderDocumentObjectPy::GetType ( void  )
virtual

◆ getViewProviderDocumentObjectPtr()

ViewProviderDocumentObject * ViewProviderDocumentObjectPy::getViewProviderDocumentObjectPtr ( void  ) const

◆ PyInit()

int ViewProviderDocumentObjectPy::PyInit ( PyObject ,
PyObject  
)
virtual

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

Reimplemented from Gui::ViewProviderPy.

Reimplemented in PartDesignGui::ViewProviderPy, MeshGui::ViewProviderMeshPy, FemGui::ViewProviderFemMeshPy, and Gui::ViewProviderLinkPy.

◆ PyMake()

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

◆ representation()

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

◆ setForceUpdate()

void ViewProviderDocumentObjectPy::setForceUpdate ( Py::Boolean  arg)

◆ setObject()

◆ staticCallback_getDocument()

PyObject * ViewProviderDocumentObjectPy::staticCallback_getDocument ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getForceUpdate()

PyObject * ViewProviderDocumentObjectPy::staticCallback_getForceUpdate ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getObject()

PyObject * ViewProviderDocumentObjectPy::staticCallback_getObject ( PyObject self,
void *  closure 
)
static

◆ staticCallback_setDocument()

int ViewProviderDocumentObjectPy::staticCallback_setDocument ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Document attribute

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

◆ staticCallback_setForceUpdate()

int ViewProviderDocumentObjectPy::staticCallback_setForceUpdate ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setObject()

int ViewProviderDocumentObjectPy::staticCallback_setObject ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_update()

◆ update()

Member Data Documentation

◆ GetterSetter

PyGetSetDef ViewProviderDocumentObjectPy::GetterSetter
static
Initial value:
= {
{"Object",
"Set/Get the associated data object",
NULL
},
{"ForceUpdate",
"Reference count to force update visual",
NULL
},
{"Document",
"Return the document the view provider is part of",
NULL
},
{NULL, NULL, NULL, NULL, NULL}
}
static PyObject * staticCallback_getForceUpdate(PyObject *self, void *closure)
getter callback for the ForceUpdate attribute
Definition: ViewProviderDocumentObjectPy.cpp:240
static int staticCallback_setDocument(PyObject *self, PyObject *value, void *closure)
setter callback for the Document attribute
Definition: ViewProviderDocumentObjectPy.cpp:302
static PyObject * staticCallback_getDocument(PyObject *self, void *closure)
getter callback for the Document attribute
Definition: ViewProviderDocumentObjectPy.cpp:284
static int staticCallback_setForceUpdate(PyObject *self, PyObject *value, void *closure)
setter callback for the ForceUpdate attribute
Definition: ViewProviderDocumentObjectPy.cpp:258
static PyObject * staticCallback_getObject(PyObject *self, void *closure)
getter callback for the Object attribute
Definition: ViewProviderDocumentObjectPy.cpp:196
static int staticCallback_setObject(PyObject *self, PyObject *value, void *closure)
setter callback for the Object attribute
Definition: ViewProviderDocumentObjectPy.cpp:214

Attribute structure of ViewProviderDocumentObjectPy.

◆ Methods

PyMethodDef ViewProviderDocumentObjectPy::Methods
static
Initial value:
= {
{"update",
reinterpret_cast<PyCFunction>( staticCallback_update ),
METH_VARARGS,
"Update the view representation of the object"
},
{NULL, NULL, 0, NULL}
}
static PyObject * staticCallback_update(PyObject *self, PyObject *args)
callback for the update() method
Definition: ViewProviderDocumentObjectPy.cpp:128

Methods structure of ViewProviderDocumentObjectPy.

◆ Type


The documentation for this class was generated from the following files:
  • Sources/FreeCAD-SourceDocs/src/Gui/ViewProviderDocumentObjectPy.h
  • Sources/FreeCAD/src/Gui/ViewProviderDocumentObjectPyImp.cpp
  • Sources/FreeCAD-SourceDocs/src/Gui/ViewProviderDocumentObjectPy.cpp