App::DocumentObjectExtension Class Reference

Extension with special document object calls. More...

#include <DocumentObjectExtension.h>

Public Member Functions

 DocumentObjectExtension ()
 
virtual App::DocumentObjectExecReturnextensionExecute (void)
 
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 (void)
 
virtual int extensionSetElementVisible (const char *, bool)
 
App::DocumentObjectgetExtendedObject ()
 
const App::DocumentObjectgetExtendedObject () const
 
virtual PyObjectgetExtensionPyObject (void) override
 
virtual const char * getViewProviderExtensionName (void) 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::ExtensionContainergetExtendedContainer ()
 
const App::ExtensionContainergetExtendedContainer () const
 
virtual void initExtension (App::ExtensionContainer *obj)
 
bool isPythonExtension ()
 
std::string name () const
 
virtual ~Extension ()
 
virtual PropertyextensionGetPropertyByName (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
 

Additional Inherited Members

- Protected Member Functions inherited from App::Extension
virtual void extensionOnChanged (const Property *p)
 
void initExtensionType (Base::Type type)
 
- Static Protected Member Functions inherited from App::Extension
static void initExtensionSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Base::Type::instantiationMethod method=0)
 
- Protected Attributes inherited from App::Extension
bool m_isPythonExtension = false
 
Py::Object ExtensionPythonObject
 

Detailed Description

Extension with special document object calls.

Constructor & Destructor Documentation

◆ DocumentObjectExtension()

DocumentObjectExtension::DocumentObjectExtension ( )

◆ ~DocumentObjectExtension()

DocumentObjectExtension::~DocumentObjectExtension ( )
virtual

Member Function Documentation

◆ extensionExecute()

◆ extensionGetLinkedObject()

bool DocumentObjectExtension::extensionGetLinkedObject ( DocumentObject *&  ret,
bool  recursive,
Base::Matrix4D mat,
bool  transform,
int  depth 
) const
virtual

Get the linked object.

See also
DocumentObject::getLinkedObject()
Returns
Return turn if handled, the linked object is returned in ret

Reimplemented in App::LinkBaseExtension.

◆ extensionGetSubObject()

bool DocumentObjectExtension::extensionGetSubObject ( DocumentObject *&  ret,
const char *  subname,
PyObject **  pyObj,
Base::Matrix4D mat,
bool  transform,
int  depth 
) const
virtual

Get the sub object by name.

See also
DocumentObject::getSubObject()
Returns
Return turn if handled, the sub object is returned in ret

Reimplemented in App::LinkBaseExtension, App::OriginGroupExtension, App::GroupExtension, and App::GeoFeatureGroupExtension.

◆ extensionGetSubObjects()

bool DocumentObjectExtension::extensionGetSubObjects ( std::vector< std::string > &  ret,
int  reason 
) const
virtual

Get name references of all sub objects.

See also
DocumentObject::getSubObjects()
Returns
Return turn if handled, the sub object is returned in ret

Reimplemented in App::LinkBaseExtension, App::GroupExtension, and App::GeoFeatureGroupExtension.

◆ extensionHasChildElement()

virtual bool App::DocumentObjectExtension::extensionHasChildElement ( ) const
virtual

Reimplemented in App::LinkBaseExtension.

◆ extensionIsElementVisible()

virtual int App::DocumentObjectExtension::extensionIsElementVisible ( const char *  )
virtual

Reimplemented in App::LinkBaseExtension.

◆ extensionMustExecute()

short int DocumentObjectExtension::extensionMustExecute ( void  )
virtual

◆ extensionSetElementVisible()

virtual int App::DocumentObjectExtension::extensionSetElementVisible ( const char *  ,
bool   
)
virtual

Reimplemented in App::LinkBaseExtension.

◆ getExtendedObject() [1/2]

◆ getExtendedObject() [2/2]

const DocumentObject * DocumentObjectExtension::getExtendedObject ( ) const

◆ getExtensionPyObject()

PyObject * DocumentObjectExtension::getExtensionPyObject ( void  )
overridevirtual

◆ getViewProviderExtensionName()

virtual const char* App::DocumentObjectExtension::getViewProviderExtensionName ( void  ) const
virtual

returns the type name of the ViewProviderExtension which is automatically attached to the viewprovider object when it is initiated

◆ onExtendedDocumentRestored()

void DocumentObjectExtension::onExtendedDocumentRestored ( )
virtual

get called after a document has been fully restored

Reimplemented in App::LinkExtension, App::LinkBaseExtension, and Part::AttachExtension.

Referenced by App::LinkBaseExtension::onExtendedDocumentRestored().

◆ onExtendedSettingDocument()

void DocumentObjectExtension::onExtendedSettingDocument ( )
virtual

get called after setting the document

◆ onExtendedSetupObject()

void DocumentObjectExtension::onExtendedSetupObject ( )
virtual

get called after a brand new object was created

Reimplemented in App::OriginGroupExtension.

Referenced by App::OriginGroupExtension::onExtendedSetupObject().

◆ onExtendedUnsetupObject()

void DocumentObjectExtension::onExtendedUnsetupObject ( )
virtual

get called when object is going to be removed from the document

Reimplemented in App::OriginGroupExtension, and App::LinkBaseExtension.

Referenced by App::OriginGroupExtension::onExtendedUnsetupObject().


The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/App/DocumentObjectExtension.h
  • Sources/FreeCAD/src/App/DocumentObjectExtension.cpp