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=nullptr) const override
	Test if the link is restored unchanged. More...

virtual Property *	Copy (void) const override
	Returns a new copy of the property (mainly for Undo/Redo and transactions) More...

virtual Property *	CopyOnImportExternal (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 Property *	CopyOnLabelChange (App::DocumentObject obj, const std::string &ref, const char newLabel) const override
	Update object label reference in this property. More...

virtual Property *	CopyOnLinkReplace (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::Document *	getDocument () 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=nullptr, bool newStyle=true) const override
	Obtain the linked objects. More...

const char *	getObjectName () const

virtual PyObject *	getPyObject (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...

PropertyLinkBase *	parent () 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=nullptr)

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	setSyncSubObject (bool enable)

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::PropertyLink
virtual bool	adjustLink (const std::set< App::DocumentObject * > &inList) override
	Called to adjust the link to avoid potential cyclic dependency. More...

virtual void	breakLink (App::DocumentObject *obj, bool clear) override
	Called to reset this link property. More...

virtual Property *	Copy (void) const override
	Returns a new copy of the property (mainly for Undo/Redo and transactions) More...

virtual Property *	CopyOnLinkReplace (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...

virtual const char *	getEditorName (void) const override
	Get the class name of the associated property editor item. More...

virtual void	getLinks (std::vector< App::DocumentObject * > &objs, bool all=false, std::vector< std::string > *subs=nullptr, bool newStyle=true) const override
	Obtain the linked objects. More...

virtual unsigned int	getMemSize (void) const override
	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? This method is defined in Base::Persistence. More...

virtual PyObject *	getPyObject (void) override
	This method returns the Python wrapper for a C++ object. More...

App::DocumentObject *	getValue (Base::Type t) const
	Returns the link type checked. More...

App::DocumentObject *	getValue (void) const
	This method returns the linked DocumentObject. More...

template<typename _type >
_type	getValue (void) const
	Returns the link type checked. More...

virtual void	Paste (const Property &from) override
	Paste the value from the property (mainly for Undo/Redo and transactions) More...

	PropertyLink ()
	A constructor. More...

void	resetLink ()

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	setPyObject (PyObject *) override

virtual void	setValue (App::DocumentObject *)
	Sets the property. More...

virtual	~PropertyLink ()
	A destructor. More...

Public Member Functions inherited from App::PropertyLinkBase
virtual bool	adjustLink (const std::set< App::DocumentObject * > &inList)=0
	Called to adjust the link to avoid potential cyclic dependency. More...

virtual void	breakLink (App::DocumentObject *obj, bool clear)=0
	Called to reset this link property. More...

void	checkLabelReferences (const std::vector< std::string > &subs, bool reset=true)
	Check subnames for label registration. More...

virtual int	checkRestore (std::string *msg=nullptr) const
	Test if the link is restored unchanged. More...

virtual Property *	CopyOnImportExternal (const std::map< std::string, std::string > &nameMap) const
	Return a copy of the property if any changes caused by importing external linked object. More...

virtual Property *	CopyOnLabelChange (App::DocumentObject obj, const std::string &ref, const char newLabel) const
	Update object label reference in this property. More...

virtual Property *	CopyOnLinkReplace (const App::DocumentObject parent, App::DocumentObject oldObj, App::DocumentObject *newObj) const =0
	Return a copy of the property if the link replacement affects this property. 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...

virtual void	getLinks (std::vector< App::DocumentObject * > &objs, bool all=false, std::vector< std::string > *subs=nullptr, bool newStyle=true) const =0
	Obtain the linked objects. More...

virtual bool	isSame (const Property &other) const override
	Compare if this property has the same content as the given one. 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 ()

virtual bool	referenceChanged () const
	Test if the element reference has changed after restore. More...

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...

virtual void	setAllowPartial (bool enable)

bool	testFlag (int flag) const

void	unregisterElementReference ()
	Clear internal element reference registration. More...

void	unregisterLabelReferences ()
	Clear internal label references registration. More...

virtual void	updateElementReference (App::DocumentObject *feature, bool reverse=false, bool notify=false)
	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	~PropertyLinkBase ()

Public Member Functions inherited from App::Property
virtual void	aboutToSetChildValue (Property &)
	Called before a child property changing value. More...

virtual void	afterRestore ()
	Called at the beginning of Document::afterRestore() More...

virtual App::ObjectIdentifier	canonicalPath (const App::ObjectIdentifier &p) const
	Convert p to a canonical representation of it. More...

virtual Property *	Copy (void) const =0
	Returns a new copy of the property (mainly for Undo/Redo and transactions) More...

PropertyContainer *	getContainer (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...

virtual const char *	getEditorName (void) const
	Get the class name of the associated property editor item. More...

std::string	getFullName () const

const char *	getGroup (void) const
	Get the group of this property. More...

int64_t	getID () const
	Return a unique ID for the property. More...

virtual unsigned int	getMemSize (void) const override
	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? This method is defined in Base::Persistence. More...

const char *	getName (void) const
	Get the name of this property in the belonging container With hasName() it can be checked beforehand if a valid name is set. 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...

bool	hasName () const
	Check if the property has a name set. More...

virtual void	hasSetChildValue (Property &)
	Called when a child property has changed value. More...

bool	isReadOnly () const

virtual bool	isSame (const Property &other) const
	Compare if this property has the same content as the given one. More...

bool	isSinglePrecision () const
	Gets precision of properties using floating point numbers. More...

bool	isTouched (void) const
	Test if this property is touched. More...

virtual void	onContainerRestored ()
	Called before calling DocumentObject::onDocumentRestored() More...

virtual void	Paste (const Property &from)=0
	Paste the value from the property (mainly for Undo/Redo and transactions) 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 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::ScopedLink
LinkScope	getScope () const
	Get the links scope Retrieve what kind of links are allowed. More...

void	setScope (LinkScope scope)
	Set the links scope Allows to define what kind of links are allowed. More...

Static Public Member Functions
static std::map< App::Document , std::set< App::Document > >	getDocumentInList (App::Document *doc=nullptr)

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

static bool	hasXLink (const App::Document *doc)

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

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=nullptr)
	Helper function to restore label references during import. More...

static App::DocumentObject *	tryImport (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=nullptr)
	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 bool	isValidName (const char *name)
	Check if the passed name is valid. 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 ()

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=nullptr, std::vector< std::string > subs=nullptr) 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
virtual void	hasSetValue () override
	Gets called by all setValue() methods after the value has changed. More...

void	setFlag (int flag, bool value=true)

Protected Member Functions inherited from App::Property
virtual void	aboutToSetValue (void)
	Gets called by all setValue() methods before the value has changed. More...

virtual void	hasSetValue (void)
	Gets called by all setValue() methods after the value has changed. More...

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

PropertyLinkBase *	parentProp

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 , LinkSyncSubObject }

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 , Busy = 15 , CopyOnChange = 16 , UserEdit = 17 , 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 }

Public Attributes inherited from App::Property
boost::signals2::signal< void(const App::Property &)>	signalChanged

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 = `nullptr`
	)

◆ ~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

inList recursive 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 = nullptr ) const

overridevirtual

Test if the link is restored unchanged.

Parameters

msg	optional 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

obj	the object owner of the changing label
ref	subname reference to old label
newLabel	the 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

owner	the 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.
oldObj	object to be replaced
newObj	object 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()

void PropertyXLink::copyTo	(	PropertyXLink &	other,
		App::DocumentObject *	linked = `nullptr`,
		std::vector< std::string > *	subs = `nullptr`
	)		const

protected

References docInfo, docName, filePath, App::DocumentObject::getDocument(), App::Document::getName(), App::DocumentObject::getNameInDocument(), draftfunctions.move::move(), and objectName.

Referenced by Copy(), CopyOnImportExternal(), App::PropertyXLinkSubList::CopyOnImportExternal(), CopyOnLabelChange(), App::PropertyXLinkSubList::CopyOnLabelChange(), CopyOnLinkReplace(), and App::PropertyXLinkSubList::CopyOnLinkReplace().

◆ detach()

void PropertyXLink::detach ( )

protected

References aboutToSetValue(), docInfo, hasSetValue(), App::PropertyLink::resetLink(), and updateElementReference().

◆ getDocument()

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

References docInfo.

◆ getDocumentInList()

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

static

References App::Hidden, App::Property::PropNoPersist, App::Property::PropTransient, App::DocumentObject::testStatus(), and App::Property::Transient.

Referenced by Gui::Document::canClose(), and Gui::Document::detachView().

◆ getDocumentOutList()

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

static

References App::Hidden, App::Property::PropNoPersist, App::Property::PropTransient, App::DocumentObject::testStatus(), and App::Property::Transient.

Referenced by StdCmdDelete::activated(), and App::Document::getDependentDocuments().

◆ 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 = `nullptr`,
		bool	newStyle = `true`
	)		const

overridevirtual

Obtain the linked objects.

Parameters

objs	hold the returned linked objects on output
all	if true, then return all the linked object regardless of this LinkScope. If false, then return only if the LinkScope is not hidden.
sub	if given, then return subname references.
newStyle	whether 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

Referenced by App::PropertyXLinkSubList::CopyOnLinkReplace(), getLinks(), getPyObject(), and App::PropertyXLinkSub::getPyObject().

◆ 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]

bool PropertyXLink::hasXLink ( const App::Document * doc )

static

Referenced by StdCmdDuplicateSelection::activated(), App::Document::copyObject(), Gui::MainWindow::createMimeDataFromSelection(), hasXLink(), StdCmdLinkImportAll::isActive(), and App::Document::mustExecute().

◆ hasXLink() [2/2]

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

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()

PropertyLinkBase * App::PropertyXLink::parent ( ) const

Referenced by PathScripts.PathSimulatorGui.CAMSimTaskUi::accept(), CopyOnLinkReplace(), Mod.PartDesign.WizardShaft.Shaft.Shaft::equilibrium(), PathScripts.PathSimulatorGui.CAMSimTaskUi::reject(), Restore(), and PathScripts.PathOpGui.TaskPanelPage::setParent().

◆ Paste()

void PropertyXLink::Paste ( const Property & from )

overridevirtual

Paste the value from the property (mainly for Undo/Redo and transactions)

Reimplemented from App::PropertyLink.

References App::GetApplication(), Base::Persistence::getClassTypeId(), App::Application::getDocument(), Base::BaseClass::isDerivedFrom(), App::PropertyLinkBase::LinkAllowPartial, App::PropertyLinkBase::setFlag(), and setValue().

◆ 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:

void PropertyVector::Restore(Base::XMLReader &reader)
{
  // 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");
}

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

References App::DocInfo::restoreDocument().

Referenced by App::Application::openDocuments().

◆ restoreLink()

void PropertyXLink::restoreLink ( App::DocumentObject * lValue )

protected

References aboutToSetValue(), docInfo, App::Property::getContainer(), hasSetValue(), App::Hidden, App::PropertyLinkBase::LinkDetached, App::PropertyLinkBase::LinkRestoring, App::PropertyLinkBase::setFlag(), stamp, and updateElementReference().

◆ 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;
}

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()

void PropertyXLink::setAllowPartial ( bool enable )

overridevirtual

Reimplemented from App::PropertyLinkBase.

References docInfo, filePath, App::GetApplication(), App::Property::getContainer(), App::Application::isRestoring(), App::PropertyLinkBase::LinkAllowPartial, objectName, App::Application::openDocument(), App::Document::PartialDoc, and App::PropertyLinkBase::setFlag().

◆ setPyObject()

void PropertyXLink::setPyObject ( PyObject * value )

overridevirtual

Reimplemented from App::PropertyLink.

References App::PropertyString::getStrValue(), draftfunctions.move::move(), App::PropertyString::setPyObject(), and setValue().

◆ setSubName()

void PropertyXLink::setSubName ( const char * subname )

References aboutToSetValue(), hasSetValue(), draftfunctions.move::move(), and setSubValues().

◆ setSubValues()

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

References App::PropertyLinkBase::checkLabelReferences(), draftfunctions.move::move(), and updateElementReference().

Referenced by setSubName(), and setValue().

◆ setSyncSubObject()

void PropertyXLink::setSyncSubObject ( bool enable )

References App::PropertyLinkBase::LinkSyncSubObject.

◆ setValue() [1/5]

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

overridevirtual

Sets the property.

Reimplemented from App::PropertyLink.

References setValue().

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

◆ setValue() [2/5]

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

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

◆ setValue() [3/5]

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

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

◆ setValue() [4/5]

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

References aboutToSetValue(), docInfo, filePath, App::DocInfo::get(), App::Property::getContainer(), App::DocumentObject::getDocument(), App::Document::getFileName(), App::Document::getName(), App::DocumentObject::getNameInDocument(), hasSetValue(), App::Hidden, App::PropertyLinkBase::LinkDetached, draftfunctions.move::move(), objectName, App::PropertyLinkBase::setFlag(), setSubValues(), stamp, and unlink().

◆ setValue() [5/5]

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

References aboutToSetValue(), docInfo, filePath, App::DocInfo::get(), App::Property::getContainer(), App::DocumentObject::getDocument(), App::Document::getObject(), hasSetValue(), App::Hidden, App::PropertyLinkBase::LinkDetached, draftfunctions.move::move(), objectName, App::PropertyLinkBase::setFlag(), setSubValues(), setValue(), stamp, and unlink().

◆ supportXLink()

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

static

References Base::Persistence::getClassTypeId(), and Base::BaseClass::isDerivedFrom().

Referenced by Gui::Dialog::DlgPropertyLink::init().

◆ unlink()

void PropertyXLink::unlink ( )

protected

References docInfo, objectName, and App::PropertyLink::resetLink().

Referenced by setValue(), and ~PropertyXLink().

◆ 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

Reimplemented in App::PropertyXLinkSub.

References Base::Persistence::getClassTypeId(), App::Property::getName(), and App::PropertyLink::Restore().

Referenced by App::PropertyXLinkSub::upgrade().

Friends And Related Function Documentation

◆ DocInfo

friend class DocInfo

friend

◆ PropertyXLinkSubList

friend class PropertyXLinkSubList

friend

Member Data Documentation

◆ docInfo

DocInfoPtr App::PropertyXLink::docInfo

protected

Referenced by checkRestore(), copyTo(), detach(), getDocument(), getDocumentPath(), restoreLink(), Save(), setAllowPartial(), setValue(), and unlink().

◆ docName

std::string App::PropertyXLink::docName

protected

Referenced by copyTo().

◆ filePath

std::string App::PropertyXLink::filePath

protected

Referenced by checkRestore(), copyTo(), getDocumentPath(), Save(), setAllowPartial(), and setValue().

◆ objectName

std::string App::PropertyXLink::objectName

protected

Referenced by checkRestore(), copyTo(), getObjectName(), Save(), setAllowPartial(), setValue(), and unlink().

◆ parentProp

PropertyLinkBase* App::PropertyXLink::parentProp

protected

Referenced by aboutToSetValue(), and hasSetValue().

◆ stamp

std::string App::PropertyXLink::stamp

protected

Referenced by checkRestore(), Restore(), restoreLink(), and setValue().

The documentation for this class was generated from the following files:

FreeCAD/src/App/PropertyLinks.h
FreeCAD/src/App/PropertyLinks.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PropertyXLink()

◆ ~PropertyXLink()

Member Function Documentation

◆ aboutToSetValue()

◆ adjustLink()

◆ afterRestore()

◆ checkRestore()

◆ Copy()

◆ CopyOnImportExternal()

◆ CopyOnLabelChange()

◆ CopyOnLinkReplace()

◆ copyTo()

◆ detach()

◆ getDocument()

◆ getDocumentInList()

◆ getDocumentOutList()

◆ getDocumentPath()

◆ getFilePath()

◆ getLinks()

◆ getObjectName()

◆ getPyObject()

◆ getShadowSubs()

◆ getSubName()

◆ getSubValues() [1/2]

◆ getSubValues() [2/2]

◆ getSubValuesStartsWith()

◆ hasSetValue()

◆ hasSubName()

◆ hasXLink() [1/2]

◆ hasXLink() [2/2]

◆ onContainerRestored()

◆ parent()

◆ Paste()

◆ referenceChanged()

◆ Restore()

◆ restoreDocument()

◆ restoreLink()

◆ Save()

◆ setAllowPartial()

◆ setPyObject()

◆ setSubName()

◆ setSubValues()

◆ setSyncSubObject()

◆ setValue() [1/5]

◆ setValue() [2/5]

◆ setValue() [3/5]

◆ setValue() [4/5]

◆ setValue() [5/5]

◆ supportXLink()

◆ unlink()

◆ updateElementReference()

◆ upgrade()

Friends And Related Function Documentation

◆ DocInfo

◆ PropertyXLinkSubList

Member Data Documentation

◆ docInfo

◆ docName

◆ filePath

◆ objectName

◆ parentProp

◆ stamp