The python export class for Document. More...

#include <DocumentPy.h>

Public Types

typedef DocumentPointerType
 
- 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

 DocumentPy (Document *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::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 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 DocumentPy. More...
 
static PyMethodDef Methods []
 Methods structure of DocumentPy. More...
 
static PyTypeObject Type
 Type structure of DocumentPy. 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

 ~DocumentPy ()
 
- 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

PyObjectshow (PyObject *args)
 implementer for the show() method More...
 
PyObjecthide (PyObject *args)
 implementer for the hide() method More...
 
PyObjectsetPos (PyObject *args)
 implementer for the setPos() method More...
 
PyObjectsetEdit (PyObject *args)
 implementer for the setEdit() method More...
 
PyObjectgetInEdit (PyObject *args)
 implementer for the getInEdit() method More...
 
PyObjectresetEdit (PyObject *args)
 implementer for the resetEdit() method More...
 
PyObjectaddAnnotation (PyObject *args)
 implementer for the addAnnotation() method More...
 
PyObjectupdate (PyObject *args)
 implementer for the update() method More...
 
PyObjectgetObject (PyObject *args)
 implementer for the getObject() method More...
 
PyObjectactiveObject (PyObject *args)
 implementer for the activeObject() method More...
 
PyObjectactiveView (PyObject *args)
 implementer for the activeView() method More...
 
PyObjectmdiViewsOfType (PyObject *args)
 implementer for the mdiViewsOfType() method More...
 
PyObjectsendMsgToViews (PyObject *args)
 implementer for the sendMsgToViews() method More...
 
PyObjectmergeProject (PyObject *args)
 implementer for the mergeProject() method More...
 
PyObjecttoggleTreeItem (PyObject *args)
 implementer for the toggleTreeItem() method More...
 
PyObjectscrollToTreeItem (PyObject *args)
 implementer for the scrollToTreeItem() method More...
 
PyObjecttoggleInSceneGraph (PyObject *args)
 implementer for the toggleInSceneGraph() 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_setPos (PyObject *self, PyObject *args)
 callback for the setPos() method More...
 
static PyObjectstaticCallback_setEdit (PyObject *self, PyObject *args)
 callback for the setEdit() method More...
 
static PyObjectstaticCallback_getInEdit (PyObject *self, PyObject *args)
 callback for the getInEdit() method More...
 
static PyObjectstaticCallback_resetEdit (PyObject *self, PyObject *args)
 callback for the resetEdit() method More...
 
static PyObjectstaticCallback_addAnnotation (PyObject *self, PyObject *args)
 callback for the addAnnotation() method More...
 
static PyObjectstaticCallback_update (PyObject *self, PyObject *args)
 callback for the update() method More...
 
static PyObjectstaticCallback_getObject (PyObject *self, PyObject *args)
 callback for the getObject() method More...
 
static PyObjectstaticCallback_activeObject (PyObject *self, PyObject *args)
 callback for the activeObject() method More...
 
static PyObjectstaticCallback_activeView (PyObject *self, PyObject *args)
 callback for the activeView() method More...
 
static PyObjectstaticCallback_mdiViewsOfType (PyObject *self, PyObject *args)
 callback for the mdiViewsOfType() method More...
 
static PyObjectstaticCallback_sendMsgToViews (PyObject *self, PyObject *args)
 callback for the sendMsgToViews() method More...
 
static PyObjectstaticCallback_mergeProject (PyObject *self, PyObject *args)
 callback for the mergeProject() method More...
 
static PyObjectstaticCallback_toggleTreeItem (PyObject *self, PyObject *args)
 callback for the toggleTreeItem() method More...
 
static PyObjectstaticCallback_scrollToTreeItem (PyObject *self, PyObject *args)
 callback for the scrollToTreeItem() method More...
 
static PyObjectstaticCallback_toggleInSceneGraph (PyObject *self, PyObject *args)
 callback for the toggleInSceneGraph() method More...
 

callbacks and implementers for the python object attributes

Py::Object getActiveObject (void) const
 getter for the ActiveObject attribute More...
 
void setActiveObject (Py::Object arg)
 setter for the ActiveObject attribute More...
 
Py::Object getActiveView (void) const
 getter for the ActiveView attribute More...
 
void setActiveView (Py::Object arg)
 setter for the ActiveView attribute More...
 
Py::Object getEditingTransform (void) const
 getter for the EditingTransform attribute More...
 
void setEditingTransform (Py::Object arg)
 setter for the EditingTransform attribute More...
 
Py::Object getInEditInfo (void) const
 getter for the InEditInfo attribute More...
 
void setInEditInfo (Py::Object arg)
 setter for the InEditInfo attribute More...
 
Py::Int getEditMode (void) const
 getter for the EditMode attribute More...
 
Py::Object getDocument (void) const
 getter for the Document attribute More...
 
Py::Boolean getTransacting (void) const
 getter for the Transacting attribute More...
 
Py::Boolean getModified (void) const
 getter for the Modified 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...
 
DocumentgetDocumentPtr (void) const
 getter for the object handled by this class More...
 
static PyObjectstaticCallback_getActiveObject (PyObject *self, void *closure)
 getter callback for the ActiveObject attribute More...
 
static int staticCallback_setActiveObject (PyObject *self, PyObject *value, void *closure)
 setter callback for the ActiveObject attribute More...
 
static PyObjectstaticCallback_getActiveView (PyObject *self, void *closure)
 getter callback for the ActiveView attribute More...
 
static int staticCallback_setActiveView (PyObject *self, PyObject *value, void *closure)
 setter callback for the ActiveView attribute More...
 
static PyObjectstaticCallback_getEditingTransform (PyObject *self, void *closure)
 getter callback for the EditingTransform attribute More...
 
static int staticCallback_setEditingTransform (PyObject *self, PyObject *value, void *closure)
 setter callback for the EditingTransform attribute More...
 
static PyObjectstaticCallback_getInEditInfo (PyObject *self, void *closure)
 getter callback for the InEditInfo attribute More...
 
static int staticCallback_setInEditInfo (PyObject *self, PyObject *value, void *closure)
 setter callback for the InEditInfo attribute More...
 
static PyObjectstaticCallback_getEditMode (PyObject *self, void *closure)
 getter callback for the EditMode attribute More...
 
static int staticCallback_setEditMode (PyObject *self, PyObject *value, void *closure)
 setter callback for the EditMode 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...
 
static PyObjectstaticCallback_getTransacting (PyObject *self, void *closure)
 getter callback for the Transacting attribute More...
 
static int staticCallback_setTransacting (PyObject *self, PyObject *value, void *closure)
 setter callback for the Transacting attribute More...
 
static PyObjectstaticCallback_getModified (PyObject *self, void *closure)
 getter callback for the Modified attribute More...
 
static int staticCallback_setModified (PyObject *self, PyObject *value, void *closure)
 setter callback for the Modified attribute More...
 

Additional Inherited Members

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

Detailed Description

The python export class for Document.

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~DocumentPy()

DocumentPy::~DocumentPy ( )
protected

◆ DocumentPy()

DocumentPy::DocumentPy ( Document pcObject,
PyTypeObject *  T = &Type 
)

Member Function Documentation

◆ activeObject()

◆ activeView()

PyObject * DocumentPy::activeView ( PyObject args)

◆ addAnnotation()

◆ getActiveObject()

Py::Object DocumentPy::getActiveObject ( void  ) const

◆ getActiveView()

Py::Object DocumentPy::getActiveView ( void  ) const

getter for the ActiveView attribute

References Gui::Document::getActiveView(), and getDocumentPtr().

Referenced by staticCallback_getActiveView().

◆ getCustomAttributes()

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

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

References getDocumentPtr(), and Gui::Document::getViewProviderByName().

◆ getDocument()

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

getter for the Document attribute

References Gui::Document::getDocument(), and getDocumentPtr().

Referenced by addAnnotation(), and staticCallback_getDocument().

◆ getDocumentPtr()

◆ getEditingTransform()

Py::Object DocumentPy::getEditingTransform ( void  ) const

getter for the EditingTransform attribute

References getDocumentPtr().

Referenced by staticCallback_getEditingTransform().

◆ getEditMode()

Py::Int DocumentPy::getEditMode ( void  ) const

getter for the EditMode attribute

References getDocumentPtr(), and Gui::Document::getInEdit().

Referenced by staticCallback_getEditMode().

◆ getInEdit()

PyObject * DocumentPy::getInEdit ( PyObject args)

◆ getInEditInfo()

Py::Object DocumentPy::getInEditInfo ( void  ) const

◆ getModified()

Py::Boolean DocumentPy::getModified ( void  ) const

getter for the Modified attribute

References getDocumentPtr().

Referenced by staticCallback_getModified().

◆ getObject()

PyObject * DocumentPy::getObject ( PyObject args)

◆ getTransacting()

Py::Boolean DocumentPy::getTransacting ( void  ) const

getter for the Transacting attribute

References getDocumentPtr().

Referenced by staticCallback_getTransacting().

◆ GetType()

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

Reimplemented from Base::PersistencePy.

◆ hide()

◆ mdiViewsOfType()

◆ mergeProject()

PyObject * DocumentPy::mergeProject ( PyObject args)

◆ PyInit()

int DocumentPy::PyInit ( PyObject ,
PyObject  
)
virtual

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

Reimplemented from Base::PersistencePy.

◆ PyMake()

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

◆ representation()

◆ resetEdit()

PyObject * DocumentPy::resetEdit ( PyObject args)

implementer for the resetEdit() method

References getDocumentPtr(), and Gui::Document::resetEdit().

Referenced by staticCallback_resetEdit().

◆ scrollToTreeItem()

PyObject * DocumentPy::scrollToTreeItem ( PyObject args)

◆ sendMsgToViews()

PyObject * DocumentPy::sendMsgToViews ( PyObject args)

implementer for the sendMsgToViews() method

References getDocumentPtr(), and Gui::Document::sendMsgToViews().

Referenced by staticCallback_sendMsgToViews().

◆ setActiveObject()

void DocumentPy::setActiveObject ( Py::Object  arg)

setter for the ActiveObject attribute

Referenced by staticCallback_setActiveObject().

◆ setActiveView()

void DocumentPy::setActiveView ( Py::Object  arg)

setter for the ActiveView attribute

Referenced by staticCallback_setActiveView().

◆ setCustomAttributes()

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

setter for special attributes (e.g.

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

References getDocumentPtr(), and Gui::Document::getViewProviderByName().

◆ setEdit()

◆ setEditingTransform()

void DocumentPy::setEditingTransform ( Py::Object  arg)

◆ setInEditInfo()

void DocumentPy::setInEditInfo ( Py::Object  arg)

setter for the InEditInfo attribute

References getDocumentPtr(), Gui::Document::setInEdit(), and Gui::ViewProviderDocumentObjectPy::Type.

Referenced by staticCallback_setInEditInfo().

◆ setPos()

PyObject * DocumentPy::setPos ( PyObject args)

implementer for the setPos() method

References getDocumentPtr(), Gui::Document::setPos(), and Base::MatrixPy::Type.

Referenced by staticCallback_setPos().

◆ show()

◆ staticCallback_activeObject()

◆ staticCallback_activeView()

◆ staticCallback_addAnnotation()

◆ staticCallback_getActiveObject()

PyObject * DocumentPy::staticCallback_getActiveObject ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getActiveView()

PyObject * DocumentPy::staticCallback_getActiveView ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getDocument()

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

◆ staticCallback_getEditingTransform()

PyObject * DocumentPy::staticCallback_getEditingTransform ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getEditMode()

PyObject * DocumentPy::staticCallback_getEditMode ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getInEdit()

◆ staticCallback_getInEditInfo()

PyObject * DocumentPy::staticCallback_getInEditInfo ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getModified()

PyObject * DocumentPy::staticCallback_getModified ( PyObject self,
void *  closure 
)
static

◆ staticCallback_getObject()

◆ staticCallback_getTransacting()

PyObject * DocumentPy::staticCallback_getTransacting ( PyObject self,
void *  closure 
)
static

◆ staticCallback_hide()

◆ staticCallback_mdiViewsOfType()

PyObject * DocumentPy::staticCallback_mdiViewsOfType ( PyObject self,
PyObject args 
)
static

◆ staticCallback_mergeProject()

◆ staticCallback_resetEdit()

◆ staticCallback_scrollToTreeItem()

◆ staticCallback_sendMsgToViews()

◆ staticCallback_setActiveObject()

int DocumentPy::staticCallback_setActiveObject ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setActiveView()

int DocumentPy::staticCallback_setActiveView ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setDocument()

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

setter callback for the Document attribute

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

◆ staticCallback_setEdit()

◆ staticCallback_setEditingTransform()

int DocumentPy::staticCallback_setEditingTransform ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setEditMode()

int DocumentPy::staticCallback_setEditMode ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the EditMode attribute

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

◆ staticCallback_setInEditInfo()

int DocumentPy::staticCallback_setInEditInfo ( PyObject self,
PyObject value,
void *  closure 
)
static

◆ staticCallback_setModified()

int DocumentPy::staticCallback_setModified ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Modified attribute

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

◆ staticCallback_setPos()

◆ staticCallback_setTransacting()

int DocumentPy::staticCallback_setTransacting ( PyObject self,
PyObject value,
void *  closure 
)
static

setter callback for the Transacting attribute

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

◆ staticCallback_show()

◆ staticCallback_toggleInSceneGraph()

◆ staticCallback_toggleTreeItem()

◆ staticCallback_update()

◆ toggleInSceneGraph()

PyObject * DocumentPy::toggleInSceneGraph ( PyObject args)

◆ toggleTreeItem()

◆ update()

Member Data Documentation

◆ GetterSetter

PyGetSetDef DocumentPy::GetterSetter
static

Attribute structure of DocumentPy.

◆ Methods

PyMethodDef DocumentPy::Methods
static

Methods structure of DocumentPy.

◆ Type


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