The python export class for PropertyContainer. More...
#include <PropertyContainerPy.h>
Public Types | |
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 | |
virtual PyTypeObject * | GetType (void) |
PropertyContainerPy (PropertyContainer *pcObject, PyTypeObject *T=&Type) | |
virtual int | PyInit (PyObject *args, PyObject *k) |
PyInit method Override this method to initialize a newly created instance of the class (Constructor) More... | |
std::string | representation (void) const |
Public Member Functions inherited from Base::PersistencePy | |
PersistencePy (Persistence *pcObject, PyTypeObject *T=&Type) | |
std::string | representation (void) const |
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 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 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 | |
~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 attributes | |
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... | |
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... | |
Additional Inherited Members | |
Protected Attributes inherited from Base::PyObjectBase | |
std::bitset< 32 > | StatusBits |
Detailed Description
The python export class for PropertyContainer.
Member Typedef Documentation
◆ PointerType
Constructor & Destructor Documentation
◆ ~PropertyContainerPy()
|
protected |
◆ PropertyContainerPy()
PropertyContainerPy::PropertyContainerPy | ( | PropertyContainer * | pcObject, |
PyTypeObject * | T = &Type |
||
) |
References Base::PyObjectBase::setShouldNotify().
Member Function Documentation
◆ dumpPropertyContent()
implementer for the dumpPropertyContent() method
References Base::Persistence::dumpToStream(), App::PropertyContainer::getPropertyByName(), and getPropertyContainerPtr().
Referenced by staticCallback_dumpPropertyContent().
◆ getCustomAttributes()
PyObject * PropertyContainerPy::getCustomAttributes | ( | const char * | attr | ) | const |
getter method for special attributes (e.g. dynamic ones)
References Base::Persistence::getClassTypeId(), App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), App::PropertyContainer::getPropertyMap(), Base::BaseClass::getPyObject(), Base::BaseClassPy::isDerivedFrom(), and Base::streq().
Referenced by App::ExtensionContainerPy::getCustomAttributes().
◆ getDocumentationOfProperty()
implementer for the getDocumentationOfProperty() method
References App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), and App::PropertyContainer::getPropertyDocumentation().
Referenced by staticCallback_getDocumentationOfProperty().
◆ getEditorMode()
implementer for the getEditorMode() method
References App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), App::Property::getType(), App::Property::Hidden, App::Prop_Hidden, App::Prop_ReadOnly, App::Property::ReadOnly, App::Property::testStatus(), and Type.
Referenced by staticCallback_getEditorMode().
◆ getGroupOfProperty()
implementer for the getGroupOfProperty() method
References App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), and App::PropertyContainer::getPropertyGroup().
Referenced by staticCallback_getGroupOfProperty().
◆ getPropertiesList()
Py::List PropertyContainerPy::getPropertiesList | ( | void | ) | const |
getter for the PropertiesList attribute
References getPropertyContainerPtr(), and App::PropertyContainer::getPropertyMap().
Referenced by staticCallback_getPropertiesList().
◆ getPropertyByName()
implementer for the getPropertyByName() method
References App::Property::getContainer(), App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), and Base::BaseClass::getPyObject().
Referenced by staticCallback_getPropertyByName().
◆ getPropertyContainerPtr()
PropertyContainer * PropertyContainerPy::getPropertyContainerPtr | ( | void | ) | const |
getter for the object handled by this class
Referenced by dumpPropertyContent(), getCustomAttributes(), App::DocumentPy::getCustomAttributes(), getDocumentationOfProperty(), getEditorMode(), getGroupOfProperty(), getPropertiesList(), getPropertyByName(), getTypeIdOfProperty(), getTypeOfProperty(), restorePropertyContent(), setCustomAttributes(), App::DocumentPy::setCustomAttributes(), and setEditorMode().
◆ GetType()
|
virtual |
Reimplemented from Base::PersistencePy.
Reimplemented in Gui::ViewProviderLinkPy, TechDraw::DrawTilePy, TechDraw::DrawTileWeldPy, TechDraw::DrawViewDimExtentPy, TechDraw::DrawWeldSymbolPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::ExtensionContainerPy, App::GeoFeaturePy, App::PartPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Fem::FemPostPipelinePy, FemGui::ViewProviderFemMeshPy, Mesh::MeshFeaturePy, MeshGui::ViewProviderMeshPy, Part::BodyBasePy, Part::Part2DObjectPy, Part::PartFeaturePy, PartDesign::BodyPy, PartDesign::FeaturePy, PartDesignGui::ViewProviderPy, 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.
◆ getTypeIdOfProperty()
implementer for the getTypeIdOfProperty() method
References Base::Type::getName(), App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), and Base::Persistence::getTypeId().
Referenced by staticCallback_getTypeIdOfProperty().
◆ getTypeOfProperty()
implementer for the getTypeOfProperty() method
References App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), App::Property::getType(), App::Prop_Hidden, App::Prop_NoRecompute, App::Prop_Output, App::Prop_ReadOnly, App::Prop_Transient, and Type.
Referenced by staticCallback_getTypeOfProperty().
◆ PyInit()
PyInit method Override this method to initialize a newly created instance of the class (Constructor)
Reimplemented from Base::PersistencePy.
Reimplemented in Gui::ViewProviderLinkPy, TechDraw::DrawTilePy, TechDraw::DrawTileWeldPy, TechDraw::DrawViewDimExtentPy, TechDraw::DrawWeldSymbolPy, App::DocumentObjectGroupPy, App::DocumentObjectPy, App::DocumentPy, App::ExtensionContainerPy, App::GeoFeaturePy, App::PartPy, Gui::ViewProviderDocumentObjectPy, Gui::ViewProviderPy, Fem::FemPostPipelinePy, FemGui::ViewProviderFemMeshPy, Mesh::MeshFeaturePy, MeshGui::ViewProviderMeshPy, Part::BodyBasePy, Part::Part2DObjectPy, Part::PartFeaturePy, PartDesign::BodyPy, PartDesign::FeaturePy, PartDesignGui::ViewProviderPy, 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()
◆ representation()
std::string PropertyContainerPy::representation | ( | void | ) | const |
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().
◆ restorePropertyContent()
implementer for the restorePropertyContent() method
References App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), and Base::Persistence::restoreFromStream().
Referenced by staticCallback_restorePropertyContent().
◆ setCustomAttributes()
int PropertyContainerPy::setCustomAttributes | ( | const char * | attr, |
PyObject * | obj | ||
) |
setter for special attributes (e.g.
dynamic ones) Output: Success=1, Failure=-1, Ignore=0
References App::Property::getFullName(), App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), App::Property::Immutable, Base::BaseClass::setPyObject(), and App::Property::testStatus().
◆ setEditorMode()
implementer for the setEditorMode() method
References App::PropertyContainer::getPropertyByName(), getPropertyContainerPtr(), App::Property::getStatus(), App::Property::Hidden, App::Property::ReadOnly, and App::Property::setStatusValue().
Referenced by staticCallback_setEditorMode().
◆ staticCallback_dumpPropertyContent()
|
static |
callback for the dumpPropertyContent() method
References Base::BaseExceptionFreeCADError, Base::Console(), dumpPropertyContent(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getDocumentationOfProperty()
|
static |
callback for the getDocumentationOfProperty() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), getDocumentationOfProperty(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), and Base::PyObjectBase::startNotify().
◆ staticCallback_getEditorMode()
◆ staticCallback_getGroupOfProperty()
◆ staticCallback_getPropertiesList()
|
static |
getter callback for the PropertiesList attribute
References Base::BaseExceptionFreeCADError, getPropertiesList(), Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
◆ staticCallback_getPropertyByName()
◆ staticCallback_getTypeIdOfProperty()
◆ staticCallback_getTypeOfProperty()
◆ staticCallback_restorePropertyContent()
|
static |
callback for the restorePropertyContent() method
References Base::BaseExceptionFreeCADError, Base::Console(), Base::ConsoleSingleton::Error(), Base::PyObjectBase::isConst(), Base::PyObjectBase::isValid(), Base::PyObjectBase::PyObjectBase(), restorePropertyContent(), and Base::PyObjectBase::startNotify().
◆ staticCallback_setEditorMode()
◆ staticCallback_setPropertiesList()
|
static |
setter callback for the PropertiesList attribute
References Base::PyObjectBase::isValid(), and Base::PyObjectBase::PyObjectBase().
Member Data Documentation
◆ GetterSetter
|
static |
Attribute structure of PropertyContainerPy.
◆ Methods
|
static |
Methods structure of PropertyContainerPy.
◆ Type
|
static |
Type structure of PropertyContainerPy.
Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), ArchComponent.Component::execute(), DraftLayer.LayerContainer::execute(), getEditorMode(), getTypeOfProperty(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), draftobjects.draft_annotation.DraftAnnotation::onDocumentRestored(), ArchReference.ArchReference::setProperties(), and DraftLayer.Layer::setProperties().
The documentation for this class was generated from the following files:
- build/webdoc/src/App/PropertyContainerPy.h
- src/App/PropertyContainerPyImp.cpp
- build/webdoc/src/App/PropertyContainerPy.cpp