Drawing::FeaturePage Class Reference
Base class of all View Features in the drawing module. More...
#include <FeaturePage.h>
Public Member Functions | |
| FeaturePage (void) | |
| Constructor. More... | |
| virtual | ~FeaturePage () |
 Public Member Functions inherited from App::DocumentObjectGroup | |
| DocumentObjectGroup () | |
| Constructor. More... | |
| virtual PyObject * | getPyObject () override |
| This method returns the Python wrapper for a C++ object. More... | |
| virtual const char * | getViewProviderName () const override |
| returns the type name of the ViewProvider More... | |
| virtual | ~DocumentObjectGroup () |
| Public Member Functions inherited from App::DocumentObject | |
| virtual App::Property * | addDynamicProperty (const char *type, const char *name=nullptr, const char *group=nullptr, const char *doc=nullptr, short attr=0, bool ro=false, bool hidden=false) override |
| virtual bool | adjustRelativeLinks (const std::set< App::DocumentObject * > &inList, std::set< App::DocumentObject * > *visited=nullptr) |
| Called to adjust link properties to avoid cyclic links. More... | |
| virtual bool | allowDuplicateLabel () const |
| virtual bool | canLinkProperties () const |
| virtual int | canLoadPartial () const |
| allow partial loading of dependent objects More... | |
| void | clearExpression (const ObjectIdentifier &path) |
| void | clearOutListCache () const |
| clear internal out list cache More... | |
| virtual const char * | detachFromDocument () override |
| DocumentObject (void) | |
| Constructor. More... | |
| void | enforceRecompute () |
| Enforce this document object to be recomputed. More... | |
| App::Document * | getDocument (void) const |
| gets the document in which this Object is handled More... | |
| std::string | getExportName (bool forced=false) const |
| returns the name that is safe to be exported to other document More... | |
| virtual const PropertyExpressionEngine::ExpressionInfo | getExpression (const ObjectIdentifier &path) const |
| virtual std::string | getFullName () const override |
| Return the object full name of the form DocName::ObjName. More... | |
| DocumentObjectGroup * | getGroup () const |
| get group if object is part of a group, otherwise 0 is returned More... | |
| long | getID () const |
| Return the object ID that is unique within its owner document. More... | |
| const std::vector< App::DocumentObject * > & | getInList (void) const |
| std::set< App::DocumentObject * > | getInListEx (bool recursive) const |
| Return a set of all objects linking to this object, including possible external parent objects. More... | |
| void | getInListEx (std::set< App::DocumentObject * > &inSet, bool recursive, std::vector< App::DocumentObject * > *inList=nullptr) const |
| Get a set of all objects linking to this object, including possible external parent objects. More... | |
| std::vector< App::DocumentObject * > | getInListRecursive (void) const |
| get all objects link directly or indirectly to this object More... | |
| virtual DocumentObject * | getLinkedObject (bool recurse=true, Base::Matrix4D *mat=nullptr, bool transform=false, int depth=0) const |
| Return the linked object with optional transformation. More... | |
| const char * | getNameInDocument (void) const |
| returns the name which is set in the document for this object (not the name property!) More... | |
| const std::string & | getOldLabel () const |
| const std::vector< App::DocumentObject * > & | getOutList () const |
| returns a list of objects this object is pointing to by Links More... | |
| std::vector< App::DocumentObject * > | getOutList (int option) const |
| void | getOutList (int option, std::vector< App::DocumentObject * > &res) const |
| std::vector< App::DocumentObject * > | getOutListOfProperty (App::Property *) const |
| returns a list of objects linked by the property More... | |
| std::vector< App::DocumentObject * > | getOutListRecursive (void) const |
| returns a list of objects this object is pointing to by Links and all further descended More... | |
| std::vector< std::pair< App::DocumentObject *, std::string > > | getParents (int depth=0) const |
| Obtain top parents and subnames of this object using its InList. More... | |
| std::vector< std::list< App::DocumentObject * > > | getPathsByOutList (App::DocumentObject *to) const |
| get all possible paths from this to another object following the OutList More... | |
| virtual PyObject * | getPyObject (void) override |
| This method returns the Python wrapper for a C++ object. More... | |
| unsigned long | getStatus () const |
| return the status bits More... | |
| const char * | getStatusString (void) const |
| get the status Message More... | |
| virtual DocumentObject * | getSubObject (const char *subname, PyObject **pyObj=nullptr, Base::Matrix4D *mat=nullptr, bool transform=true, int depth=0) const |
| Get the sub element/object by name. More... | |
| std::vector< DocumentObject * > | getSubObjectList (const char *subname) const |
| Return a list of objects referenced by a given subname including this object. More... | |
| virtual std::vector< std::string > | getSubObjects (int reason=0) const |
| Return name reference of all sub-objects. More... | |
| virtual const char * | getViewProviderName (void) const |
| returns the type name of the ViewProvider More... | |
| virtual const char * | getViewProviderNameOverride () const |
| This function is introduced to allow Python feature override its view provider. More... | |
| const char * | getViewProviderNameStored () const |
| virtual bool | hasChildElement () const |
| return true to activate tree view group object handling and element visibility More... | |
| virtual bool | isAttachedToDocument () const override |
| virtual int | isElementVisible (const char *element) const |
| Get sub-element visibility. More... | |
| bool | isError (void) const |
| set this feature to error More... | |
| int | isExporting () const |
| bool | isInInList (DocumentObject *objToTest) const |
| test if this object is directly (non recursive) in the InList More... | |
| bool | isInInListRecursive (DocumentObject *objToTest) const |
| test if this object is in the InList and recursive further down More... | |
| bool | isInOutList (DocumentObject *objToTest) const |
| test if this object is directly (non recursive) in the OutList More... | |
| bool | isInOutListRecursive (DocumentObject *objToTest) const |
| test if the given object is in the OutList and recursive further down More... | |
| bool | isRecomputing () const |
| returns true if this objects is currently recomputing More... | |
| bool | isRemoving () const |
| returns true if this objects is currently removed from the document More... | |
| bool | isRestoring () const |
| returns true if this objects is currently restoring from file More... | |
| bool | isTouched (void) const |
| test if this document object is touched More... | |
| bool | isValid (void) const |
| virtual short | mustExecute (void) const |
| mustExecute We call this method to check if the object was modified to be invoked. More... | |
| bool | mustRecompute (void) const |
| Test if this document object must be recomputed. More... | |
| virtual void | onBeforeChangeLabel (std::string &newLabel) |
| virtual void | onLostLinkToObject (DocumentObject *) |
| Called in case of losing a link Get called by the document when a object got deleted a link property of this object ist pointing to. More... | |
| virtual void | onUpdateElementReference (const Property *) |
| void | purgeError (void) |
| remove the error from the object More... | |
| void | purgeTouched (void) |
| reset this document object touched More... | |
| bool | recomputeFeature (bool recursive=false) |
| Recompute only this feature. More... | |
| virtual bool | redirectSubName (std::ostringstream &ss, DocumentObject *topParent, DocumentObject *child) const |
| Allow object to redirect a subname path. More... | |
| virtual bool | removeDynamicProperty (const char *prop) override |
| virtual void | renameObjectIdentifiers (const std::map< App::ObjectIdentifier, App::ObjectIdentifier > &paths) |
| App::DocumentObject * | resolve (const char *subname, App::DocumentObject **parent=nullptr, std::string *childName=nullptr, const char **subElement=nullptr, PyObject **pyObj=nullptr, Base::Matrix4D *mat=nullptr, bool transform=true, int depth=0) const |
| Resolve the last document object referenced in the subname. More... | |
| App::DocumentObject * | resolveRelativeLink (std::string &subname, App::DocumentObject *&link, std::string &linkSub) const |
| Resolve a link reference that is relative to this object reference. More... | |
| virtual void | Save (Base::Writer &writer) const override |
| This method is used to save properties to an XML document. More... | |
| virtual int | setElementVisible (const char *element, bool visible) |
| Child element handling. More... | |
| virtual void | setExpression (const ObjectIdentifier &path, std::shared_ptr< App::Expression > expr) |
| void | setStatus (ObjectStatus pos, bool on) |
| bool | testIfLinkDAGCompatible (App::PropertyLinkSub &linkTo) const |
| bool | testIfLinkDAGCompatible (App::PropertyLinkSubList &linksTo) const |
| bool | testIfLinkDAGCompatible (const std::vector< DocumentObject * > &linksTo) const |
| bool | testIfLinkDAGCompatible (DocumentObject *linkTo) const |
| testIfLinkIsDAG tests a link that is about to be created for circular references. More... | |
| bool | testStatus (ObjectStatus pos) const |
| void | touch (bool noRecompute=false) |
| Set the property touched -> changed, cause recomputation in Update() More... | |
| virtual | ~DocumentObject () |
| Public Member Functions inherited from App::TransactionalObject | |
| virtual const char * | detachFromDocument () |
| virtual bool | isAttachedToDocument () const |
| TransactionalObject (void) | |
| Constructor. More... | |
| virtual | ~TransactionalObject () |
| Public Member Functions inherited from App::ExtensionContainer | |
| ExtensionIterator | extensionBegin () |
| ExtensionContainer () | |
| ExtensionIterator | extensionEnd () |
| App::Extension * | getExtension (Base::Type, bool derived=true, bool no_except=false) const |
| App::Extension * | getExtension (const std::string &name) const |
| template<typename ExtensionT > | |
| ExtensionT * | getExtensionByType (bool no_except=false, bool derived=true) const |
| std::vector< Extension * > | getExtensionsDerivedFrom (Base::Type type) const |
| template<typename ExtensionT > | |
| std::vector< ExtensionT * > | getExtensionsDerivedFromType () const |
| bool | hasExtension (Base::Type, bool derived=true) const |
| bool | hasExtension (const std::string &name) const |
| bool | hasExtensions () const |
| void | registerExtension (Base::Type extension, App::Extension *ext) |
| virtual | ~ExtensionContainer () |
| virtual Property * | getPropertyByName (const char *name) const override |
| find a property by its name More... | |
| virtual const char * | getPropertyName (const Property *prop) const override |
| get the name of a property More... | |
| virtual void | getPropertyMap (std::map< std::string, Property * > &Map) const override |
| get all properties of the class (including properties of the parent) More... | |
| virtual void | getPropertyList (std::vector< Property * > &List) const override |
| get all properties of the class (including properties of the parent) More... | |
| virtual short | getPropertyType (const Property *prop) const override |
| get the Type of a Property More... | |
| virtual short | getPropertyType (const char *name) const override |
| get the Type of a named Property More... | |
| virtual const char * | getPropertyGroup (const Property *prop) const override |
| get the Group of a Property More... | |
| virtual const char * | getPropertyGroup (const char *name) const override |
| get the Group of a named Property More... | |
| virtual const char * | getPropertyDocumentation (const Property *prop) const override |
| get the Group of a Property More... | |
| virtual const char * | getPropertyDocumentation (const char *name) const override |
| get the Group of a named Property More... | |
| virtual void | Restore (Base::XMLReader &reader) override |
| This method is used to restore properties from an XML document. More... | |
| void | saveExtensions (Base::Writer &writer) const |
| void | restoreExtensions (Base::XMLReader &reader) |
| Public Member Functions inherited from App::PropertyContainer | |
| virtual App::Property * | addDynamicProperty (const char *type, const char *name=nullptr, const char *group=nullptr, const char *doc=nullptr, short attr=0, bool ro=false, bool hidden=false) |
| bool | changeDynamicProperty (const Property *prop, const char *group, const char *doc) |
| virtual void | editProperty (const char *) |
| virtual App::Property * | getDynamicPropertyByName (const char *name) const |
| DynamicProperty::PropData | getDynamicPropertyData (const Property *prop) const |
| virtual std::vector< std::string > | getDynamicPropertyNames () const |
| virtual std::string | getFullName () const |
| virtual unsigned int | getMemSize (void) const |
| This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More... | |
| virtual Property * | getPropertyByName (const char *name) const |
| find a property by its name More... | |
| virtual const char * | getPropertyDocumentation (const char *name) const |
| get the Group of a named Property More... | |
| virtual const char * | getPropertyDocumentation (const Property *prop) const |
| get the Group of a Property More... | |
| virtual const char * | getPropertyGroup (const char *name) const |
| get the Group of a named Property More... | |
| virtual const char * | getPropertyGroup (const Property *prop) const |
| get the Group of a Property More... | |
| virtual void | getPropertyList (std::vector< Property * > &List) const |
| get all properties of the class (including properties of the parent) More... | |
| virtual void | getPropertyMap (std::map< std::string, Property * > &Map) const |
| get all properties of the class (including properties of the parent) More... | |
| virtual const char * | getPropertyName (const Property *prop) const |
| get the name of a property More... | |
| virtual void | getPropertyNamedList (std::vector< std::pair< const char *, Property * > > &List) const |
| get all properties with their names, may contain duplicates and aliases More... | |
| const char * | getPropertyPrefix () const |
| virtual short | getPropertyType (const char *name) const |
| get the Type of a named Property More... | |
| virtual short | getPropertyType (const Property *prop) const |
| get the Type of a Property More... | |
| bool | isHidden (const char *name) const |
| check if the named property is hidden More... | |
| bool | isHidden (const Property *prop) const |
| check if the property is hidden More... | |
| bool | isReadOnly (const char *name) const |
| check if the named property is read-only More... | |
| bool | isReadOnly (const Property *prop) const |
| check if the property is read-only More... | |
| virtual void | onPropertyStatusChanged (const Property &prop, unsigned long oldStatus) |
| PropertyContainer () | |
| A constructor. More... | |
| virtual bool | removeDynamicProperty (const char *name) |
| virtual void | Restore (Base::XMLReader &reader) |
| This method is used to restore properties from an XML document. More... | |
| virtual void | Save (Base::Writer &writer) const |
| This method is used to save properties to an XML document. More... | |
| void | setPropertyPrefix (const char *prefix) |
| void | setPropertyStatus (unsigned char bit, bool value) |
| set the Status bit of all properties at once More... | |
| virtual | ~PropertyContainer () |
| A destructor. More... | |
| Public Member Functions inherited from Base::Persistence | |
| void | dumpToStream (std::ostream &stream, int compression) |
| virtual unsigned int | getMemSize () const =0 |
| This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More... | |
| virtual Base::Type | getTypeId (void) const |
| virtual void | Restore (XMLReader &)=0 |
| This method is used to restore properties from an XML document. More... | |
| virtual void | RestoreDocFile (Reader &) |
| This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More... | |
| void | restoreFromStream (std::istream &stream) |
| virtual void | Save (Writer &) const =0 |
| This method is used to save properties to an XML document. More... | |
| virtual void | SaveDocFile (Writer &) const |
| This method is used to save large amounts of data to a binary file. More... | |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. More... | |
| BaseClass (const BaseClass &)=default | |
| virtual PyObject * | getPyObject () |
| This method returns the Python wrapper for a C++ object. More... | |
| virtual Type | getTypeId () const |
| bool | isDerivedFrom (const Type type) const |
| BaseClass & | operator= (const BaseClass &)=default |
| virtual void | setPyObject (PyObject *) |
| virtual | ~BaseClass () |
| Destruction. More... | |
| Public Member Functions inherited from App::GroupExtension | |
| GroupExtension (void) | |
| Constructor. More... | |
| virtual | ~GroupExtension () |
| virtual DocumentObject * | addObject (const char *sType, const char *pObjectName) |
| Adds an object of sType with pObjectName to the document this group belongs to and append it to this group as well. More... | |
| virtual std::vector< DocumentObject * > | addObject (DocumentObject *obj) |
| virtual std::vector< DocumentObject * > | addObjects (std::vector< DocumentObject * > obj) |
| virtual std::vector< DocumentObject * > | setObjects (std::vector< DocumentObject * > obj) |
| virtual bool | allowObject (DocumentObject *) |
| virtual std::vector< DocumentObject * > | removeObject (DocumentObject *obj) |
| Removes an object from this group. More... | |
| virtual std::vector< DocumentObject * > | removeObjects (std::vector< DocumentObject * > obj) |
| Removes objects from this group. More... | |
| virtual void | removeObjectsFromDocument () |
| Removes all children objects from this group and the document. More... | |
| DocumentObject * | getObject (const char *Name) const |
| Returns the object of this group with Name. More... | |
| virtual bool | hasObject (const DocumentObject *obj, bool recursive=false) const |
| Checks whether the object obj is part of this group. More... | |
| bool | isChildOf (const GroupExtension *group, bool recursive=true) const |
| Checks whether this group object is a child (or sub-child if enabled) of the given group object. More... | |
| const std::vector< DocumentObject * > & | getObjects () const |
| Returns a list of all objects this group does have. More... | |
| std::vector< DocumentObject * > | getObjectsOfType (const Base::Type &typeId) const |
| Returns a list of all objects of typeId this group does have. More... | |
| int | countObjectsOfType (const Base::Type &typeId) const |
| Returns the number of objects of typeId this group does have. More... | |
| virtual PyObject * | getExtensionPyObject (void) override |
| virtual void | extensionOnChanged (const Property *p) override |
| virtual bool | extensionGetSubObject (DocumentObject *&ret, const char *subname, PyObject **pyObj, Base::Matrix4D *mat, bool transform, int depth) const override |
| Get the sub object by name. More... | |
| virtual bool | extensionGetSubObjects (std::vector< std::string > &ret, int reason) const override |
| Get name references of all sub objects. More... | |
| virtual App::DocumentObjectExecReturn * | extensionExecute (void) override |
| std::vector< DocumentObject * > | getAllChildren () const |
| void | getAllChildren (std::vector< DocumentObject * > &, std::set< DocumentObject * > &) const |
| Public Member Functions inherited from App::DocumentObjectExtension | |
| DocumentObjectExtension () | |
| virtual App::DocumentObjectExecReturn * | extensionExecute () |
| virtual bool | extensionGetLinkedObject (DocumentObject *&ret, bool recursive, Base::Matrix4D *mat, bool transform, int depth) const |
| Get the linked object. More... | |
| virtual bool | extensionGetSubObject (DocumentObject *&ret, const char *subname, PyObject **pyObj, Base::Matrix4D *mat, bool transform, int depth) const |
| Get the sub object by name. More... | |
| virtual bool | extensionGetSubObjects (std::vector< std::string > &ret, int reason) const |
| Get name references of all sub objects. More... | |
| virtual bool | extensionHasChildElement () const |
| virtual int | extensionIsElementVisible (const char *) |
| virtual short | extensionMustExecute () |
| virtual int | extensionSetElementVisible (const char *, bool) |
| App::DocumentObject * | getExtendedObject () |
| const App::DocumentObject * | getExtendedObject () const |
| virtual PyObject * | getExtensionPyObject () override |
| virtual const char * | getViewProviderExtensionName () const |
| returns the type name of the ViewProviderExtension which is automatically attached to the viewprovider object when it is initiated More... | |
| virtual void | onExtendedDocumentRestored () |
| get called after a document has been fully restored More... | |
| virtual void | onExtendedSettingDocument () |
| get called after setting the document More... | |
| virtual void | onExtendedSetupObject () |
| get called after a brand new object was created More... | |
| virtual void | onExtendedUnsetupObject () |
| get called when object is going to be removed from the document More... | |
| virtual | ~DocumentObjectExtension () |
| Public Member Functions inherited from App::Extension | |
| Extension () | |
| App::ExtensionContainer * | getExtendedContainer () |
| const App::ExtensionContainer * | getExtendedContainer () const |
| virtual PyObject * | getExtensionPyObject () |
| virtual void | initExtension (App::ExtensionContainer *obj) |
| bool | isPythonExtension () |
| std::string | name () const |
| virtual | ~Extension () |
| virtual Property * | extensionGetPropertyByName (const char *name) const |
| find a property by its name More... | |
| virtual const char * | extensionGetPropertyName (const Property *prop) const |
| get the name of a property More... | |
| virtual void | extensionGetPropertyMap (std::map< std::string, Property * > &Map) const |
| get all properties of the class (including properties of the parent) More... | |
| virtual void | extensionGetPropertyList (std::vector< Property * > &List) const |
| get all properties of the class (including properties of the parent) More... | |
| virtual short | extensionGetPropertyType (const Property *prop) const |
| get the Type of a Property More... | |
| virtual short | extensionGetPropertyType (const char *name) const |
| get the Type of a named Property More... | |
| virtual const char * | extensionGetPropertyGroup (const Property *prop) const |
| get the Group of a Property More... | |
| virtual const char * | extensionGetPropertyGroup (const char *name) const |
| get the Group of a named Property More... | |
| virtual const char * | extensionGetPropertyDocumentation (const Property *prop) const |
| get the Group of a Property More... | |
| virtual const char * | extensionGetPropertyDocumentation (const char *name) const |
| get the Group of a named Property More... | |
| virtual void | extensionSave (Base::Writer &) const |
| virtual void | extensionRestore (Base::XMLReader &) |
| bool | extensionIsDerivedFrom (const Base::Type type) const |
Public Attributes | |
| App::PropertyStringList | EditableTexts |
| App::PropertyFileIncluded | PageResult |
| App::PropertyFile | Template |
| Public Attributes inherited from App::DocumentObject | |
| PropertyExpressionEngine | ExpressionEngine |
| PropertyString | Label |
| PropertyString | Label2 |
| boost::signals2::signal< void(const App::DocumentObject &, const App::Property &)> | signalBeforeChange |
| signal before changing a property of this object More... | |
| boost::signals2::signal< void(const App::DocumentObject &, const App::Property &)> | signalChanged |
| signal on changed property of this object More... | |
| PropertyBool | Visibility |
| Allow control visibility status in App name space. More... | |
| Public Attributes inherited from App::GroupExtension | |
| PropertyLinkList | Group |
| Properties. More... | |
methods override Feature | |
| virtual App::DocumentObjectExecReturn * | execute (void) |
| recalculate the Feature More... | |
| virtual const char * | getViewProviderName (void) const |
| returns the type name of the ViewProvider More... | |
| virtual std::vector< std::string > | getEditableTextsFromTemplate (void) const |
| void | onBeforeChange (const App::Property *prop) |
| get called before the value is changed More... | |
| void | onChanged (const App::Property *prop) |
| get called by the container when a Property was changed More... | |
| virtual void | onDocumentRestored () |
| get called after a document has been fully restored More... | |
Additional Inherited Members | |
| Public Types inherited from App::DocumentObject | |
| enum | GSReason { GS_DEFAULT , GS_SELECT } |
| reason of calling getSubObjects() More... | |
| enum | OutListOption { OutListNoExpression = 1 , OutListNoHidden = 2 , OutListNoXLinked = 4 } |
| DAG handling This part of the interface deals with viewing the document as a DAG (directed acyclic graph). More... | |
| Public Types inherited from App::ExtensionContainer | |
| typedef std::map< Base::Type, App::Extension * >::iterator | ExtensionIterator |
| Static Public Member Functions inherited from App::DocumentObject | |
| static const char * | hasHiddenMarker (const char *subname) |
| Check if the subname reference ends with hidden marker. More... | |
| static const std::string & | hiddenMarker () |
| Special marker to mark the object as hidden. More... | |
| Static Public Member Functions inherited from Base::Persistence | |
| static void * | create (void) |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. More... | |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
| Static Public Member Functions inherited from Base::BaseClass | |
| static void * | create () |
| static Type | getClassTypeId () |
| static void | init () |
| Static Public Member Functions inherited from App::GroupExtension | |
| static DocumentObject * | getGroupOfObject (const DocumentObject *obj) |
| Returns the object group of the document which the given object obj is part of. More... | |
| Static Public Attributes inherited from App::DocumentObject | |
| static DocumentObjectExecReturn * | StdReturn |
| Protected Member Functions inherited from App::DocumentObject | |
| virtual App::DocumentObjectExecReturn * | execute (void) |
| get called by the document to recompute this feature Normally this method get called in the processing of Document::recompute(). More... | |
| App::DocumentObjectExecReturn * | executeExtensions () |
| Executes the extensions of a document object. More... | |
| virtual void | onBeforeChange (const Property *prop) override |
| get called before the value is changed More... | |
| virtual void | onChanged (const Property *prop) override |
| get called by the container when a property was changed More... | |
| virtual void | onDocumentRestored () |
| get called after a document has been fully restored More... | |
| virtual void | onPropertyStatusChanged (const Property &prop, unsigned long oldStatus) override |
| get called when a property status has changed More... | |
| virtual void | onSettingDocument () |
| get called after setting the document More... | |
| virtual void | onUndoRedoFinished () |
| get called after an undo/redo transaction is finished More... | |
| virtual App::DocumentObjectExecReturn * | recompute (void) |
| recompute only this object More... | |
| void | resetError (void) |
| void | setDocument (App::Document *doc) |
| void | setError (void) |
| virtual void | setupObject () |
| get called after a brand new object was created More... | |
| virtual void | unsetupObject () |
| get called when object is going to be removed from the document More... | |
| Protected Member Functions inherited from App::TransactionalObject | |
| void | onBeforeChangeProperty (Document *doc, const Property *prop) |
| Protected Member Functions inherited from App::PropertyContainer | |
| virtual const PropertyData & | getPropertyData (void) const |
| virtual void | handleChangedPropertyName (Base::XMLReader &reader, const char *TypeName, const char *PropName) |
| PropertyContainer::handleChangedPropertyName is called during restore to possibly fix reading of older versions of this property container. More... | |
| virtual void | handleChangedPropertyType (Base::XMLReader &reader, const char *TypeName, Property *prop) |
| PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container. More... | |
| virtual void | onBeforeChange (const Property *) |
| get called before the value is changed More... | |
| virtual void | onChanged (const Property *) |
| get called by the container when a property has changed More... | |
| Protected Member Functions inherited from App::Extension | |
| void | initExtensionType (Base::Type type) |
| Static Protected Member Functions inherited from App::PropertyContainer | |
| static const PropertyData * | getPropertyDataPtr (void) |
| Static Protected Member Functions inherited from Base::BaseClass | |
| static void | initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr) |
| Static Protected Member Functions inherited from App::Extension | |
| static void | initExtensionSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Base::Type::instantiationMethod method=nullptr) |
| Protected Attributes inherited from App::DocumentObject | |
| std::string | oldLabel |
| Old label; used for renaming expressions. More... | |
| const std::string * | pcNameInDocument |
| Py::SmartPtr | PythonObject |
| python object of this class and all descendent More... | |
| std::bitset< 32 > | StatusBits |
| Status bits of the document object The first 8 bits are used for the base system the rest can be used in descendent classes to mark special statuses on the objects. More... | |
| Protected Attributes inherited from App::PropertyContainer | |
| DynamicProperty | dynamicProps |
| Protected Attributes inherited from App::Extension | |
| bool | m_isPythonExtension = false |
| Py::SmartPtr | ExtensionPythonObject |
Detailed Description
Base class of all View Features in the drawing module.
Constructor & Destructor Documentation
◆ FeaturePage()
| FeaturePage::FeaturePage | ( | void | ) |
Constructor.
References App::Prop_None, and App::Prop_Output.
◆ ~FeaturePage()
|
virtual |
Member Function Documentation
◆ execute()
|
virtual |
recalculate the Feature
Reimplemented from App::DocumentObject.
References Base::Console(), EditableTexts, Base::FileInfo::fileName(), Base::FileInfo::filePath(), Base::Persistence::getClassTypeId(), App::PropertyFileIncluded::getExchangeTempFile(), App::Application::getResourceDir(), App::PropertyFileIncluded::getValue(), App::PropertyString::getValue(), App::PropertyBool::getValue(), App::PropertyListsT< T, ListT, ParentT >::getValues(), App::GroupExtension::Group, Base::FileInfo::isReadable(), Base::ConsoleSingleton::Log(), PageResult, Base::FileInfo::setFile(), App::PropertyFileIncluded::setValue(), App::DocumentObject::StdReturn, Template, Drawing::FeatureClip::ViewResult, Drawing::FeatureView::ViewResult, Drawing::FeatureClip::Visible, and Drawing::FeatureView::Visible.
Referenced by draftobjects.facebinder.Facebinder::addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup::boneStateList(), ArchSite.Compass::buildCoordinates(), PathScripts.PathDressupHoldingTags.ObjectTagDressup::generateTags(), ArchPanel.PanelCut::getWires(), ArchSchedule.CommandArchSchedule::IsActive(), onChanged(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt::onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid::onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped::onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder::onChanged(), Mod.PartDesign.Scripts.Spring.MySpring::onChanged(), FeaturePython.DistanceBolt::onChanged(), PathScripts.PathStock.StockFromBase::onChanged(), PathScripts.PathStock.StockCreateBox::onChanged(), PathScripts.PathStock.StockCreateCylinder::onChanged(), draftobjects.draftlink.DraftLink::onDocumentRestored(), draftobjects.patharray.PathArray::onDocumentRestored(), and draftobjects.pathtwistedarray.PathTwistedArray::onDocumentRestored().
◆ getEditableTextsFromTemplate()
|
virtual |
◆ getViewProviderName()
|
virtual |
returns the type name of the ViewProvider
Reimplemented from App::DocumentObjectGroup.
◆ onBeforeChange()
|
protectedvirtual |
get called before the value is changed
Reimplemented from App::DocumentObject.
References App::PropertyListsT< T, ListT, ParentT >::getSize(), App::GroupExtension::Group, and App::DocumentObject::onBeforeChange().
Referenced by PathScripts.PathGui.QuantitySpinBox::updateProperty().
◆ onChanged()
|
protectedvirtual |
get called by the container when a Property was changed
Reimplemented from App::DocumentObject.
References EditableTexts, execute(), Base::FileInfo::exists(), getEditableTextsFromTemplate(), App::PropertyListsT< T, ListT, ParentT >::getSize(), App::PropertyFileIncluded::getValue(), App::GroupExtension::Group, App::DocumentObject::isRestoring(), App::DocumentObject::onChanged(), PageResult, App::PropertyStringList::setValues(), Template, and App::DocumentObject::touch().
Referenced by ArchStructure.CommandStructuralSystem::Activated(), draftviewproviders.view_base.ViewProviderDraft::attach(), ArchSite.Compass::buildCoordinates(), draftobjects.wire.Wire::execute(), ArchBuildingPart.ViewProviderBuildingPart::updateData(), ArchPanel.ViewProviderPanelCut::updateData(), ArchPanel.ViewProviderPanelSheet::updateData(), draftviewproviders.view_label.ViewProviderLabel::updateData(), draftviewproviders.view_layer.ViewProviderLayer::updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy::updateData().
◆ onDocumentRestored()
|
protectedvirtual |
get called after a document has been fully restored
Reimplemented from App::DocumentObject.
References Base::FileInfo::exists(), Base::FileInfo::fileName(), Base::FileInfo::filePath(), App::Application::getResourceDir(), App::Application::getUserAppDataDir(), App::PropertyFileIncluded::getValue(), App::PropertyString::getValue(), PageResult, App::Restore, Base::FileInfo::setFile(), App::PropertyString::setValue(), App::DocumentObject::StatusBits, and Template.
Member Data Documentation
◆ EditableTexts
| App::PropertyStringList Drawing::FeaturePage::EditableTexts |
Referenced by execute(), and onChanged().
◆ PageResult
| App::PropertyFileIncluded Drawing::FeaturePage::PageResult |
Referenced by execute(), onChanged(), and onDocumentRestored().
◆ Template
| App::PropertyFile Drawing::FeaturePage::Template |
Referenced by execute(), getEditableTextsFromTemplate(), onChanged(), and onDocumentRestored().
The documentation for this class was generated from the following files:
- FreeCAD/src/Mod/Drawing/App/FeaturePage.h
- FreeCAD/src/Mod/Drawing/App/FeaturePage.cpp
