Link to an (sub)object in the same or different document. More...

#include <PropertyLinks.h>

Public Member Functions

virtual bool adjustLink (const std::set< App::DocumentObject * > &inList) override
 Called to adjust the link to avoid potential cyclic dependency. More...
 
virtual void afterRestore () override
 Called at the beginning of Document::afterRestore() More...
 
virtual int checkRestore (std::string *msg=0) const override
 Test if the link is restored unchanged. More...
 
virtual PropertyCopy (void) const override
 Returns a new copy of the property (mainly for Undo/Redo and transactions) More...
 
virtual PropertyCopyOnImportExternal (const std::map< std::string, std::string > &nameMap) const override
 Return a copy of the property if any changes caused by importing external object. More...
 
virtual PropertyCopyOnLabelChange (App::DocumentObject *obj, const std::string &ref, const char *newLabel) const override
 Update object label reference in this property. More...
 
virtual PropertyCopyOnLinkReplace (const App::DocumentObject *parent, App::DocumentObject *oldObj, App::DocumentObject *newObj) const override
 Return a copy of the property if the link replacement affects this property. More...
 
App::DocumentgetDocument () const
 
const char * getDocumentPath () const
 
const char * getFilePath () const
 
virtual void getLinks (std::vector< App::DocumentObject * > &objs, bool all=false, std::vector< std::string > *subs=0, bool newStyle=true) const override
 Obtain the linked objects. More...
 
const char * getObjectName () const
 
virtual PyObjectgetPyObject (void) override
 This method returns the Python wrapper for a C++ object. More...
 
const std::vector< ShadowSub > & getShadowSubs () const
 
const char * getSubName (bool newStyle=true) const
 
std::vector< std::string > getSubValues (bool newStyle) const
 
const std::vector< std::string > & getSubValues (void) const
 
std::vector< std::string > getSubValuesStartsWith (const char *, bool newStyle=false) const
 
bool hasSubName () const
 
virtual void onContainerRestored () override
 Called before calling DocumentObject::onDocumentRestored() More...
 
PropertyLinkBaseparent () const
 
virtual void Paste (const Property &from) override
 Paste the value from the property (mainly for Undo/Redo and transactions) More...
 
 PropertyXLink (bool allowPartial=false, PropertyLinkBase *parent=0)
 
virtual bool referenceChanged () const override
 Test if the element reference has changed after restore. More...
 
virtual void Restore (Base::XMLReader &reader) override
 This method is used to restore properties from an XML document. More...
 
virtual void Save (Base::Writer &writer) const override
 This method is used to save properties to an XML document. More...
 
virtual void setAllowPartial (bool enable) override
 
virtual void setPyObject (PyObject *) override
 
void setSubName (const char *subname)
 
void setSubValues (std::vector< std::string > &&SubList, std::vector< ShadowSub > &&ShadowSubList={})
 
void setValue (App::DocumentObject *) override
 Sets the property. More...
 
void setValue (App::DocumentObject *, const char *subname)
 
void setValue (App::DocumentObject *, const std::vector< std::string > &SubList, std::vector< ShadowSub > &&ShadowSubList={})
 
void setValue (App::DocumentObject *, std::vector< std::string > &&SubList, std::vector< ShadowSub > &&ShadowSubList={})
 
void setValue (std::string &&filePath, std::string &&objectName, std::vector< std::string > &&SubList, std::vector< ShadowSub > &&ShadowSubList={})
 
virtual void updateElementReference (DocumentObject *feature, bool reverse=false, bool notify=false) override
 Link type property interface APIs These APIs are moved here so that any type of property can have the property link behavior, e.g. More...
 
virtual bool upgrade (Base::XMLReader &reader, const char *typeName)
 
virtual ~PropertyXLink ()
 
- Public Member Functions inherited from App::PropertyLinkGlobal
 PropertyLinkGlobal ()
 
- Public Member Functions inherited from App::PropertyLinkBase
void checkLabelReferences (const std::vector< std::string > &subs, bool reset=true)
 Check subnames for label registration. More...
 
void getLinkedElements (std::map< App::DocumentObject *, std::vector< std::string > > &elements, bool newStyle=true, bool all=true) const
 Helper function to return a map of linked object and its subname references. More...
 
template<class T >
void getLinkedObjects (T &inserter, bool all=false) const
 Helper function to return linked objects using an std::inserter. More...
 
std::map< App::DocumentObject *, std::vector< std::string > > linkedElements (bool newStyle=true, bool all=true) const
 Helper function to return a map of linked object and its subname references. More...
 
std::vector< App::DocumentObject * > linkedObjects (bool all=false) const
 Helper function to return all linked objects of this property. More...
 
 PropertyLinkBase ()
 
void registerLabelReferences (std::vector< std::string > &&labels, bool reset=true)
 Register label reference for future object relabel update. More...
 
void setAllowExternal (bool allow)
 Enable/disable temporary holding external object without throwing exception. More...
 
bool testFlag (int flag) const
 
void unregisterElementReference ()
 Clear internal element reference registration. More...
 
void unregisterLabelReferences ()
 Clear internal label references registration. More...
 
virtual ~PropertyLinkBase ()
 
- Public Member Functions inherited from App::Property
virtual void aboutToSetChildValue (Property &)
 Called before a child property changing value. More...
 
virtual App::ObjectIdentifier canonicalPath (const App::ObjectIdentifier &p) const
 Convert p to a canonical representation of it. More...
 
PropertyContainergetContainer (void) const
 Get a pointer to the PropertyContainer derived class the property belongs to. More...
 
const char * getDocumentation (void) const
 Get the documentation of this property. More...
 
std::string getFullName () const
 
const char * getGroup (void) const
 Get the group of this property. More...
 
const char * getName (void) const
 get the name of this property in the belonging container More...
 
virtual void getPaths (std::vector< App::ObjectIdentifier > &paths) const
 Get valid paths for this property; used by auto completer. More...
 
virtual const boost::any getPathValue (const App::ObjectIdentifier &path) const
 Get value of property. More...
 
virtual bool getPyPathValue (const App::ObjectIdentifier &, Py::Object &) const
 Get Python value of property. More...
 
unsigned long getStatus () const
 return the status bits More...
 
short getType (void) const
 Get the type of the property in the container. More...
 
virtual void hasSetChildValue (Property &)
 Called when a child property has changed value. More...
 
bool isReadOnly () const
 
bool isSinglePrecision () const
 Gets precision of properties using floating point numbers. More...
 
bool isTouched (void) const
 Test if this property is touched. More...
 
 Property ()
 
void purgeTouched (void)
 Reset this property touched. More...
 
void setContainer (PropertyContainer *Father)
 Is called by the framework to set the father (container) More...
 
virtual void setPathValue (const App::ObjectIdentifier &path, const boost::any &value)
 Set value of property. More...
 
void setReadOnly (bool readOnly)
 Sets property editable/grayed out in property editor. More...
 
void setSinglePrecision (bool single)
 Sets precision of properties using floating point numbers to single, the default is double. More...
 
void setStatus (Status pos, bool on)
 
void setStatusValue (unsigned long status)
 
bool testStatus (Status pos) const
 
void touch ()
 Property status handling. More...
 
virtual ~Property ()
 
- Public Member Functions inherited from Base::Persistence
void dumpToStream (std::ostream &stream, int compression)
 
virtual Base::Type getTypeId (void) const
 
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 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...
 
bool isDerivedFrom (const Type type) const
 
virtual ~BaseClass ()
 Destruction. More...
 

Static Public Member Functions

static std::map< App::Document *, std::set< App::Document * > > getDocumentInList (App::Document *doc=0)
 
static std::map< App::Document *, std::set< App::Document * > > getDocumentOutList (App::Document *doc=0)
 
static bool hasXLink (const App::Document *doc)
 
static bool hasXLink (const std::vector< App::DocumentObject * > &objs, std::vector< App::Document * > *unsaved=0)
 
static void restoreDocument (const App::Document &doc)
 
static bool supportXLink (const App::Property *prop)
 
- Static Public Member Functions inherited from App::PropertyLinkBase
static void breakLinks (App::DocumentObject *link, const std::vector< App::DocumentObject * > &objs, bool clear)
 Helper function for breaking link properties. More...
 
static const char * exportSubName (std::string &output, const App::DocumentObject *obj, const char *subname, bool first_obj=false)
 Helper function to export a subname reference. More...
 
static void getLabelReferences (std::vector< std::string > &labels, const char *subname)
 Helper function to extract labels from a subname reference. More...
 
static std::string importSubName (Base::XMLReader &reader, const char *sub, bool &restoreLabel)
 Helper function to import a subname reference. More...
 
static void restoreLabelReference (const App::DocumentObject *obj, std::string &sub, ShadowSub *shadow=0)
 Helper function to restore label references during import. More...
 
static App::DocumentObjecttryImport (const App::Document *doc, const App::DocumentObject *obj, const std::map< std::string, std::string > &nameMap)
 Helper function for link import operation. More...
 
static std::string tryImportSubName (const App::DocumentObject *obj, const char *sub, const App::Document *doc, const std::map< std::string, std::string > &nameMap)
 Helper function for link import operation. More...
 
static std::pair< App::DocumentObject *, std::string > tryReplaceLink (const App::PropertyContainer *owner, App::DocumentObject *obj, const App::DocumentObject *parent, App::DocumentObject *oldObj, App::DocumentObject *newObj, const char *sub=0)
 Helper functions. More...
 
static std::pair< App::DocumentObject *, std::vector< std::string > > tryReplaceLinkSubs (const App::PropertyContainer *owner, App::DocumentObject *obj, const App::DocumentObject *parent, App::DocumentObject *oldObj, App::DocumentObject *newObj, const std::vector< std::string > &subs)
 Helper function to check and replace a link with multiple subname references. More...
 
static void updateElementReferences (DocumentObject *feature, bool reverse=false)
 Update all element references in all link properties of feature. More...
 
static std::string updateLabelReference (const App::DocumentObject *linked, const char *subname, App::DocumentObject *obj, const std::string &ref, const char *newLabel)
 Helper function to update subname reference on label change. More...
 
static std::vector< std::pair< Property *, std::unique_ptr< Property > > > updateLabelReferences (App::DocumentObject *obj, const char *newLabel)
 Helper function to collect changed property when an object re-label. More...
 
- Static Public Member Functions inherited from App::Property
static void destroy (Property *p)
 For safe deleting of a dynamic property. 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 (void)
 
static Type getClassTypeId (void)
 
static void init (void)
 

Protected Member Functions

virtual void aboutToSetValue () override
 Gets called by all setValue() methods before the value has changed. More...
 
void copyTo (PropertyXLink &other, App::DocumentObject *linked=0, std::vector< std::string > *subs=0) const
 
void detach ()
 
virtual void hasSetValue () override
 Gets called by all setValue() methods after the value has changed. More...
 
void restoreLink (App::DocumentObject *)
 
void unlink ()
 
- Protected Member Functions inherited from App::PropertyLinkBase
void setFlag (int flag, bool value=true)
 
- Protected Member Functions inherited from App::Property
virtual void verifyPath (const App::ObjectIdentifier &p) const
 Verify a path for the current property. More...
 

Protected Attributes

DocInfoPtr docInfo
 
std::string docName
 
std::string filePath
 
std::string objectName
 
PropertyLinkBaseparentProp
 
std::string stamp
 
- Protected Attributes inherited from App::Property
std::bitset< 32 > StatusBits
 Status bits of the property 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...
 

Friends

class DocInfo
 
class PropertyXLinkSubList
 

Additional Inherited Members

- Public Types inherited from App::PropertyLinkBase
enum  LinkFlags {
  LinkAllowExternal , LinkDetached , LinkRestoring , LinkAllowPartial ,
  LinkRestoreLabel
}
 
typedef std::pair< std::string, std::string > ShadowSub
 
- Public Types inherited from App::Property
enum  Status {
  Touched = 0 , Immutable = 1 , ReadOnly = 2 , Hidden = 3 ,
  Transient = 4 , MaterialEdit = 5 , NoMaterialListEdit = 6 , Output = 7 ,
  LockDynamic = 8 , NoModify = 9 , PartialTrigger = 10 , NoRecompute = 11 ,
  Single = 12 , Ordered = 13 , EvalOnRestore = 14 , PropStaticBegin = 21 ,
  PropDynamic = 21 , PropNoPersist = 22 , PropNoRecompute = 23 , PropReadOnly = 24 ,
  PropTransient = 25 , PropHidden = 26 , PropOutput = 27 , PropStaticEnd = 28 ,
  User1 = 28 , User2 = 29 , User3 = 30 , User4 = 31
}
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 

Detailed Description

Link to an (sub)object in the same or different document.

Constructor & Destructor Documentation

◆ PropertyXLink()

PropertyXLink::PropertyXLink ( bool  allowPartial = false,
PropertyLinkBase parent = 0 
)

◆ ~PropertyXLink()

PropertyXLink::~PropertyXLink ( )
virtual

References unlink().

Member Function Documentation

◆ aboutToSetValue()

void PropertyXLink::aboutToSetValue ( void  )
overrideprotectedvirtual

Gets called by all setValue() methods before the value has changed.

Reimplemented from App::Property.

References App::Property::aboutToSetChildValue(), App::Property::aboutToSetValue(), and parentProp.

Referenced by detach(), restoreLink(), setSubName(), and setValue().

◆ adjustLink()

bool PropertyXLink::adjustLink ( const std::set< App::DocumentObject * > &  inList)
overridevirtual

Called to adjust the link to avoid potential cyclic dependency.

Parameters
inListrecursive in-list of the would-be parent
Returns
Return whether the link has been adjusted

This function tries to correct the link to avoid any (sub)object inside in-list. If the adjustment is impossible, exception will be raised

Reimplemented from App::PropertyLink.

References App::Hidden, draftfunctions.move::move(), and setValue().

◆ afterRestore()

void PropertyXLink::afterRestore ( )
overridevirtual

Called at the beginning of Document::afterRestore()

This function is called without dependency sorting, because some types of link property can only reconstructs the linking information inside this function.

One example use case of this function is PropertyLinkSub that uses afterRestore() to parse and restore subname references, which may contain sub-object reference from external document, and there will be special mapping required during object import.

Another example is PropertyExpressionEngine which only parse the restored expression in afterRestore(). The reason, in addition to subname mapping like PropertyLinkSub, is that it can handle document name adjustment as well. It internally relies on PropertyXLink to store the external document path for external linking. When the external document is restored, its internal name may change due to name conflict with existing documents. PropertyExpressionEngine can now auto adjust external references without any problem.

Reimplemented from App::Property.

References App::PropertyLinkBase::LinkRestoreLabel, App::PropertyLinkBase::restoreLabelReference(), App::PropertyLinkBase::setFlag(), and App::PropertyLinkBase::testFlag().

◆ checkRestore()

int PropertyXLink::checkRestore ( std::string *  msg = 0) const
overridevirtual

Test if the link is restored unchanged.

Parameters
msgoptional error message
Returns
For external linked object, return 2 in case the link is missing, and 1 if the time stamp has changed.

Reimplemented from App::PropertyLinkBase.

References docInfo, filePath, App::PropertyLinkBase::LinkAllowPartial, objectName, App::Document::PartialDoc, stamp, and App::PropertyLinkBase::testFlag().

◆ Copy()

Property * PropertyXLink::Copy ( void  ) const
overridevirtual

Returns a new copy of the property (mainly for Undo/Redo and transactions)

Reimplemented from App::PropertyLink.

References copyTo().

◆ CopyOnImportExternal()

Property * PropertyXLink::CopyOnImportExternal ( const std::map< std::string, std::string > &  nameMap) const
overridevirtual

Return a copy of the property if any changes caused by importing external object.

Reimplemented from App::PropertyLinkBase.

References copyTo(), App::Property::getContainer(), App::PropertyLinkBase::tryImport(), and App::PropertyLinkBase::tryImportSubName().

◆ CopyOnLabelChange()

Property * PropertyXLink::CopyOnLabelChange ( App::DocumentObject obj,
const std::string &  ref,
const char *  newLabel 
) const
overridevirtual

Update object label reference in this property.

Parameters
objthe object owner of the changing label
refsubname reference to old label
newLabelthe future new label
Returns
Returns a copy of the property if its link reference is affected. The copy will later be assgiend to this property by calling its Paste().

Reimplemented from App::PropertyLinkBase.

References copyTo(), App::Property::getContainer(), and App::PropertyLinkBase::updateLabelReference().

◆ CopyOnLinkReplace()

Property * PropertyXLink::CopyOnLinkReplace ( const App::DocumentObject parent,
App::DocumentObject oldObj,
App::DocumentObject newObj 
) const
overridevirtual

Return a copy of the property if the link replacement affects this property.

Parameters
ownerthe parent object whose link property is to be replace. Note that The parent may not be the container of this property. Link sub property can use this opportunity to adjust its relative links.
oldObjobject to be replaced
newObjobject to replace with
Returns
Return a copy of the property that is adjusted for the link replacement operation.

Reimplemented from App::PropertyLink.

References copyTo(), App::Property::getContainer(), parent(), and App::PropertyLinkBase::tryReplaceLinkSubs().

◆ copyTo()

◆ detach()

void PropertyXLink::detach ( )
protected

◆ getDocument()

App::Document * PropertyXLink::getDocument ( void  ) const

References docInfo.

◆ getDocumentInList()

std::map< App::Document *, std::set< App::Document * > > PropertyXLink::getDocumentInList ( App::Document doc = 0)
static

◆ getDocumentOutList()

std::map< App::Document *, std::set< App::Document * > > PropertyXLink::getDocumentOutList ( App::Document doc = 0)
static

◆ getDocumentPath()

const char * PropertyXLink::getDocumentPath ( ) const

References docInfo, and filePath.

◆ getFilePath()

const char* App::PropertyXLink::getFilePath ( ) const

◆ getLinks()

void PropertyXLink::getLinks ( std::vector< App::DocumentObject * > &  objs,
bool  all = false,
std::vector< std::string > *  subs = 0,
bool  newStyle = true 
) const
overridevirtual

Obtain the linked objects.

Parameters
objshold the returned linked objects on output
allif true, then return all the linked object regardless of this LinkScope. If false, then return only if the LinkScope is not hidden.
subif given, then return subname references.
newStylewhether to return new or old style subname reference

Reimplemented from App::PropertyLink.

References getSubValues(), and App::Hidden.

◆ getObjectName()

const char * PropertyXLink::getObjectName ( ) const

References objectName.

◆ getPyObject()

PyObject * PropertyXLink::getPyObject ( void  )
overridevirtual

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from App::PropertyLink.

Reimplemented in App::PropertyXLinkSub.

References App::PropertyString::getPyObject(), getSubValues(), and App::PropertyString::setValue().

◆ getShadowSubs()

const std::vector<ShadowSub >& App::PropertyXLink::getShadowSubs ( ) const

◆ getSubName()

const char * PropertyXLink::getSubName ( bool  newStyle = true) const

◆ getSubValues() [1/2]

std::vector< std::string > PropertyXLink::getSubValues ( bool  newStyle) const

◆ getSubValues() [2/2]

const std::vector<std::string>& App::PropertyXLink::getSubValues ( void  ) const

◆ getSubValuesStartsWith()

std::vector< std::string > PropertyXLink::getSubValuesStartsWith ( const char *  starter,
bool  newStyle = false 
) const

◆ hasSetValue()

void PropertyXLink::hasSetValue ( void  )
overrideprotectedvirtual

Gets called by all setValue() methods after the value has changed.

Reimplemented from App::PropertyLinkBase.

References App::Property::hasSetChildValue(), App::PropertyLinkBase::hasSetValue(), and parentProp.

Referenced by detach(), restoreLink(), setSubName(), setValue(), and updateElementReference().

◆ hasSubName()

bool App::PropertyXLink::hasSubName ( ) const

◆ hasXLink() [1/2]

◆ hasXLink() [2/2]

bool PropertyXLink::hasXLink ( const std::vector< App::DocumentObject * > &  objs,
std::vector< App::Document * > *  unsaved = 0 
)
static

References hasXLink().

◆ onContainerRestored()

void PropertyXLink::onContainerRestored ( )
overridevirtual

Called before calling DocumentObject::onDocumentRestored()

This function is called after finished calling Property::afterRestore() of all properties of objects. By then, the object dependency information is assumed ready. So, unlike Property::afterRestore(), this function is called on objects with dependency order.

Reimplemented from App::Property.

◆ parent()

◆ Paste()

void PropertyXLink::Paste ( const Property from)
overridevirtual

◆ referenceChanged()

bool PropertyXLink::referenceChanged ( ) const
overridevirtual

Test if the element reference has changed after restore.

Reimplemented from App::PropertyLinkBase.

◆ Restore()

void PropertyXLink::Restore ( Base::XMLReader )
overridevirtual

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

{
// read my Element
reader.readElement("PropertyVector");
// get the value of my Attribute
_cVec.x = reader.getAttributeAsFloat("valueX");
_cVec.y = reader.getAttributeAsFloat("valueY");
_cVec.z = reader.getAttributeAsFloat("valueZ");
}
virtual void Restore(Base::XMLReader &reader) override
This method is used to restore properties from an XML document.
Definition: PropertyGeo.cpp:170
The XML reader class This is an important helper class for the store and retrieval system of objects ...
Definition: Reader.h:118
void readElement(const char *ElementName=0)
read until a start element is found (<name>) or start-end element (<name/>) (with special name if giv...
Definition: Reader.cpp:240
double getAttributeAsFloat(const char *AttrName) const
return the named attribute as a double floating point (does type checking)
Definition: Reader.cpp:158

Reimplemented from App::PropertyLink.

References Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Base::Persistence::getClassTypeId(), App::Property::getContainer(), Base::XMLReader::getName(), App::Document::getObject(), Base::Persistence::getTypeId(), Base::XMLReader::hasAttribute(), App::PropertyLinkBase::importSubName(), Base::BaseClass::isDerivedFrom(), Base::XMLReader::isVerbose(), App::PropertyLinkBase::LinkAllowPartial, App::PropertyLinkBase::LinkRestoreLabel, draftfunctions.move::move(), parent(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), App::PropertyLinkBase::setFlag(), setValue(), and stamp.

◆ restoreDocument()

void PropertyXLink::restoreDocument ( const App::Document doc)
static

◆ restoreLink()

◆ Save()

void PropertyXLink::Save ( Base::Writer ) const
overridevirtual

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector:

void PropertyVector::Save (Writer &writer) const
{
writer << writer.ind() << "<PropertyVector valueX=\"" << _cVec.x <<
"\" valueY=\"" << _cVec.y <<
"\" valueZ=\"" << _cVec.z <<"\"/>" << endl;
}
virtual void Save(Base::Writer &writer) const override
This method is used to save properties to an XML document.
Definition: PropertyGeo.cpp:165

The writer.ind() expression writes the indentation, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.

See also
Base::Writer

Reimplemented from App::PropertyLink.

References Base::Writer::decInd(), docInfo, Base::Persistence::encodeAttribute(), App::PropertyLinkBase::exportSubName(), filePath, App::Property::getContainer(), App::DocInfo::getDocPath(), Base::Writer::incInd(), Base::Writer::ind(), App::PropertyLinkBase::LinkAllowPartial, objectName, Base::Writer::Stream(), and App::PropertyLinkBase::testFlag().

◆ setAllowPartial()

◆ setPyObject()

◆ setSubName()

void PropertyXLink::setSubName ( const char *  subname)

◆ setSubValues()

void PropertyXLink::setSubValues ( std::vector< std::string > &&  SubList,
std::vector< ShadowSub > &&  ShadowSubList = {} 
)

◆ setValue() [1/5]

void PropertyXLink::setValue ( App::DocumentObject lValue)
overridevirtual

Sets the property.

Reimplemented from App::PropertyLink.

Referenced by adjustLink(), Paste(), Restore(), setPyObject(), setValue(), and App::PropertyXLinkSub::upgrade().

◆ setValue() [2/5]

void PropertyXLink::setValue ( App::DocumentObject lValue,
const char *  subname 
)

◆ setValue() [3/5]

void PropertyXLink::setValue ( App::DocumentObject link,
const std::vector< std::string > &  SubList,
std::vector< ShadowSub > &&  ShadowSubList = {} 
)

◆ setValue() [4/5]

◆ setValue() [5/5]

void PropertyXLink::setValue ( std::string &&  filePath,
std::string &&  objectName,
std::vector< std::string > &&  SubList,
std::vector< ShadowSub > &&  ShadowSubList = {} 
)

◆ supportXLink()

bool PropertyXLink::supportXLink ( const App::Property prop)
static

◆ unlink()

void PropertyXLink::unlink ( )
protected

◆ updateElementReference()

void PropertyXLink::updateElementReference ( DocumentObject feature,
bool  reverse = false,
bool  notify = false 
)
overridevirtual

Link type property interface APIs These APIs are moved here so that any type of property can have the property link behavior, e.g.

the PropertyExpressionEngine Called to update the element reference of this link property

See also
_updateElementReference()

Reimplemented from App::PropertyLinkBase.

References hasSetValue(), and femsolver.signal::notify().

Referenced by detach(), restoreLink(), and setSubValues().

◆ upgrade()

bool PropertyXLink::upgrade ( Base::XMLReader reader,
const char *  typeName 
)
virtual

Friends And Related Function Documentation

◆ DocInfo

friend class DocInfo
friend

◆ PropertyXLinkSubList

friend class PropertyXLinkSubList
friend

Member Data Documentation

◆ docInfo

◆ docName

std::string App::PropertyXLink::docName
protected

Referenced by copyTo().

◆ filePath

std::string App::PropertyXLink::filePath
protected

◆ objectName

std::string App::PropertyXLink::objectName
protected

◆ parentProp

PropertyLinkBase* App::PropertyXLink::parentProp
protected

Referenced by aboutToSetValue(), and hasSetValue().

◆ stamp

std::string App::PropertyXLink::stamp
protected

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