The python export class for Document. More...
#include <DocumentPy.h>
Public Types | |
typedef Document * PointerType | |
![]() | |
typedef PropertyContainer * PointerType | |
![]() | |
typedef Persistence * PointerType | |
![]() | |
typedef BaseClass * PointerType | |
![]() | |
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 | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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 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 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 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 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 PyGetSetDef GetterSetter [] | |
Attribute structure of PropertyContainerPy. More... | |
static PyMethodDef Methods [] | |
Methods structure of PropertyContainerPy. More... | |
static PyTypeObject Type | |
Type structure of PropertyContainerPy. More... | |
![]() | |
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 PyGetSetDef GetterSetter [] | |
Attribute structure of BaseClassPy. More... | |
static PyMethodDef Methods [] | |
Methods structure of BaseClassPy. More... | |
static PyTypeObject Type | |
Type structure of BaseClassPy. More... | |
![]() | |
static PyMethodDef Methods [] | |
static PyTypeObject Type | |
Py_Header struct from python.h. More... | |
Protected Member Functions | |
~DocumentPy () | |
![]() | |
~PropertyContainerPy () | |
![]() | |
~PersistencePy () | |
![]() | |
~BaseClassPy () | |
![]() | |
virtual ~PyObjectBase () | |
destructor 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 | |
![]() | |
std::bitset< 32 > StatusBits | |
Detailed Description
The python export class for Document.
Member Typedef Documentation
◆ PointerType
typedef Document* App::DocumentPy::PointerType |
Constructor & Destructor Documentation
◆ ~DocumentPy()
|
protected |
◆ DocumentPy()
Member Function Documentation
◆ abortTransaction()
implementer for the abortTransaction() method
References App::Document::abortTransaction(), and getDocumentPtr().
Referenced by staticCallback_abortTransaction().
◆ addObject()
implementer for the addObject() method
References App::Document::addObject(), Base::BaseExceptionFreeCADError, Base::Type::createInstanceByName(), Base::Persistence::getClassTypeId(), getDocumentPtr(), and App::DocumentObject::getPyObject().
Referenced by ArchPanel.NestTaskPanel::getContainer(), ArchPanel.NestTaskPanel::getShapes(), and staticCallback_addObject().
◆ clearUndos()
implementer for the clearUndos() method
References App::Document::clearUndos(), and getDocumentPtr().
Referenced by staticCallback_clearUndos().
◆ commitTransaction()
implementer for the commitTransaction() method
References App::Document::commitTransaction(), and getDocumentPtr().
Referenced by staticCallback_commitTransaction().
◆ copyObject()
implementer for the copyObject() method
References App::Document::copyObject(), getDocumentPtr(), and App::DocumentObjectPy::Type.
Referenced by staticCallback_copyObject().
◆ exportGraphviz()
implementer for the exportGraphviz() method
References App::Document::exportGraphviz(), and getDocumentPtr().
Referenced by staticCallback_exportGraphviz().
◆ findObjects()
implementer for the findObjects() method
References Base::Type::badType(), Base::BaseExceptionFreeCADError, App::Document::findObjects(), Base::Type::fromName(), Base::Persistence::getClassTypeId(), getDocumentPtr(), and App::Document::getObjectsOfType().
Referenced by staticCallback_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 |
getter method for special attributes (e.g. dynamic ones)
References getDocumentPtr(), App::Document::getObject(), App::PropertyContainer::getPropertyByName(), and App::PropertyContainerPy::getPropertyContainerPtr().
◆ getDependencyGraph()
Py::String DocumentPy::getDependencyGraph | ( | void | ) | const |
getter for the DependencyGraph attribute
References App::Document::exportGraphviz(), and getDocumentPtr().
Referenced by staticCallback_getDependencyGraph().
◆ getDocumentPtr()
Document * DocumentPy::getDocumentPtr | ( | void | ) | const |
getter for the object handled by this class
Referenced by abortTransaction(), addObject(), clearUndos(), commitTransaction(), copyObject(), exportGraphviz(), findObjects(), getActiveObject(), getCustomAttributes(), getDependencyGraph(), getName(), getObject(), getObjects(), getObjectsByLabel(), getRecomputesFrozen(), getRedoCount(), getRedoNames(), getRootObjects(), getTempFileName(), getTopologicalSortedObjects(), getUndoCount(), getUndoMode(), getUndoNames(), getUndoRedoMemSize(), load(), mergeProject(), moveObject(), openTransaction(), recompute(), redo(), removeObject(), representation(), restore(), save(), saveAs(), saveCopy(), setCustomAttributes(), setRecomputesFrozen(), setUndoMode(), and undo().
◆ getName()
Py::String DocumentPy::getName | ( | void | ) | const |
◆ getObject()
implementer for the getObject() method
References getDocumentPtr(), App::Document::getObject(), App::Document::getObjectByID(), and App::DocumentObject::getPyObject().
Referenced by staticCallback_getObject().
◆ getObjects()
Py::List DocumentPy::getObjects | ( | void | ) | const |
getter for the Objects attribute
References getDocumentPtr(), and App::Document::getObjects().
Referenced by staticCallback_getObjects().
◆ getObjectsByLabel()
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()
implementer for the getTempFileName() method
References Base::FileInfo::deleteFile(), Base::FileInfo::filePath(), getDocumentPtr(), and Base::FileInfo::getTempFileName().
Referenced by staticCallback_getTempFileName().
◆ getTopologicalSortedObjects()
Py::List DocumentPy::getTopologicalSortedObjects | ( | void | ) | const |
getter for the TopologicalSortedObjects attribute
References getDocumentPtr(), and App::Document::topologicalSort().
Referenced by staticCallback_getTopologicalSortedObjects().
◆ GetType()
|
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()
implementer for the load() method
References App::Document::FileName, getDocumentPtr(), Base::FileInfo::isReadable(), App::Document::restore(), and App::PropertyString::setValue().
Referenced by staticCallback_load().
◆ mergeProject()
implementer for the mergeProject() method
References getDocumentPtr(), and App::MergeDocuments::importObjects().
Referenced by staticCallback_mergeProject().
◆ moveObject()
implementer for the moveObject() method
References Base::BaseExceptionFreeCADError, App::DocumentObjectPy::getDocumentObjectPtr(), getDocumentPtr(), App::Document::moveObject(), and App::DocumentObjectPy::Type.
Referenced by staticCallback_moveObject().
◆ openTransaction()
implementer for the openTransaction() method
References getDocumentPtr(), and App::Document::openTransaction().
Referenced by staticCallback_openTransaction().
◆ PyInit()
PyInit method Override this method to initialize a newly created instance of the class (Constructor)
Reimplemented from App::PropertyContainerPy.
◆ PyMake()
◆ recompute()
implementer for the recompute() method
References App::Document::DepNoCycle, getDocumentPtr(), App::Document::recompute(), and App::DocumentObjectPy::Type.
Referenced by draftguitools.gui_trackers.arcTracker::setApertureAngle(), draftguitools.gui_trackers.arcTracker::setEndAngle(), draftguitools.gui_trackers.arcTracker::setStartAngle(), staticCallback_recompute(), draftguitools.gui_trackers.bsplineTracker::update(), and draftguitools.gui_trackers.bezcurveTracker::update().
◆ redo()
implementer for the redo() method
References getDocumentPtr(), and App::Document::redo().
Referenced by staticCallback_redo().
◆ removeObject()
implementer for the removeObject() method
References Base::BaseExceptionFreeCADError, getDocumentPtr(), App::Document::getObject(), and App::Document::removeObject().
Referenced by staticCallback_removeObject().
◆ representation()
std::string DocumentPy::representation | ( | void | ) | const |
References getDocumentPtr().
Referenced by config_control_design.pcurve::wr1(), config_control_design.degenerate_pcurve::wr1(), automotive_design.motion_link_relationship::wr1(), automotive_design.pcurve::wr1(), automotive_design.degenerate_pcurve::wr1(), config_control_design.pcurve::wr2(), config_control_design.degenerate_pcurve::wr2(), automotive_design.pcurve::wr2(), and automotive_design.degenerate_pcurve::wr2().
◆ restore()
implementer for the restore() method
References App::Document::FileName, getDocumentPtr(), App::PropertyString::getValue(), Base::FileInfo::isReadable(), and App::Document::restore().
Referenced by staticCallback_restore().
◆ save()
implementer for the save() method
References App::Document::FileName, getDocumentPtr(), App::PropertyString::getValue(), and Base::FileInfo::isReadable().
Referenced by shipGZ.TaskPanel.TaskPanel::accept(), shipAreasCurve.TaskPanel.TaskPanel::accept(), shipHydrostatics.TaskPanel.TaskPanel::accept(), Mod.Show.mTempoVis.TempoVis::modify(), Mod.Show.mTempoVis.TempoVis::modifyVPProperty(), Mod.Show.mTempoVis.TempoVis::saveCamera(), and staticCallback_save().
◆ saveAs()
implementer for the saveAs() method
References getDocumentPtr(), and App::Document::saveAs().
Referenced by staticCallback_saveAs().
◆ saveCopy()
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()
getter callback for the ActiveObject attribute
References Base::BaseExceptionFreeCADError, getActiveObject(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getDependencyGraph()
getter callback for the DependencyGraph attribute
References Base::BaseExceptionFreeCADError, getDependencyGraph(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getName()
getter callback for the Name attribute
References Base::BaseExceptionFreeCADError, getName(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getObject()
◆ staticCallback_getObjects()
getter callback for the Objects attribute
References Base::BaseExceptionFreeCADError, getObjects(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getObjectsByLabel()
◆ staticCallback_getRecomputesFrozen()
|
static |
getter callback for the RecomputesFrozen attribute
References Base::BaseExceptionFreeCADError, getRecomputesFrozen(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getRedoCount()
getter callback for the RedoCount attribute
References Base::BaseExceptionFreeCADError, getRedoCount(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getRedoNames()
getter callback for the RedoNames attribute
References Base::BaseExceptionFreeCADError, getRedoNames(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getRootObjects()
getter callback for the RootObjects attribute
References Base::BaseExceptionFreeCADError, getRootObjects(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getTempFileName()
◆ staticCallback_getTopologicalSortedObjects()
|
static |
getter callback for the TopologicalSortedObjects attribute
References Base::BaseExceptionFreeCADError, getTopologicalSortedObjects(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getUndoCount()
getter callback for the UndoCount attribute
References Base::BaseExceptionFreeCADError, getUndoCount(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getUndoMode()
getter callback for the UndoMode attribute
References Base::BaseExceptionFreeCADError, getUndoMode(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getUndoNames()
getter callback for the UndoNames attribute
References Base::BaseExceptionFreeCADError, getUndoNames(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getUndoRedoMemSize()
getter callback for the UndoRedoMemSize attribute
References Base::BaseExceptionFreeCADError, getUndoRedoMemSize(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_load()
callback for the load() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), load(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().
◆ staticCallback_mergeProject()
◆ staticCallback_moveObject()
◆ staticCallback_openTransaction()
◆ staticCallback_recompute()
◆ staticCallback_redo()
callback for the redo() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), redo(), and Base::PyObjectBase::startNotify().
◆ staticCallback_removeObject()
◆ staticCallback_restore()
callback for the restore() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), restore(), and Base::PyObjectBase::startNotify().
◆ staticCallback_save()
callback for the save() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), save(), and Base::PyObjectBase::startNotify().
◆ staticCallback_saveAs()
callback for the saveAs() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), saveAs(), and Base::PyObjectBase::startNotify().
◆ staticCallback_saveCopy()
◆ staticCallback_setActiveObject()
|
static |
setter callback for the ActiveObject attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setDependencyGraph()
|
static |
setter callback for the DependencyGraph attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setName()
setter callback for the Name attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setObjects()
|
static |
setter callback for the Objects attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setRecomputesFrozen()
|
static |
setter callback for the RecomputesFrozen attribute
References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and setRecomputesFrozen().
◆ staticCallback_setRedoCount()
|
static |
setter callback for the RedoCount attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setRedoNames()
|
static |
setter callback for the RedoNames attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setRootObjects()
|
static |
setter callback for the RootObjects attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setTopologicalSortedObjects()
|
static |
setter callback for the TopologicalSortedObjects attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setUndoCount()
|
static |
setter callback for the UndoCount attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setUndoMode()
|
static |
setter callback for the UndoMode attribute
References Base::BaseExceptionFreeCADError, Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and setUndoMode().
◆ staticCallback_setUndoNames()
|
static |
setter callback for the UndoNames attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_setUndoRedoMemSize()
|
static |
setter callback for the UndoRedoMemSize attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_supportedTypes()
◆ staticCallback_undo()
callback for the undo() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::PyObjectBase::startNotify(), and undo().
◆ supportedTypes()
implementer for the supportedTypes() method
References Base::Type::getAllDerivedFrom(), and Base::Persistence::getClassTypeId().
Referenced by staticCallback_supportedTypes().
◆ undo()
implementer for the undo() method
References getDocumentPtr(), and App::Document::undo().
Referenced by staticCallback_undo().
Member Data Documentation
◆ GetterSetter
|
static |
Attribute structure of DocumentPy.
◆ Methods
|
static |
Methods structure of DocumentPy.
◆ Type
|
static |
Type structure of DocumentPy.
Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchComponent.Component::execute(), DraftLayer.LayerContainer::execute(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), draftobjects.draft_annotation.DraftAnnotation::onDocumentRestored(), ArchReference.ArchReference::setProperties(), DraftLayer.Layer::setProperties(), Gui::Application::sGetDocument(), and Gui::Application::sSetActiveDocument().
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