List of all members | Classes | Public Types | Public Member Functions
App::LinkBaseExtension Class Reference

#include <Link.h>

Classes

struct  PropInfo
 

Public Types

enum  { LinkModeNone , LinkModeAutoDelete , LinkModeAutoLink , LinkModeAutoUnlink }
 

Public Member Functions

 LinkBaseExtension ()
 
virtual ~LinkBaseExtension ()
 
- 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 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
 

Parameter definition

Parameter definition (Name, Type, Property Type, Default, Document).

The variadic is here so that the parameter can be extended by adding extra fields. See LINK_PARAM_EXT() for an example

enum  PropIndex { PropMax }
 
enum  LinkCopyOnChangeType { CopyOnChangeDisabled = 0 , CopyOnChangeEnabled = 1 , CopyOnChangeOwned = 2 , CopyOnChangeTracking = 3 }
 
enum class  OnChangeCopyOptions { Exclude = 1 , ApplyAll = 2 }
 Options used in setOnChangeCopyObject() Multiple options can be combined by bitwise or operator. More...
 
typedef std::map< std::string, PropInfo > PropInfoMap
 
typedef std::map< const Property *, std::pair< LinkBaseExtension *, int > > LinkPropMap
 
std::vector< Property * > props
 
std::unordered_set< const App::DocumentObject * > myHiddenElements
 
std::vector< std::string > mySubElements
 
std::string mySubName
 
std::unordered_map< const App::DocumentObject *, boost::signals2::scoped_connection > plainGroupConns
 
long prevLinkedObjectID = 0
 
std::unordered_map< std::string, int > myLabelCache
 
bool enableLabelCache
 
bool hasOldSubElement
 
std::vector< boost::signals2::scoped_connection > copyOnChangeConns
 
std::vector< boost::signals2::scoped_connection > copyOnChangeSrcConns
 
bool hasCopyOnChange
 
bool checkingProperty = false
 
bool pauseCopyOnChange = false
 
boost::signals2::scoped_connection connCopyOnChangeSource
 
virtual void setProperty (int idx, Property *prop)
 
Property * getProperty (int idx)
 
Property * getProperty (const char *)
 
virtual const std::vector< PropInfo > & getPropertyInfo () const
 
virtual const PropInfoMap & getPropertyInfoMap () const
 
std::vector< DocumentObject * > getLinkedChildren (bool filter=true) const
 
const char * flattenSubname (const char *subname) const
 
void expandSubname (std::string &subname) const
 
DocumentObject * getLink (int depth=0) const
 
Base::Matrix4D getTransform (bool transform) const
 
Base::Vector3d getScaleVector () const
 
App::GroupExtension * linkedPlainGroup () const
 
bool linkTransform () const
 
const char * getSubName () const
 
const std::vector< std::string > & getSubElements () const
 
bool extensionGetSubObject (DocumentObject *&ret, const char *subname, PyObject **pyObj=nullptr, Base::Matrix4D *mat=nullptr, bool transform=false, int depth=0) const override
 Get the sub object by name. More...
 
bool extensionGetSubObjects (std::vector< std::string > &ret, int reason) const override
 Get name references of all sub objects. More...
 
bool extensionGetLinkedObject (DocumentObject *&ret, bool recurse, Base::Matrix4D *mat, bool transform, int depth) const override
 Get the linked object. More...
 
virtual App::DocumentObjectExecReturn * extensionExecute (void) override
 
virtual short extensionMustExecute (void) override
 
virtual void extensionOnChanged (const Property *p) override
 
virtual void onExtendedUnsetupObject () override
 get called when object is going to be removed from the document More...
 
virtual void onExtendedDocumentRestored () override
 get called after a document has been fully restored More...
 
virtual int extensionSetElementVisible (const char *, bool) override
 
virtual int extensionIsElementVisible (const char *) override
 
virtual bool extensionHasChildElement () const override
 
virtual PyObject * getExtensionPyObject (void) override
 
virtual Property * extensionGetPropertyByName (const char *name) const override
 find a property by its name More...
 
int getElementIndex (const char *subname, const char **psubname=nullptr) const
 
void elementNameFromIndex (int idx, std::ostream &ss) const
 
DocumentObject * getContainer ()
 
const DocumentObject * getContainer () const
 
void setLink (int index, DocumentObject *obj, const char *subname=nullptr, const std::vector< std::string > &subs=std::vector< std::string >())
 
DocumentObject * getTrueLinkedObject (bool recurse, Base::Matrix4D *mat=nullptr, int depth=0, bool noElement=false) const
 
bool hasPlacement () const
 
void cacheChildLabel (int enable=-1) const
 
void syncCopyOnChange ()
 
void setOnChangeCopyObject (App::DocumentObject *obj, OnChangeCopyOptions options)
 Include or exclude object from list of objects to copy on change. More...
 
std::vector< App::DocumentObject * > getOnChangeCopyObjects (std::vector< App::DocumentObject * > *excludes=nullptr, App::DocumentObject *src=nullptr)
 
bool isLinkedToConfigurableObject () const
 
void monitorOnChangeCopyObjects (const std::vector< App::DocumentObject * > &objs)
 
bool isLinkMutated () const
 Check if the linked object is a copy on change. More...
 
static int getArrayIndex (const char *subname, const char **psubname=nullptr)
 
static bool setupCopyOnChange (App::DocumentObject *obj, App::DocumentObject *linked, std::vector< boost::signals2::scoped_connection > *copyOnChangeConns, bool checkExisting)
 
static bool isCopyOnChangeProperty (App::DocumentObject *obj, const Property &prop)
 
void parseSubName () const
 
void update (App::DocumentObject *parent, const Property *prop)
 
void checkCopyOnChange (App::DocumentObject *parent, const App::Property &prop)
 
void setupCopyOnChange (App::DocumentObject *parent, bool checkSource=false)
 
App::DocumentObject * makeCopyOnChange ()
 
void syncElementList ()
 
void detachElement (App::DocumentObject *obj)
 
void detachElements ()
 
void checkGeoElementMap (const App::DocumentObject *obj, const App::DocumentObject *linked, PyObject **pyObj, const char *postfix) const
 
void updateGroup ()
 
void slotChangedPlainGroup (const App::DocumentObject &, const App::Property &)
 

Additional Inherited Members

- Protected Member Functions inherited from App::Extension
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=nullptr)
 
- Protected Attributes inherited from App::Extension
bool m_isPythonExtension = false
 
Py::SmartPtr ExtensionPythonObject
 

Member Typedef Documentation

◆ LinkPropMap

typedef std::map<const Property*,std::pair<LinkBaseExtension*,int> > App::LinkBaseExtension::LinkPropMap

◆ PropInfoMap

typedef std::map<std::string, PropInfo> App::LinkBaseExtension::PropInfoMap

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
LinkModeNone 
LinkModeAutoDelete 
LinkModeAutoLink 
LinkModeAutoUnlink 

◆ LinkCopyOnChangeType

enum App::LinkBaseExtension::LinkCopyOnChangeType
Enumerator
CopyOnChangeDisabled 
CopyOnChangeEnabled 
CopyOnChangeOwned 
CopyOnChangeTracking 

◆ OnChangeCopyOptions

enum class App::LinkBaseExtension::OnChangeCopyOptions
strong

Options used in setOnChangeCopyObject() Multiple options can be combined by bitwise or operator.

Enumerator
Exclude 

If set, then exclude the input from object list to copy on change, or else, include the input object.

ApplyAll 

If set , then apply the setting to all links to the input object, or else, apply only to this link.

◆ PropIndex

enum App::LinkBaseExtension::PropIndex
Enumerator
PropMax 

Constructor & Destructor Documentation

◆ LinkBaseExtension()

LinkBaseExtension::LinkBaseExtension ( void  )

References App::Global, App::Prop_Hidden, App::Prop_NoPersist, App::Prop_Output, and App::Prop_ReadOnly.

◆ ~LinkBaseExtension()

LinkBaseExtension::~LinkBaseExtension ( )
virtual

Member Function Documentation

◆ cacheChildLabel()

void LinkBaseExtension::cacheChildLabel ( int  enable = -1) const

References enableLabelCache, and myLabelCache.

Referenced by getElementIndex().

◆ checkCopyOnChange()

void LinkBaseExtension::checkCopyOnChange ( App::DocumentObject *  parent,
const App::Property &  prop 
)
protected

References App::Property::Copy(), CopyOnChangeDisabled, CopyOnChangeOwned, CopyOnChangeTracking, App::DocumentObject::getDocument(), App::Property::getName(), Base::Persistence::getTypeId(), isCopyOnChangeProperty(), App::Document::isPerformingTransaction(), and makeCopyOnChange().

Referenced by update().

◆ checkGeoElementMap()

void LinkBaseExtension::checkGeoElementMap ( const App::DocumentObject *  obj,
const App::DocumentObject *  linked,
PyObject **  pyObj,
const char *  postfix 
) const
protected

References App::DocumentObject::getDocument().

Referenced by extensionGetSubObject().

◆ detachElement()

void LinkBaseExtension::detachElement ( App::DocumentObject *  obj)
protected

References getContainer(), LinkModeAutoDelete, and LinkModeAutoUnlink.

Referenced by detachElements(), and setLink().

◆ detachElements()

void LinkBaseExtension::detachElements ( )
protected

References detachElement().

Referenced by onExtendedUnsetupObject(), and setLink().

◆ elementNameFromIndex()

void LinkBaseExtension::elementNameFromIndex ( int  idx,
std::ostream &  ss 
) const

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

Referenced by elementNameFromIndex(), and expandSubname().

◆ expandSubname()

void LinkBaseExtension::expandSubname ( std::string &  subname) const

References elementNameFromIndex(), and getElementIndex().

◆ extensionExecute()

App::DocumentObjectExecReturn * LinkBaseExtension::extensionExecute ( void  )
overridevirtual

Reimplemented from App::DocumentObjectExtension.

References CopyOnChangeDisabled, CopyOnChangeTracking, App::DocumentObjectExtension::extensionExecute(), getContainer(), App::DocumentObject::getDocument(), App::Document::getObjectByID(), App::ExtensionContainer::getPropertyByName(), App::DocumentObject::getPyObject(), getTrueLinkedObject(), App::PropertyPythonObject::getValue(), hasCopyOnChange, isCopyOnChangeProperty(), props, setupCopyOnChange(), and syncCopyOnChange().

◆ extensionGetLinkedObject()

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

Get the linked object.

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

Reimplemented from App::DocumentObjectExtension.

References getContainer(), getTransform(), and getTrueLinkedObject().

◆ extensionGetPropertyByName()

Property * LinkBaseExtension::extensionGetPropertyByName ( const char *  name) const
overridevirtual

find a property by its name

Reimplemented from App::Extension.

References checkingProperty, App::Extension::extensionGetPropertyByName(), getContainer(), and getTrueLinkedObject().

◆ extensionGetSubObject()

bool LinkBaseExtension::extensionGetSubObject ( DocumentObject *&  ret,
const char *  subname,
PyObject **  pyObj = nullptr,
Base::Matrix4D *  mat = nullptr,
bool  transform = false,
int  depth = 0 
) const
overridevirtual

Get the sub object by name.

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

Reimplemented from App::DocumentObjectExtension.

References checkGeoElementMap(), DraftVecUtils::equals(), getContainer(), getElementIndex(), getScaleVector(), App::DocumentObject::getSubObject(), getTransform(), getTrueLinkedObject(), Data::ComplexGeoData::indexPostfix(), Data::ComplexGeoData::isMappedElement(), mySubElements, and Base::Matrix4D::scale().

Referenced by flattenSubname().

◆ extensionGetSubObjects()

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

Get name references of all sub objects.

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

Reimplemented from App::DocumentObjectExtension.

References App::DocumentObject::getSubObjects(), getTrueLinkedObject(), mySubElements, and App::Extension::name().

◆ extensionHasChildElement()

bool LinkBaseExtension::extensionHasChildElement ( ) const
overridevirtual

Reimplemented from App::DocumentObjectExtension.

References getTrueLinkedObject(), and App::DocumentObject::hasChildElement().

◆ extensionIsElementVisible()

int LinkBaseExtension::extensionIsElementVisible ( const char *  element)
overridevirtual

Reimplemented from App::DocumentObjectExtension.

References getArrayIndex(), getElementIndex(), getTrueLinkedObject(), and App::DocumentObject::isElementVisible().

◆ extensionMustExecute()

short LinkBaseExtension::extensionMustExecute ( void  )
overridevirtual

Reimplemented from App::DocumentObjectExtension.

References getLink().

◆ extensionOnChanged()

void LinkBaseExtension::extensionOnChanged ( const Property *  p)
overridevirtual

Reimplemented from App::Extension.

References App::Extension::extensionOnChanged(), getContainer(), App::Property::testStatus(), update(), and App::Property::User3.

◆ extensionSetElementVisible()

int LinkBaseExtension::extensionSetElementVisible ( const char *  element,
bool  visible 
)
overridevirtual

Reimplemented from App::DocumentObjectExtension.

References getArrayIndex(), getElementIndex(), getTrueLinkedObject(), myHiddenElements, App::DocumentObject::setElementVisible(), and App::Property::User3.

◆ flattenSubname()

const char * LinkBaseExtension::flattenSubname ( const char *  subname) const

References extensionGetSubObject().

◆ getArrayIndex()

int LinkBaseExtension::getArrayIndex ( const char *  subname,
const char **  psubname = nullptr 
)
static

References Data::ComplexGeoData::isMappedElement().

Referenced by extensionIsElementVisible(), extensionSetElementVisible(), getElementIndex(), Gui::ViewProviderLink::getElementPicked(), and Gui::LinkView::linkGetDetailPath().

◆ getContainer() [1/2]

DocumentObject * LinkBaseExtension::getContainer ( )

References Base::Persistence::getClassTypeId(), and App::Extension::getExtendedContainer().

Referenced by App::LinkElement::canDelete(), detachElement(), extensionExecute(), extensionGetLinkedObject(), extensionGetPropertyByName(), extensionGetSubObject(), extensionOnChanged(), getElementIndex(), getOnChangeCopyObjects(), makeCopyOnChange(), onExtendedDocumentRestored(), setLink(), setOnChangeCopyObject(), syncCopyOnChange(), syncElementList(), and update().

◆ getContainer() [2/2]

const DocumentObject * LinkBaseExtension::getContainer ( ) const

References Base::Persistence::getClassTypeId(), and App::Extension::getExtendedContainer().

◆ getElementIndex()

int LinkBaseExtension::getElementIndex ( const char *  subname,
const char **  psubname = nullptr 
) const

References cacheChildLabel(), enableLabelCache, DraftVecUtils::equals(), getArrayIndex(), getContainer(), getElementIndex(), getTrueLinkedObject(), Data::ComplexGeoData::isMappedElement(), myLabelCache, and App::Extension::name().

Referenced by expandSubname(), extensionGetSubObject(), extensionIsElementVisible(), extensionSetElementVisible(), and getElementIndex().

◆ getExtensionPyObject()

PyObject * LinkBaseExtension::getExtensionPyObject ( void  )
overridevirtual

Reimplemented from App::DocumentObjectExtension.

References App::Extension::ExtensionPythonObject.

◆ getLink()

DocumentObject * LinkBaseExtension::getLink ( int  depth = 0) const

References App::GetApplication().

Referenced by extensionMustExecute(), getTrueLinkedObject(), and TechDraw::ShapeExtractor::getXShapes().

◆ getLinkedChildren()

std::vector< App::DocumentObject * > LinkBaseExtension::getLinkedChildren ( bool  filter = true) const

Referenced by TechDraw::ShapeExtractor::getXShapes().

◆ getOnChangeCopyObjects()

std::vector< App::DocumentObject * > LinkBaseExtension::getOnChangeCopyObjects ( std::vector< App::DocumentObject * > *  excludes = nullptr,
App::DocumentObject *  src = nullptr 
)

References CopyOnChangeDisabled, App::Document::DepSort, DraftVecUtils::equals(), getContainer(), and App::Document::getDependencyList().

Referenced by makeCopyOnChange(), onExtendedDocumentRestored(), and syncCopyOnChange().

◆ getProperty() [1/2]

Property * LinkBaseExtension::getProperty ( const char *  name)

References getProperty(), and getPropertyInfoMap().

◆ getProperty() [2/2]

Property * LinkBaseExtension::getProperty ( int  idx)

Referenced by getProperty().

◆ getPropertyInfo()

const std::vector< LinkBaseExtension::PropInfo > & LinkBaseExtension::getPropertyInfo ( ) const
virtual

Referenced by getPropertyInfoMap(), and setProperty().

◆ getPropertyInfoMap()

const LinkBaseExtension::PropInfoMap & LinkBaseExtension::getPropertyInfoMap ( ) const
virtual

References getPropertyInfo().

Referenced by getProperty().

◆ getScaleVector()

Base::Vector3d LinkBaseExtension::getScaleVector ( ) const

Referenced by extensionGetSubObject(), getTransform(), and TechDraw::ShapeExtractor::getXShapes().

◆ getSubElements()

const std::vector< std::string > & App::LinkBaseExtension::getSubElements ( ) const

◆ getSubName()

const char * App::LinkBaseExtension::getSubName ( ) const

Referenced by getTrueLinkedObject().

◆ getTransform()

Base::Matrix4D LinkBaseExtension::getTransform ( bool  transform) const

References getScaleVector(), and Base::Matrix4D::scale().

Referenced by extensionGetLinkedObject(), and extensionGetSubObject().

◆ getTrueLinkedObject()

DocumentObject * LinkBaseExtension::getTrueLinkedObject ( bool  recurse,
Base::Matrix4D *  mat = nullptr,
int  depth = 0,
bool  noElement = false 
) const

References App::Extension::extensionIsDerivedFrom(), getLink(), getSubName(), and linkTransform().

Referenced by extensionExecute(), extensionGetLinkedObject(), extensionGetPropertyByName(), extensionGetSubObject(), extensionGetSubObjects(), extensionHasChildElement(), extensionIsElementVisible(), extensionSetElementVisible(), getElementIndex(), linkedPlainGroup(), and setupCopyOnChange().

◆ hasPlacement()

bool App::LinkBaseExtension::hasPlacement ( ) const

Referenced by TechDraw::ShapeExtractor::getXShapes().

◆ isCopyOnChangeProperty()

bool LinkBaseExtension::isCopyOnChangeProperty ( App::DocumentObject *  obj,
const Property &  prop 
)
static

References App::Property::getContainer(), App::Property::getGroup(), App::Property::PropDynamic, and App::Property::testStatus().

Referenced by checkCopyOnChange(), PartDesign::SubShapeBinder::checkCopyOnChange(), extensionExecute(), PartDesign::SubShapeBinder::setupCopyOnChange(), and PartDesign::SubShapeBinder::update().

◆ isLinkedToConfigurableObject()

bool LinkBaseExtension::isLinkedToConfigurableObject ( ) const

References App::Property::CopyOnChange.

◆ isLinkMutated()

bool LinkBaseExtension::isLinkMutated ( ) const

Check if the linked object is a copy on change.

References CopyOnChangeDisabled.

◆ linkedPlainGroup()

App::GroupExtension * LinkBaseExtension::linkedPlainGroup ( ) const

References getTrueLinkedObject(), and mySubElements.

Referenced by update(), and updateGroup().

◆ linkTransform()

bool LinkBaseExtension::linkTransform ( ) const

Referenced by getTrueLinkedObject().

◆ makeCopyOnChange()

App::DocumentObject * LinkBaseExtension::makeCopyOnChange ( )
protected

References App::Document::addObject(), CopyOnChangeEnabled, CopyOnChangeOwned, getContainer(), App::DocumentObject::getDocument(), getOnChangeCopyObjects(), LinkModeAutoDelete, monitorOnChangeCopyObjects(), App::PartialObject, and pauseCopyOnChange.

Referenced by checkCopyOnChange(), and setupCopyOnChange().

◆ monitorOnChangeCopyObjects()

void LinkBaseExtension::monitorOnChangeCopyObjects ( const std::vector< App::DocumentObject * > &  objs)

References CopyOnChangeDisabled, and copyOnChangeSrcConns.

Referenced by makeCopyOnChange(), onExtendedDocumentRestored(), and syncCopyOnChange().

◆ onExtendedDocumentRestored()

void LinkBaseExtension::onExtendedDocumentRestored ( )
overridevirtual

get called after a document has been fully restored

Reimplemented from App::DocumentObjectExtension.

Reimplemented in App::LinkExtension.

References CopyOnChangeDisabled, Data::ComplexGeoData::findElementName(), getContainer(), getOnChangeCopyObjects(), hasOldSubElement, monitorOnChangeCopyObjects(), draftfunctions.move::move(), myHiddenElements, mySubElements, App::DocumentObjectExtension::onExtendedDocumentRestored(), pauseCopyOnChange, and update().

◆ onExtendedUnsetupObject()

void LinkBaseExtension::onExtendedUnsetupObject ( )
overridevirtual

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

Reimplemented from App::DocumentObjectExtension.

References detachElements().

◆ parseSubName()

void LinkBaseExtension::parseSubName ( ) const
protected

References Data::ComplexGeoData::findElementName(), mySubElements, and mySubName.

Referenced by update().

◆ setLink()

void LinkBaseExtension::setLink ( int  index,
DocumentObject *  obj,
const char *  subname = nullptr,
const std::vector< std::string > &  subs = std::vector<std::string>() 
)

References App::Document::addObject(), detachElement(), detachElements(), DraftVecUtils::find(), getContainer(), App::DocumentObject::getDocument(), App::Document::getUniqueObjectName(), App::Document::isAnyRestoring(), App::DocumentObject::Label, LinkModeAutoLink, draftfunctions.move::move(), and App::PropertyString::setValue().

◆ setOnChangeCopyObject()

void LinkBaseExtension::setOnChangeCopyObject ( App::DocumentObject *  obj,
OnChangeCopyOptions  options 
)

Include or exclude object from list of objects to copy on change.

Parameters
objinput object
optionscontrol options.
See also
OnChangeCopyOptions.

References ApplyAll, Exclude, and getContainer().

◆ setProperty()

void LinkBaseExtension::setProperty ( int  idx,
Property *  prop 
)
virtual

References App::Extension::extensionGetPropertyName(), Base::Persistence::getClassTypeId(), App::Property::getContainer(), Base::Type::getName(), App::Property::getName(), getPropertyInfo(), App::Global, App::Property::Hidden, App::Property::Immutable, Base::BaseClass::isDerivedFrom(), App::Property::isValidName(), App::Property::LockDynamic, App::PropertyEnumeration::setEnums(), and App::Property::setStatus().

◆ setupCopyOnChange() [1/2]

bool LinkBaseExtension::setupCopyOnChange ( App::DocumentObject *  obj,
App::DocumentObject *  linked,
std::vector< boost::signals2::scoped_connection > *  copyOnChangeConns,
bool  checkExisting 
)
static

References App::DocumentObject::addDynamicProperty(), App::Property::CopyOnChange, copyOnChangeConns, App::Property::getGroup(), App::ExtensionContainer::getPropertyByName(), App::ExtensionContainer::getPropertyList(), props, App::DocumentObject::removeDynamicProperty(), and App::Property::User3.

Referenced by extensionExecute(), PartDesign::SubShapeBinder::setupCopyOnChange(), setupCopyOnChange(), and update().

◆ setupCopyOnChange() [2/2]

void LinkBaseExtension::setupCopyOnChange ( App::DocumentObject *  parent,
bool  checkSource = false 
)
protected

References copyOnChangeConns, CopyOnChangeDisabled, CopyOnChangeOwned, copyOnChangeSrcConns, getTrueLinkedObject(), hasCopyOnChange, makeCopyOnChange(), pauseCopyOnChange, and setupCopyOnChange().

◆ slotChangedPlainGroup()

void LinkBaseExtension::slotChangedPlainGroup ( const App::DocumentObject &  obj,
const App::Property &  prop 
)
protected

References updateGroup().

Referenced by updateGroup().

◆ syncCopyOnChange()

void LinkBaseExtension::syncCopyOnChange ( )

References App::Document::addObject(), App::Property::CopyOnChange, App::GetApplication(), getContainer(), App::DocumentObject::getDocument(), getOnChangeCopyObjects(), LinkModeAutoDelete, monitorOnChangeCopyObjects(), draftfunctions.move::move(), and pauseCopyOnChange.

Referenced by extensionExecute().

◆ syncElementList()

void LinkBaseExtension::syncElementList ( )
protected

References getContainer(), App::Property::Hidden, and App::Property::Immutable.

Referenced by update().

◆ update()

void LinkBaseExtension::update ( App::DocumentObject *  parent,
const Property *  prop 
)
protected

References App::Document::addObject(), checkCopyOnChange(), connCopyOnChangeSource, CopyOnChangeDisabled, CopyOnChangeEnabled, CopyOnChangeOwned, enableLabelCache, getContainer(), App::DocumentObject::getDocument(), App::DocumentObject::getNameInDocument(), App::Property::getType(), App::Property::Hidden, App::Document::isAnyRestoring(), App::Document::isPerformingTransaction(), linkedPlainGroup(), myHiddenElements, myLabelCache, App::Property::Output, parseSubName(), pauseCopyOnChange, App::Prop_Output, setupCopyOnChange(), syncElementList(), App::Property::testStatus(), update(), updateGroup(), and App::Property::User3.

Referenced by ArchStructure.CommandStructuralSystem::Activated(), ArchAxisSystem.AxisSystemTaskPanel::addElement(), ArchComponent.ComponentTaskPanel::addElement(), ArchSectionPlane.SectionPlaneTaskPanel::addElement(), DraftGui.FacebinderTaskPanel::addElement(), femtaskpanels.task_result_mechanical._TaskPanel::calculate(), Spreadsheet_legacy.SpreadsheetView::changeCell(), draftguitools.gui_edit.Edit::endEditing(), extensionOnChanged(), draftguitools.gui_trackers.boxTracker::height(), onExtendedDocumentRestored(), draftguitools.gui_trackers.rectangleTracker::p3(), Plot.Plot::plot(), Spreadsheet_legacy.SpreadsheetView::recompute(), ArchAxisSystem.AxisSystemTaskPanel::removeElement(), ArchComponent.ComponentTaskPanel::removeElement(), ArchSectionPlane.SectionPlaneTaskPanel::removeElement(), DraftGui.FacebinderTaskPanel::removeElement(), draftguitools.gui_trackers.gridTracker::reset(), ArchNesting.Nester::run(), draftguitools.gui_trackers.gridTracker::setMainlines(), draftguitools.gui_trackers.gridTracker::setSize(), draftguitools.gui_trackers.gridTracker::setSpacing(), update(), and draftguitools.gui_edit_arch_objects.ArchWallGuiTools::update_object_from_edit_points().

◆ updateGroup()

void LinkBaseExtension::updateGroup ( )
protected

References draftgeoutils.faces::bind(), App::DocumentObjectExtension::getExtendedObject(), App::DocumentObject::getFullName(), linkedPlainGroup(), plainGroupConns, and slotChangedPlainGroup().

Referenced by slotChangedPlainGroup(), and update().

Member Data Documentation

◆ checkingProperty

bool App::LinkBaseExtension::checkingProperty = false
mutableprotected

Referenced by extensionGetPropertyByName().

◆ connCopyOnChangeSource

boost::signals2::scoped_connection App::LinkBaseExtension::connCopyOnChangeSource
protected

Referenced by update().

◆ copyOnChangeConns

std::vector<boost::signals2::scoped_connection> App::LinkBaseExtension::copyOnChangeConns
protected

Referenced by setupCopyOnChange().

◆ copyOnChangeSrcConns

std::vector<boost::signals2::scoped_connection> App::LinkBaseExtension::copyOnChangeSrcConns
protected

Referenced by monitorOnChangeCopyObjects(), and setupCopyOnChange().

◆ enableLabelCache

bool App::LinkBaseExtension::enableLabelCache
mutableprotected

Referenced by cacheChildLabel(), getElementIndex(), and update().

◆ hasCopyOnChange

bool App::LinkBaseExtension::hasCopyOnChange
protected

Referenced by extensionExecute(), and setupCopyOnChange().

◆ hasOldSubElement

bool App::LinkBaseExtension::hasOldSubElement
protected

Referenced by onExtendedDocumentRestored().

◆ myHiddenElements

std::unordered_set<const App::DocumentObject*> App::LinkBaseExtension::myHiddenElements
protected

Referenced by extensionSetElementVisible(), onExtendedDocumentRestored(), and update().

◆ myLabelCache

std::unordered_map<std::string,int> App::LinkBaseExtension::myLabelCache
mutableprotected

Referenced by cacheChildLabel(), getElementIndex(), and update().

◆ mySubElements

std::vector<std::string> App::LinkBaseExtension::mySubElements
mutableprotected

Referenced by extensionGetSubObject(), extensionGetSubObjects(), linkedPlainGroup(), onExtendedDocumentRestored(), and parseSubName().

◆ mySubName

std::string App::LinkBaseExtension::mySubName
mutableprotected

Referenced by parseSubName().

◆ pauseCopyOnChange

bool App::LinkBaseExtension::pauseCopyOnChange = false
protected

Referenced by makeCopyOnChange(), onExtendedDocumentRestored(), setupCopyOnChange(), syncCopyOnChange(), and update().

◆ plainGroupConns

std::unordered_map<const App::DocumentObject*, boost::signals2::scoped_connection> App::LinkBaseExtension::plainGroupConns
protected

Referenced by updateGroup().

◆ prevLinkedObjectID

long App::LinkBaseExtension::prevLinkedObjectID = 0
protected

◆ props

std::vector<Property *> App::LinkBaseExtension::props
protected

Referenced by PathScripts.PathSetupSheetGui.OpTaskPanel::accept(), extensionExecute(), setupCopyOnChange(), PathScripts.PathPropertyBagGui.TaskPanel::setupUi(), and PathScripts.PathSetupSheetGui.OpTaskPanel::setupUi().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.4