The python export class for Document. More...

#include <DocumentPy.h>

Public Types

typedef Document * PointerType
 
- Public Types inherited from App::PropertyContainerPy
typedef PropertyContainer * PointerType
 
- Public Types inherited from Base::PersistencePy
typedef Persistence * PointerType
 
- Public Types inherited from Base::BaseClassPy
typedef BaseClass * PointerType
 
- 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 App::PropertyContainerPy
 PropertyContainerPy (PropertyContainer *pcObject, PyTypeObject *T=&Type)
 
std::string representation (void) const
 
PyObject * getPropertyByName (PyObject *args)
 implementer for the getPropertyByName() method More...
 
PyObject * getTypeOfProperty (PyObject *args)
 implementer for the getTypeOfProperty() method More...
 
PyObject * getTypeIdOfProperty (PyObject *args)
 implementer for the getTypeIdOfProperty() method More...
 
PyObject * setEditorMode (PyObject *args)
 implementer for the setEditorMode() method More...
 
PyObject * getEditorMode (PyObject *args)
 implementer for the getEditorMode() method More...
 
PyObject * getGroupOfProperty (PyObject *args)
 implementer for the getGroupOfProperty() method More...
 
PyObject * getDocumentationOfProperty (PyObject *args)
 implementer for the getDocumentationOfProperty() method More...
 
PyObject * dumpPropertyContent (PyObject *args, PyObject *kwd)
 implementer for the dumpPropertyContent() method More...
 
PyObject * restorePropertyContent (PyObject *args)
 implementer for the restorePropertyContent() method More...
 
Py::List getPropertiesList (void) const
 getter for the PropertiesList attribute More...
 
PyObject * getCustomAttributes (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...
 
PropertyContainer * getPropertyContainerPtr (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
 
PyObject * dumpContent (PyObject *args, PyObject *kwd)
 implementer for the dumpContent() method More...
 
PyObject * restoreContent (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...
 
PyObject * getCustomAttributes (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...
 
Persistence * getPersistencePtr (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
 
PyObject * isDerivedFrom (PyObject *args)
 implementer for the isDerivedFrom() method More...
 
PyObject * getAllDerivedFrom (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...
 
PyObject * getCustomAttributes (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...
 
BaseClass * getBaseClassPtr (void) const
 getter for the object handled by this class More...
 
- Public Member Functions inherited from Base::PyObjectBase
PyObjectBase * DecRef (void)
 decref method wrapper (see python extending manual)
More...
 
PyObjectBase * IncRef (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 PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
- Static Public Member Functions inherited from App::PropertyContainerPy
static PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_getPropertyByName (PyObject *self, PyObject *args)
 callback for the getPropertyByName() method More...
 
static PyObject * staticCallback_getTypeOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeOfProperty() method More...
 
static PyObject * staticCallback_getTypeIdOfProperty (PyObject *self, PyObject *args)
 callback for the getTypeIdOfProperty() method More...
 
static PyObject * staticCallback_setEditorMode (PyObject *self, PyObject *args)
 callback for the setEditorMode() method More...
 
static PyObject * staticCallback_getEditorMode (PyObject *self, PyObject *args)
 callback for the getEditorMode() method More...
 
static PyObject * staticCallback_getGroupOfProperty (PyObject *self, PyObject *args)
 callback for the getGroupOfProperty() method More...
 
static PyObject * staticCallback_getDocumentationOfProperty (PyObject *self, PyObject *args)
 callback for the getDocumentationOfProperty() method More...
 
static PyObject * staticCallback_dumpPropertyContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpPropertyContent() method More...
 
static PyObject * staticCallback_restorePropertyContent (PyObject *self, PyObject *args)
 callback for the restorePropertyContent() method More...
 
static PyObject * staticCallback_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 PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_dumpContent (PyObject *self, PyObject *args, PyObject *kwd)
 callback for the dumpContent() method More...
 
static PyObject * staticCallback_restoreContent (PyObject *self, PyObject *args)
 callback for the restoreContent() method More...
 
static PyObject * staticCallback_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 PyObject * staticCallback_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 PyObject * PyMake (struct _typeobject *, PyObject *, PyObject *)
 
static PyObject * staticCallback_isDerivedFrom (PyObject *self, PyObject *args)
 callback for the isDerivedFrom() method More...
 
static PyObject * staticCallback_getAllDerivedFrom (PyObject *self, PyObject *args)
 callback for the getAllDerivedFrom() method More...
 
static PyObject * staticCallback_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 PyObject * staticCallback_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 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

 ~DocumentPy ()
 
- 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
virtual ~PyObjectBase ()
 destructor More...
 

callbacks and implementers for the python object methods

PyObject * save (PyObject *args)
 implementer for the save() method More...
 
PyObject * saveAs (PyObject *args)
 implementer for the saveAs() method More...
 
PyObject * saveCopy (PyObject *args)
 implementer for the saveCopy() method More...
 
PyObject * load (PyObject *args)
 implementer for the load() method More...
 
PyObject * restore (PyObject *args)
 implementer for the restore() method More...
 
PyObject * mergeProject (PyObject *args)
 implementer for the mergeProject() method More...
 
PyObject * exportGraphviz (PyObject *args)
 implementer for the exportGraphviz() method More...
 
PyObject * openTransaction (PyObject *args)
 implementer for the openTransaction() method More...
 
PyObject * abortTransaction (PyObject *args)
 implementer for the abortTransaction() method More...
 
PyObject * commitTransaction (PyObject *args)
 implementer for the commitTransaction() method More...
 
PyObject * addObject (PyObject *args)
 implementer for the addObject() method More...
 
PyObject * removeObject (PyObject *args)
 implementer for the removeObject() method More...
 
PyObject * copyObject (PyObject *args)
 implementer for the copyObject() method More...
 
PyObject * moveObject (PyObject *args)
 implementer for the moveObject() method More...
 
PyObject * undo (PyObject *args)
 implementer for the undo() method More...
 
PyObject * redo (PyObject *args)
 implementer for the redo() method More...
 
PyObject * clearUndos (PyObject *args)
 implementer for the clearUndos() method More...
 
PyObject * recompute (PyObject *args)
 implementer for the recompute() method More...
 
PyObject * getObject (PyObject *args)
 implementer for the getObject() method More...
 
PyObject * getObjectsByLabel (PyObject *args)
 implementer for the getObjectsByLabel() method More...
 
PyObject * findObjects (PyObject *args)
 implementer for the findObjects() method More...
 
PyObject * supportedTypes (PyObject *args)
 implementer for the supportedTypes() method More...
 
PyObject * getTempFileName (PyObject *args)
 implementer for the getTempFileName() method More...
 
static PyObject * staticCallback_save (PyObject *self, PyObject *args)
 callback for the save() method More...
 
static PyObject * staticCallback_saveAs (PyObject *self, PyObject *args)
 callback for the saveAs() method More...
 
static PyObject * staticCallback_saveCopy (PyObject *self, PyObject *args)
 callback for the saveCopy() method More...
 
static PyObject * staticCallback_load (PyObject *self, PyObject *args)
 callback for the load() method More...
 
static PyObject * staticCallback_restore (PyObject *self, PyObject *args)
 callback for the restore() method More...
 
static PyObject * staticCallback_mergeProject (PyObject *self, PyObject *args)
 callback for the mergeProject() method More...
 
static PyObject * staticCallback_exportGraphviz (PyObject *self, PyObject *args)
 callback for the exportGraphviz() method More...
 
static PyObject * staticCallback_openTransaction (PyObject *self, PyObject *args)
 callback for the openTransaction() method More...
 
static PyObject * staticCallback_abortTransaction (PyObject *self, PyObject *args)
 callback for the abortTransaction() method More...
 
static PyObject * staticCallback_commitTransaction (PyObject *self, PyObject *args)
 callback for the commitTransaction() method More...
 
static PyObject * staticCallback_addObject (PyObject *self, PyObject *args)
 callback for the addObject() method More...
 
static PyObject * staticCallback_removeObject (PyObject *self, PyObject *args)
 callback for the removeObject() method More...
 
static PyObject * staticCallback_copyObject (PyObject *self, PyObject *args)
 callback for the copyObject() method More...
 
static PyObject * staticCallback_moveObject (PyObject *self, PyObject *args)
 callback for the moveObject() method More...
 
static PyObject * staticCallback_undo (PyObject *self, PyObject *args)
 callback for the undo() method More...
 
static PyObject * staticCallback_redo (PyObject *self, PyObject *args)
 callback for the redo() method More...
 
static PyObject * staticCallback_clearUndos (PyObject *self, PyObject *args)
 callback for the clearUndos() method More...
 
static PyObject * staticCallback_recompute (PyObject *self, PyObject *args)
 callback for the recompute() method More...
 
static PyObject * staticCallback_getObject (PyObject *self, PyObject *args)
 callback for the getObject() method More...
 
static PyObject * staticCallback_getObjectsByLabel (PyObject *self, PyObject *args)
 callback for the getObjectsByLabel() method More...
 
static PyObject * staticCallback_findObjects (PyObject *self, PyObject *args)
 callback for the findObjects() method More...
 
static PyObject * staticCallback_supportedTypes (PyObject *self, PyObject *args)
 callback for the supportedTypes() method More...
 
static PyObject * staticCallback_getTempFileName (PyObject *self, PyObject *args)
 callback for the getTempFileName() method More...
 

callbacks and implementers for the python object attributes

Py::String getDependencyGraph (void) const
 getter for the DependencyGraph attribute More...
 
Py::Object getActiveObject (void) const
 getter for the ActiveObject attribute More...
 
Py::List getObjects (void) const
 getter for the Objects attribute More...
 
Py::List getTopologicalSortedObjects (void) const
 getter for the TopologicalSortedObjects attribute More...
 
Py::List getRootObjects (void) const
 getter for the RootObjects attribute More...
 
Py::Int getUndoMode (void) const
 getter for the UndoMode attribute More...
 
void setUndoMode (Py::Int arg)
 setter for the UndoMode attribute More...
 
Py::Int getUndoRedoMemSize (void) const
 getter for the UndoRedoMemSize attribute More...
 
Py::Int getUndoCount (void) const
 getter for the UndoCount attribute More...
 
Py::Int getRedoCount (void) const
 getter for the RedoCount attribute More...
 
Py::List getUndoNames (void) const
 getter for the UndoNames attribute More...
 
Py::List getRedoNames (void) const
 getter for the RedoNames attribute More...
 
Py::String getName (void) const
 getter for the Name attribute More...
 
Py::Boolean getRecomputesFrozen (void) const
 getter for the RecomputesFrozen attribute More...
 
void setRecomputesFrozen (Py::Boolean arg)
 setter for the RecomputesFrozen attribute More...
 
PyObject * getCustomAttributes (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...
 
Document * getDocumentPtr (void) const
 getter for the object handled by this class More...
 
static PyObject * staticCallback_getDependencyGraph (PyObject *self, void *closure)
 getter callback for the DependencyGraph attribute More...
 
static int staticCallback_setDependencyGraph (PyObject *self, PyObject *value, void *closure)
 setter callback for the DependencyGraph attribute More...
 
static PyObject * staticCallback_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 PyObject * staticCallback_getObjects (PyObject *self, void *closure)
 getter callback for the Objects attribute More...
 
static int staticCallback_setObjects (PyObject *self, PyObject *value, void *closure)
 setter callback for the Objects attribute More...
 
static PyObject * staticCallback_getTopologicalSortedObjects (PyObject *self, void *closure)
 getter callback for the TopologicalSortedObjects attribute More...
 
static int staticCallback_setTopologicalSortedObjects (PyObject *self, PyObject *value, void *closure)
 setter callback for the TopologicalSortedObjects attribute More...
 
static PyObject * staticCallback_getRootObjects (PyObject *self, void *closure)
 getter callback for the RootObjects attribute More...
 
static int staticCallback_setRootObjects (PyObject *self, PyObject *value, void *closure)
 setter callback for the RootObjects attribute More...
 
static PyObject * staticCallback_getUndoMode (PyObject *self, void *closure)
 getter callback for the UndoMode attribute More...
 
static int staticCallback_setUndoMode (PyObject *self, PyObject *value, void *closure)
 setter callback for the UndoMode attribute More...
 
static PyObject * staticCallback_getUndoRedoMemSize (PyObject *self, void *closure)
 getter callback for the UndoRedoMemSize attribute More...
 
static int staticCallback_setUndoRedoMemSize (PyObject *self, PyObject *value, void *closure)
 setter callback for the UndoRedoMemSize attribute More...
 
static PyObject * staticCallback_getUndoCount (PyObject *self, void *closure)
 getter callback for the UndoCount attribute More...
 
static int staticCallback_setUndoCount (PyObject *self, PyObject *value, void *closure)
 setter callback for the UndoCount attribute More...
 
static PyObject * staticCallback_getRedoCount (PyObject *self, void *closure)
 getter callback for the RedoCount attribute More...
 
static int staticCallback_setRedoCount (PyObject *self, PyObject *value, void *closure)
 setter callback for the RedoCount attribute More...
 
static PyObject * staticCallback_getUndoNames (PyObject *self, void *closure)
 getter callback for the UndoNames attribute More...
 
static int staticCallback_setUndoNames (PyObject *self, PyObject *value, void *closure)
 setter callback for the UndoNames attribute More...
 
static PyObject * staticCallback_getRedoNames (PyObject *self, void *closure)
 getter callback for the RedoNames attribute More...
 
static int staticCallback_setRedoNames (PyObject *self, PyObject *value, void *closure)
 setter callback for the RedoNames attribute More...
 
static PyObject * staticCallback_getName (PyObject *self, void *closure)
 getter callback for the Name attribute More...
 
static int staticCallback_setName (PyObject *self, PyObject *value, void *closure)
 setter callback for the Name attribute More...
 
static PyObject * staticCallback_getRecomputesFrozen (PyObject *self, void *closure)
 getter callback for the RecomputesFrozen attribute More...
 
static int staticCallback_setRecomputesFrozen (PyObject *self, PyObject *value, void *closure)
 setter callback for the RecomputesFrozen 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

◆ abortTransaction()

PyObject * DocumentPy::abortTransaction ( PyObject *  args)

◆ addObject()

◆ clearUndos()

PyObject * DocumentPy::clearUndos ( PyObject *  args)

implementer for the clearUndos() method

References App::Document::clearUndos(), and getDocumentPtr().

Referenced by staticCallback_clearUndos().

◆ commitTransaction()

PyObject * DocumentPy::commitTransaction ( PyObject *  args)

◆ copyObject()

PyObject * DocumentPy::copyObject ( PyObject *  args)

◆ exportGraphviz()

PyObject * DocumentPy::exportGraphviz ( PyObject *  args)

implementer for the exportGraphviz() method

References App::Document::exportGraphviz(), and getDocumentPtr().

Referenced by staticCallback_exportGraphviz().

◆ findObjects()

◆ getActiveObject()

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

getter for the ActiveObject attribute

References App::Document::getActiveObject(), getDocumentPtr(), and App::DocumentObject::getPyObject().

Referenced by staticCallback_getActiveObject().

◆ getCustomAttributes()

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

◆ getDependencyGraph()

Py::String DocumentPy::getDependencyGraph ( void  ) const

getter for the DependencyGraph attribute

References App::Document::exportGraphviz(), and getDocumentPtr().

Referenced by staticCallback_getDependencyGraph().

◆ getDocumentPtr()

◆ getName()

Py::String DocumentPy::getName ( void  ) const

getter for the Name attribute

References getDocumentPtr().

Referenced by staticCallback_getName().

◆ getObject()

PyObject * DocumentPy::getObject ( PyObject *  args)

◆ getObjects()

Py::List DocumentPy::getObjects ( void  ) const

getter for the Objects attribute

References getDocumentPtr(), and App::Document::getObjects().

Referenced by staticCallback_getObjects().

◆ getObjectsByLabel()

PyObject * DocumentPy::getObjectsByLabel ( PyObject *  args)

implementer for the getObjectsByLabel() method

References getDocumentPtr(), and App::Document::getObjects().

Referenced by staticCallback_getObjectsByLabel().

◆ getRecomputesFrozen()

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

getter for the RecomputesFrozen attribute

References getDocumentPtr().

Referenced by staticCallback_getRecomputesFrozen().

◆ getRedoCount()

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

getter for the RedoCount attribute

References getDocumentPtr().

Referenced by staticCallback_getRedoCount().

◆ getRedoNames()

Py::List DocumentPy::getRedoNames ( void  ) const

getter for the RedoNames attribute

References App::Document::getAvailableRedoNames(), and getDocumentPtr().

Referenced by staticCallback_getRedoNames().

◆ getRootObjects()

Py::List DocumentPy::getRootObjects ( void  ) const

getter for the RootObjects attribute

References getDocumentPtr(), and App::Document::getRootObjects().

Referenced by staticCallback_getRootObjects().

◆ getTempFileName()

PyObject * DocumentPy::getTempFileName ( PyObject *  args)

◆ getTopologicalSortedObjects()

Py::List DocumentPy::getTopologicalSortedObjects ( void  ) const

getter for the TopologicalSortedObjects attribute

References getDocumentPtr(), and App::Document::topologicalSort().

Referenced by staticCallback_getTopologicalSortedObjects().

◆ GetType()

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

Reimplemented from App::PropertyContainerPy.

◆ getUndoCount()

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

getter for the UndoCount attribute

References getDocumentPtr().

Referenced by staticCallback_getUndoCount().

◆ getUndoMode()

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

getter for the UndoMode attribute

References getDocumentPtr().

Referenced by staticCallback_getUndoMode().

◆ getUndoNames()

Py::List DocumentPy::getUndoNames ( void  ) const

getter for the UndoNames attribute

References App::Document::getAvailableUndoNames(), and getDocumentPtr().

Referenced by staticCallback_getUndoNames().

◆ getUndoRedoMemSize()

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

getter for the UndoRedoMemSize attribute

References getDocumentPtr().

Referenced by staticCallback_getUndoRedoMemSize().

◆ load()

◆ mergeProject()

PyObject * DocumentPy::mergeProject ( PyObject *  args)

implementer for the mergeProject() method

References getDocumentPtr(), and App::MergeDocuments::importObjects().

Referenced by staticCallback_mergeProject().

◆ moveObject()

◆ openTransaction()

PyObject * DocumentPy::openTransaction ( 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 App::PropertyContainerPy.

◆ PyMake()

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

◆ recompute()

◆ redo()

PyObject * DocumentPy::redo ( PyObject *  args)

implementer for the redo() method

References getDocumentPtr(), and App::Document::redo().

Referenced by staticCallback_redo().

◆ removeObject()

PyObject * DocumentPy::removeObject ( PyObject *  args)

◆ representation()

◆ restore()

◆ save()

◆ saveAs()

PyObject * DocumentPy::saveAs ( PyObject *  args)

implementer for the saveAs() method

References getDocumentPtr(), and App::Document::saveAs().

Referenced by staticCallback_saveAs().

◆ saveCopy()

PyObject * DocumentPy::saveCopy ( PyObject *  args)

implementer for the saveCopy() method

References getDocumentPtr(), and App::Document::saveCopy().

Referenced by staticCallback_saveCopy().

◆ 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(), App::Document::getObject(), App::PropertyContainer::getPropertyByName(), and App::PropertyContainerPy::getPropertyContainerPtr().

◆ setRecomputesFrozen()

void DocumentPy::setRecomputesFrozen ( Py::Boolean  arg)

setter for the RecomputesFrozen attribute

References getDocumentPtr(), and App::Document::setStatus().

Referenced by staticCallback_setRecomputesFrozen().

◆ setUndoMode()

void DocumentPy::setUndoMode ( Py::Int  arg)

setter for the UndoMode attribute

References getDocumentPtr(), and App::Document::setUndoMode().

Referenced by staticCallback_setUndoMode().

◆ staticCallback_abortTransaction()

◆ staticCallback_addObject()

◆ staticCallback_clearUndos()

◆ staticCallback_commitTransaction()

◆ staticCallback_copyObject()

◆ staticCallback_exportGraphviz()

◆ staticCallback_findObjects()

◆ staticCallback_getActiveObject()

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

◆ staticCallback_getDependencyGraph()

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

◆ staticCallback_getName()

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

◆ staticCallback_getObject()

◆ staticCallback_getObjects()

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

◆ staticCallback_getObjectsByLabel()

◆ staticCallback_getRecomputesFrozen()

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

◆ staticCallback_getRedoCount()

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

◆ staticCallback_getRedoNames()

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

◆ staticCallback_getRootObjects()

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

◆ staticCallback_getTempFileName()

◆ staticCallback_getTopologicalSortedObjects()

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

getter callback for the TopologicalSortedObjects attribute

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

◆ staticCallback_getUndoCount()

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

◆ staticCallback_getUndoMode()

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

◆ staticCallback_getUndoNames()

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

◆ staticCallback_getUndoRedoMemSize()

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

◆ staticCallback_load()

◆ staticCallback_mergeProject()

◆ staticCallback_moveObject()

◆ staticCallback_openTransaction()

◆ staticCallback_recompute()

◆ staticCallback_redo()

◆ staticCallback_removeObject()

◆ staticCallback_restore()

◆ staticCallback_save()

◆ staticCallback_saveAs()

◆ staticCallback_saveCopy()

◆ staticCallback_setActiveObject()

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

setter callback for the ActiveObject attribute

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

◆ staticCallback_setDependencyGraph()

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

setter callback for the DependencyGraph attribute

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

◆ staticCallback_setName()

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

setter callback for the Name attribute

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

◆ staticCallback_setObjects()

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

setter callback for the Objects attribute

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

◆ staticCallback_setRecomputesFrozen()

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

◆ staticCallback_setRedoCount()

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

setter callback for the RedoCount attribute

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

◆ staticCallback_setRedoNames()

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

setter callback for the RedoNames attribute

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

◆ staticCallback_setRootObjects()

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

setter callback for the RootObjects attribute

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

◆ staticCallback_setTopologicalSortedObjects()

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

setter callback for the TopologicalSortedObjects attribute

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

◆ staticCallback_setUndoCount()

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

setter callback for the UndoCount attribute

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

◆ staticCallback_setUndoMode()

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

◆ staticCallback_setUndoNames()

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

setter callback for the UndoNames attribute

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

◆ staticCallback_setUndoRedoMemSize()

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

setter callback for the UndoRedoMemSize attribute

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

◆ staticCallback_supportedTypes()

◆ staticCallback_undo()

◆ supportedTypes()

PyObject * DocumentPy::supportedTypes ( PyObject *  args)

◆ undo()

PyObject * DocumentPy::undo ( PyObject *  args)

implementer for the undo() method

References getDocumentPtr(), and App::Document::undo().

Referenced by staticCallback_undo().

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:
  • build/webdoc/src/App/DocumentPy.h
  • src/App/DocumentPyImp.cpp
  • build/webdoc/src/App/DocumentPy.cpp