App::DocumentObjectPy Class Reference

The python export class for DocumentObject. More...

#include <DocumentObjectPy.h>

Public Types
typedef DocumentObject *	PointerType
Public Types inherited from App::ExtensionContainerPy
typedef ExtensionContainer *	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
	DocumentObjectPy (DocumentObject *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::ExtensionContainerPy
	ExtensionContainerPy (ExtensionContainer *pcObject, PyTypeObject *T=&Type)
int	finalization ()
int	initialization ()
std::string	representation (void) const
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...
ExtensionContainer *	getExtensionContainerPtr (void) const
	getter for the object handled by this class More...
PyObject *	addExtension (PyObject *args)
	implementer for the addExtension() method More...
PyObject *	hasExtension (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
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::ExtensionContainerPy
static PyObject *	PyMake (struct _typeobject *, PyObject *, PyObject *)
static PyObject *	staticCallback_addExtension (PyObject *self, PyObject *args)
	callback for the addExtension() method More...
static PyObject *	staticCallback_hasExtension (PyObject *self, PyObject *args)
	callback for the hasExtension() method More...
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 DocumentObjectPy. More...
static PyMethodDef	Methods []
	Methods structure of DocumentObjectPy. More...
static PyTypeObject	Type
	Type structure of DocumentObjectPy. 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
	~DocumentObjectPy ()
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
virtual	~PyObjectBase ()
	destructor More...

callbacks and implementers for the python object methods
PyObject *	addProperty (PyObject *args)
	implementer for the addProperty() method More...
PyObject *	removeProperty (PyObject *args)
	implementer for the removeProperty() method More...
PyObject *	supportedProperties (PyObject *args)
	implementer for the supportedProperties() method More...
PyObject *	touch (PyObject *args)
	implementer for the touch() method More...
PyObject *	purgeTouched (PyObject *args)
	implementer for the purgeTouched() method More...
PyObject *	enforceRecompute (PyObject *args)
	implementer for the enforceRecompute() method More...
PyObject *	setExpression (PyObject *args)
	implementer for the setExpression() method More...
PyObject *	recompute (PyObject *args)
	implementer for the recompute() method More...
PyObject *	getParentGroup (PyObject *args)
	implementer for the getParentGroup() method More...
PyObject *	getParentGeoFeatureGroup (PyObject *args)
	implementer for the getParentGeoFeatureGroup() method More...
PyObject *	getPathsByOutList (PyObject *args)
	implementer for the getPathsByOutList() method More...
static PyObject *	staticCallback_addProperty (PyObject *self, PyObject *args)
	callback for the addProperty() method More...
static PyObject *	staticCallback_removeProperty (PyObject *self, PyObject *args)
	callback for the removeProperty() method More...
static PyObject *	staticCallback_supportedProperties (PyObject *self, PyObject *args)
	callback for the supportedProperties() method More...
static PyObject *	staticCallback_touch (PyObject *self, PyObject *args)
	callback for the touch() method More...
static PyObject *	staticCallback_purgeTouched (PyObject *self, PyObject *args)
	callback for the purgeTouched() method More...
static PyObject *	staticCallback_enforceRecompute (PyObject *self, PyObject *args)
	callback for the enforceRecompute() method More...
static PyObject *	staticCallback_setExpression (PyObject *self, PyObject *args)
	callback for the setExpression() method More...
static PyObject *	staticCallback_recompute (PyObject *self, PyObject *args)
	callback for the recompute() method More...
static PyObject *	staticCallback_getParentGroup (PyObject *self, PyObject *args)
	callback for the getParentGroup() method More...
static PyObject *	staticCallback_getParentGeoFeatureGroup (PyObject *self, PyObject *args)
	callback for the getParentGeoFeatureGroup() method More...
static PyObject *	staticCallback_getPathsByOutList (PyObject *self, PyObject *args)
	callback for the getPathsByOutList() method More...

callbacks and implementers for the python object attributes
Py::List	getOutList (void) const
	getter for the OutList attribute More...
Py::List	getOutListRecursive (void) const
	getter for the OutListRecursive attribute More...
Py::List	getInList (void) const
	getter for the InList attribute More...
Py::List	getInListRecursive (void) const
	getter for the InListRecursive attribute More...
Py::String	getName (void) const
	getter for the Name attribute More...
Py::Object	getDocument (void) const
	getter for the Document attribute More...
Py::List	getState (void) const
	getter for the State attribute More...
Py::Object	getViewObject (void) const
	getter for the ViewObject 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...
DocumentObject *	getDocumentObjectPtr (void) const
	getter for the object handled by this class More...
static PyObject *	staticCallback_getOutList (PyObject *self, void *closure)
	getter callback for the OutList attribute More...
static int	staticCallback_setOutList (PyObject *self, PyObject *value, void *closure)
	setter callback for the OutList attribute More...
static PyObject *	staticCallback_getOutListRecursive (PyObject *self, void *closure)
	getter callback for the OutListRecursive attribute More...
static int	staticCallback_setOutListRecursive (PyObject *self, PyObject *value, void *closure)
	setter callback for the OutListRecursive attribute More...
static PyObject *	staticCallback_getInList (PyObject *self, void *closure)
	getter callback for the InList attribute More...
static int	staticCallback_setInList (PyObject *self, PyObject *value, void *closure)
	setter callback for the InList attribute More...
static PyObject *	staticCallback_getInListRecursive (PyObject *self, void *closure)
	getter callback for the InListRecursive attribute More...
static int	staticCallback_setInListRecursive (PyObject *self, PyObject *value, void *closure)
	setter callback for the InListRecursive 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_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 PyObject *	staticCallback_getState (PyObject *self, void *closure)
	getter callback for the State attribute More...
static int	staticCallback_setState (PyObject *self, PyObject *value, void *closure)
	setter callback for the State attribute More...
static PyObject *	staticCallback_getViewObject (PyObject *self, void *closure)
	getter callback for the ViewObject attribute More...
static int	staticCallback_setViewObject (PyObject *self, PyObject *value, void *closure)
	setter callback for the ViewObject attribute More...

Additional Inherited Members
Protected Attributes inherited from Base::PyObjectBase
std::bitset< 32 >	StatusBits

Detailed Description

The python export class for DocumentObject.

Member Typedef Documentation

PointerType

typedef DocumentObject* App::DocumentObjectPy::PointerType

Constructor & Destructor Documentation

~DocumentObjectPy()

DocumentObjectPy::~DocumentObjectPy ( )

protected

DocumentObjectPy()

DocumentObjectPy::DocumentObjectPy	(	DocumentObject *	pcObject,
		PyTypeObject *	T = &Type
	)

Referenced by Path::FeaturePathCompoundPy::addObject(), and Path::FeaturePathCompoundPy::removeObject().

Member Function Documentation

addProperty()

PyObject * DocumentObjectPy::addProperty

(

PyObject *

args

)

implementer for the addProperty() method

References App::DocumentObject::addDynamicProperty(), Base::BaseExceptionFreeCADError, and getDocumentObjectPtr().

Referenced by DocumentObject.Box::init(), DocumentObject.DocumentObject::onChanged(), and staticCallback_addProperty().

enforceRecompute()

PyObject * DocumentObjectPy::enforceRecompute

(

PyObject *

args

)

implementer for the enforceRecompute() method

References App::DocumentObject::enforceRecompute(), and getDocumentObjectPtr().

Referenced by staticCallback_enforceRecompute().

getCustomAttributes()

PyObject * DocumentObjectPy::getCustomAttributes

(

const char *

attr

)

const

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

References getDocumentObjectPtr(), App::PropertyContainer::getDynamicPropertyByName(), and Base::BaseClass::getPyObject().

getDocument()

Py::Object DocumentObjectPy::getDocument

(

void

)

const

getter for the Document attribute

References getDocumentObjectPtr().

Referenced by Path::FeaturePathCompoundPy::addObject(), getViewObject(), Path::FeaturePathCompoundPy::removeObject(), and staticCallback_getDocument().

getDocumentObjectPtr()

DocumentObject * DocumentObjectPy::getDocumentObjectPtr

(

void

)

const

getter for the object handled by this class

Referenced by App::GroupExtensionPy::addObject(), App::GroupExtensionPy::addObjects(), addProperty(), enforceRecompute(), getCustomAttributes(), getDocument(), App::GeoFeaturePy::getGlobalPlacement(), getInList(), getInListRecursive(), getName(), getOutList(), getOutListRecursive(), getParentGeoFeatureGroup(), getParentGroup(), getPathsByOutList(), getState(), getViewObject(), App::GroupExtensionPy::hasObject(), Fem::FemPostPipelinePy::holdsPostObject(), PartDesign::BodyPy::insertObject(), Fem::FemPostPipelinePy::load(), App::DocumentPy::moveObject(), purgeTouched(), Attacher::AttachEnginePy::readParametersFromFeature(), recompute(), App::GroupExtensionPy::removeObject(), App::GroupExtensionPy::removeObjects(), removeProperty(), representation(), Gui::SelectionSingleton::sAddSelection(), setCustomAttributes(), setExpression(), App::GroupExtensionPy::setObjects(), App::PropertyLink::setPyObject(), App::PropertyLinkSub::setPyObject(), App::PropertyLinkSubList::setPyObject(), App::PropertyXLink::setPyObject(), Gui::SelectionSingleton::sIsSelected(), Gui::SelectionSingleton::sRemoveSelection(), Gui::SelectionSingleton::sSetPreselection(), Gui::SelectionSingleton::sUpdateSelection(), Gui::SelectionFilterPy::test(), touch(), and Attacher::AttachEnginePy::writeParametersToFeature().

getInList()

Py::List DocumentObjectPy::getInList

(

void

)

const

getter for the InList attribute

References getDocumentObjectPtr(), and App::DocumentObject::getInList().

Referenced by staticCallback_getInList().

getInListRecursive()

Py::List DocumentObjectPy::getInListRecursive

(

void

)

const

getter for the InListRecursive attribute

References getDocumentObjectPtr(), and App::DocumentObject::getInListRecursive().

Referenced by staticCallback_getInListRecursive().

getName()

Py::String DocumentObjectPy::getName

(

void

)

const

getter for the Name attribute

References getDocumentObjectPtr().

Referenced by getViewObject(), and staticCallback_getName().

getOutList()

Py::List DocumentObjectPy::getOutList

(

void

)

const

getter for the OutList attribute

References getDocumentObjectPtr(), and App::DocumentObject::getOutList().

Referenced by staticCallback_getOutList().

getOutListRecursive()

Py::List DocumentObjectPy::getOutListRecursive

(

void

)

const

getter for the OutListRecursive attribute

References getDocumentObjectPtr(), and App::DocumentObject::getOutListRecursive().

Referenced by staticCallback_getOutListRecursive().

getParentGeoFeatureGroup()

PyObject * DocumentObjectPy::getParentGeoFeatureGroup

(

PyObject *

args

)

implementer for the getParentGeoFeatureGroup() method

References getDocumentObjectPtr(), and App::GeoFeatureGroupExtension::getGroupOfObject().

Referenced by staticCallback_getParentGeoFeatureGroup().

getParentGroup()

PyObject * DocumentObjectPy::getParentGroup

(

PyObject *

args

)

implementer for the getParentGroup() method

References getDocumentObjectPtr(), and App::GroupExtension::getGroupOfObject().

Referenced by staticCallback_getParentGroup().

getPathsByOutList()

PyObject * DocumentObjectPy::getPathsByOutList

(

PyObject *

args

)

implementer for the getPathsByOutList() method

References getDocumentObjectPtr(), App::DocumentObject::getPathsByOutList(), and Type.

Referenced by staticCallback_getPathsByOutList().

getState()

Py::List DocumentObjectPy::getState

(

void

)

const

getter for the State attribute

References App::Expand, getDocumentObjectPtr(), App::ObjImporting, App::PartialObject, and App::Recompute2.

Referenced by staticCallback_getState().

GetType()

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

virtual

Reimplemented from App::ExtensionContainerPy.

Reimplemented in TechDraw::DrawTilePy, TechDraw::DrawTileWeldPy, TechDraw::DrawViewDimExtentPy, TechDraw::DrawWeldSymbolPy, App::DocumentObjectGroupPy, App::GeoFeaturePy, App::PartPy, Fem::FemPostPipelinePy, Mesh::MeshFeaturePy, Part::BodyBasePy, Part::Part2DObjectPy, Part::PartFeaturePy, PartDesign::BodyPy, PartDesign::FeaturePy, Path::FeatureAreaPy, Path::FeaturePathCompoundPy, Robot::RobotObjectPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, Spreadsheet::SheetPy, TechDraw::DrawGeomHatchPy, TechDraw::DrawHatchPy, TechDraw::DrawLeaderLinePy, TechDraw::DrawPagePy, TechDraw::DrawParametricTemplatePy, TechDraw::DrawProjGroupItemPy, TechDraw::DrawProjGroupPy, TechDraw::DrawRichAnnoPy, TechDraw::DrawSVGTemplatePy, TechDraw::DrawTemplatePy, TechDraw::DrawViewAnnotationPy, TechDraw::DrawViewClipPy, TechDraw::DrawViewCollectionPy, TechDraw::DrawViewDimensionPy, TechDraw::DrawViewPartPy, TechDraw::DrawViewPy, and TechDraw::DrawViewSymbolPy.

getViewObject()

Py::Object DocumentObjectPy::getViewObject

(

void

)

const

getter for the ViewObject attribute

References getDocument(), getDocumentObjectPtr(), getName(), and App::DocumentObject::getNameInDocument().

Referenced by staticCallback_getViewObject().

purgeTouched()

PyObject * DocumentObjectPy::purgeTouched

(

PyObject *

args

)

implementer for the purgeTouched() method

References getDocumentObjectPtr(), and App::DocumentObject::purgeTouched().

Referenced by staticCallback_purgeTouched().

PyInit()

int DocumentObjectPy::PyInit ( PyObject *  , PyObject *    )

virtual

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

Reimplemented from App::ExtensionContainerPy.

Reimplemented in TechDraw::DrawTilePy, TechDraw::DrawTileWeldPy, TechDraw::DrawViewDimExtentPy, TechDraw::DrawWeldSymbolPy, App::DocumentObjectGroupPy, App::GeoFeaturePy, App::PartPy, Fem::FemPostPipelinePy, Mesh::MeshFeaturePy, Part::BodyBasePy, Part::Part2DObjectPy, Part::PartFeaturePy, PartDesign::BodyPy, PartDesign::FeaturePy, Path::FeatureAreaPy, Path::FeaturePathCompoundPy, Robot::RobotObjectPy, Sketcher::SketchObjectPy, Sketcher::SketchObjectSFPy, Spreadsheet::SheetPy, TechDraw::DrawGeomHatchPy, TechDraw::DrawHatchPy, TechDraw::DrawLeaderLinePy, TechDraw::DrawPagePy, TechDraw::DrawParametricTemplatePy, TechDraw::DrawProjGroupItemPy, TechDraw::DrawProjGroupPy, TechDraw::DrawRichAnnoPy, TechDraw::DrawSVGTemplatePy, TechDraw::DrawTemplatePy, TechDraw::DrawViewAnnotationPy, TechDraw::DrawViewClipPy, TechDraw::DrawViewCollectionPy, TechDraw::DrawViewDimensionPy, TechDraw::DrawViewPartPy, TechDraw::DrawViewPy, and TechDraw::DrawViewSymbolPy.

PyMake()

PyObject * DocumentObjectPy::PyMake ( struct _typeobject *  , PyObject *  , PyObject *    )

static

recompute()

PyObject * DocumentObjectPy::recompute

(

PyObject *

args

)

implementer for the recompute() method

References getDocumentObjectPtr(), and App::DocumentObject::recomputeFeature().

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().

removeProperty()

PyObject * DocumentObjectPy::removeProperty

(

PyObject *

args

)

implementer for the removeProperty() method

References getDocumentObjectPtr(), and App::DocumentObject::removeDynamicProperty().

Referenced by staticCallback_removeProperty().

representation()

std::string DocumentObjectPy::representation

(

void

)

const

References getDocumentObjectPtr().

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().

setCustomAttributes()

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

setter for special attributes (e.g.

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

References getDocumentObjectPtr(), App::PropertyContainer::getDynamicPropertyByName(), App::Property::getName(), App::ExtensionContainer::getPropertyByName(), App::Property::Immutable, App::Prop_ReadOnly, Base::BaseClass::setPyObject(), App::Property::testStatus(), and Base::Exception::what().

setExpression()

PyObject * DocumentObjectPy::setExpression

(

PyObject *

args

)

implementer for the setExpression() method

References getDocumentObjectPtr(), App::Expression::parse(), App::ObjectIdentifier::parse(), App::ExpressionParser::parse(), and App::DocumentObject::setExpression().

Referenced by staticCallback_setExpression().

staticCallback_addProperty()

PyObject * DocumentObjectPy::staticCallback_addProperty ( PyObject *  self, PyObject *  args  )

static

callback for the addProperty() method

References addProperty(), Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_enforceRecompute()

PyObject * DocumentObjectPy::staticCallback_enforceRecompute ( PyObject *  self, PyObject *  args  )

static

callback for the enforceRecompute() method

References Base::BaseExceptionFreeCADError, Base::Console(), enforceRecompute(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_getDocument()

PyObject * DocumentObjectPy::staticCallback_getDocument ( PyObject *  self, void *  closure  )

static

getter callback for the Document attribute

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

staticCallback_getInList()

PyObject * DocumentObjectPy::staticCallback_getInList ( PyObject *  self, void *  closure  )

static

getter callback for the InList attribute

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

staticCallback_getInListRecursive()

PyObject * DocumentObjectPy::staticCallback_getInListRecursive ( PyObject *  self, void *  closure  )

static

getter callback for the InListRecursive attribute

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

staticCallback_getName()

PyObject * DocumentObjectPy::staticCallback_getName ( PyObject *  self, void *  closure  )

static

getter callback for the Name attribute

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

staticCallback_getOutList()

PyObject * DocumentObjectPy::staticCallback_getOutList ( PyObject *  self, void *  closure  )

static

getter callback for the OutList attribute

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

staticCallback_getOutListRecursive()

PyObject * DocumentObjectPy::staticCallback_getOutListRecursive ( PyObject *  self, void *  closure  )

static

getter callback for the OutListRecursive attribute

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

staticCallback_getParentGeoFeatureGroup()

PyObject * DocumentObjectPy::staticCallback_getParentGeoFeatureGroup ( PyObject *  self, PyObject *  args  )

static

callback for the getParentGeoFeatureGroup() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), getParentGeoFeatureGroup(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_getParentGroup()

PyObject * DocumentObjectPy::staticCallback_getParentGroup ( PyObject *  self, PyObject *  args  )

static

callback for the getParentGroup() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), getParentGroup(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_getPathsByOutList()

PyObject * DocumentObjectPy::staticCallback_getPathsByOutList ( PyObject *  self, PyObject *  args  )

static

callback for the getPathsByOutList() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), getPathsByOutList(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_getState()

PyObject * DocumentObjectPy::staticCallback_getState ( PyObject *  self, void *  closure  )

static

getter callback for the State attribute

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

staticCallback_getViewObject()

PyObject * DocumentObjectPy::staticCallback_getViewObject ( PyObject *  self, void *  closure  )

static

getter callback for the ViewObject attribute

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

staticCallback_purgeTouched()

PyObject * DocumentObjectPy::staticCallback_purgeTouched ( PyObject *  self, PyObject *  args  )

static

callback for the purgeTouched() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), purgeTouched(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().

staticCallback_recompute()

PyObject * DocumentObjectPy::staticCallback_recompute ( PyObject *  self, PyObject *  args  )

static

callback for the recompute() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), recompute(), and Base::PyObjectBase::startNotify().

staticCallback_removeProperty()

PyObject * DocumentObjectPy::staticCallback_removeProperty ( PyObject *  self, PyObject *  args  )

static

callback for the removeProperty() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), removeProperty(), and Base::PyObjectBase::startNotify().

staticCallback_setDocument()

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

static

setter callback for the Document attribute

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

staticCallback_setExpression()

PyObject * DocumentObjectPy::staticCallback_setExpression ( PyObject *  self, PyObject *  args  )

static

callback for the setExpression() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), setExpression(), and Base::PyObjectBase::startNotify().

staticCallback_setInList()

int DocumentObjectPy::staticCallback_setInList ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the InList attribute

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

staticCallback_setInListRecursive()

int DocumentObjectPy::staticCallback_setInListRecursive ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the InListRecursive attribute

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

staticCallback_setName()

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

static

setter callback for the Name attribute

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

staticCallback_setOutList()

int DocumentObjectPy::staticCallback_setOutList ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the OutList attribute

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

staticCallback_setOutListRecursive()

int DocumentObjectPy::staticCallback_setOutListRecursive ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the OutListRecursive attribute

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

staticCallback_setState()

int DocumentObjectPy::staticCallback_setState ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the State attribute

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

staticCallback_setViewObject()

int DocumentObjectPy::staticCallback_setViewObject ( PyObject *  self, PyObject *  value, void *  closure  )

static

setter callback for the ViewObject attribute

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

staticCallback_supportedProperties()

PyObject * DocumentObjectPy::staticCallback_supportedProperties ( PyObject *  self, PyObject *  args  )

static

callback for the supportedProperties() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::PyObjectBase::startNotify(), and supportedProperties().

staticCallback_touch()

PyObject * DocumentObjectPy::staticCallback_touch ( PyObject *  self, PyObject *  args  )

static

callback for the touch() method

References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), Base::PyObjectBase::startNotify(), and touch().

supportedProperties()

PyObject * DocumentObjectPy::supportedProperties

(

PyObject *

args

)

implementer for the supportedProperties() method

References Base::Type::getAllDerivedFrom(), and Base::Persistence::getClassTypeId().

Referenced by staticCallback_supportedProperties().

touch()

PyObject * DocumentObjectPy::touch

(

PyObject *

args

)

implementer for the touch() method

References getDocumentObjectPtr(), App::ExtensionContainer::getPropertyByName(), and App::DocumentObject::touch().

Referenced by staticCallback_touch().

Member Data Documentation

GetterSetter

PyGetSetDef DocumentObjectPy::GetterSetter

static

Attribute structure of DocumentObjectPy.

Methods

PyMethodDef DocumentObjectPy::Methods

static

Methods structure of DocumentObjectPy.

Type

PyTypeObject DocumentObjectPy::Type

static

Type structure of DocumentObjectPy.

Referenced by ArchPanel.CommandPanelSheet::Activated(), App::GroupExtensionPy::addObject(), App::GroupExtensionPy::addObjects(), ArchStructure.StructSelectionObserver::addSelection(), TechDraw::DrawPagePy::addView(), TechDraw::DrawViewClipPy::addView(), TechDraw::DrawViewCollectionPy::addView(), Gui::ExpressionBindingPy::bind(), ArchSite.Compass::buildCoordinates(), Gui::ViewProviderPythonFeatureImp::claimChildren(), App::DocumentPy::copyObject(), ArchComponent.Component::execute(), DraftLayer.LayerContainer::execute(), Gui::FreeCADGui_subgraphFromObject(), App::FeaturePythonImp::getLinkedObject(), getPathsByOutList(), App::PropertyLinkList::getPyValue(), App::FeaturePythonImp::getSubObject(), App::GroupExtensionPy::hasObject(), Fem::FemPostPipelinePy::holdsPostObject(), PartDesign::BodyPy::insertObject(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), Fem::FemPostPipelinePy::load(), App::DocumentPy::moveObject(), draftobjects.draft_annotation.DraftAnnotation::onDocumentRestored(), Attacher::AttachEnginePy::readParametersFromFeature(), App::DocumentPy::recompute(), App::GroupExtensionPy::removeObject(), App::GroupExtensionPy::removeObjects(), TechDraw::DrawViewClipPy::removeView(), TechDraw::DrawViewCollectionPy::removeView(), TechDraw::DrawPagePy::removeView(), Gui::SelectionSingleton::sAddSelection(), Gui::MDIViewPy::setActiveObject(), Gui::View3DInventorPy::setActiveObject(), Gui::DocumentPy::setEdit(), Gui::LinkViewPy::setLink(), App::GroupExtensionPy::setObjects(), ArchReference.ArchReference::setProperties(), DraftLayer.Layer::setProperties(), App::PropertyLink::setPyObject(), App::PropertyLinkSub::setPyObject(), App::PropertyLinkSubList::setPyObject(), App::PropertyXLink::setPyObject(), Gui::Application::sExport(), Gui::Application::sHideObject(), Gui::SelectionSingleton::sIsSelected(), Gui::SelectionSingleton::sRemoveSelection(), Gui::SelectionSingleton::sSetPreselection(), Gui::Application::sShowObject(), Gui::SelectionSingleton::sUpdateSelection(), Gui::SelectionFilterPy::test(), Gui::DocumentPy::toggleTreeItem(), and Attacher::AttachEnginePy::writeParametersToFeature().

---

The documentation for this class was generated from the following files:

• build/webdoc/src/App/DocumentObjectPy.h
• src/App/DocumentObjectPyImp.cpp
• build/webdoc/src/App/DocumentObjectPy.cpp