App::PropertyLinkSubListChild Class Reference

The general Link Property with Child scope. More...

#include <PropertyLinks.h>

Public Member Functions

 PropertyLinkSubListChild ()
 
- Public Member Functions inherited from App::PropertyLinkSubList
void addValue (App::DocumentObject *obj, const std::vector< std::string > &SubList={}, bool reset=false)
 
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 void breakLink (App::DocumentObject *obj, bool clear) override
 Called to reset this link property. 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...
 
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 PyObjectgetPyObject (void) override
 This method returns the Python wrapper for a C++ object. More...
 
const std::string getPyReprString () const
 
const std::vector< ShadowSub > & getShadowSubs () const
 
int getSize (void) const
 
std::vector< SubSetgetSubListValues (bool newStyle=false) const
 
std::vector< std::string > getSubValues (bool newStyle) const
 
const std::vector< std::string > & getSubValues (void) const
 
DocumentObjectgetValue () const
 getValue emulates the action of a single-object link. More...
 
const std::vector< DocumentObject * > & getValues (void) const
 
virtual void onContainerRestored () override
 Called before calling DocumentObject::onDocumentRestored() More...
 
virtual void Paste (const Property &from) override
 Paste the value from the property (mainly for Undo/Redo and transactions) More...
 
 PropertyLinkSubList ()
 A constructor. More...
 
virtual bool referenceChanged () const override
 Test if the element reference has changed after restore. More...
 
int removeValue (App::DocumentObject *lValue)
 Removes all occurrences of lValue in the property together with its sub-elements and returns the number of entries removed. 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 setPyObject (PyObject *) override
 
void setSize (int newSize)
 
void setSubListValues (const std::vector< SubSet > &)
 
void setSyncSubObject (bool enable)
 
void setValue (App::DocumentObject *lValue, const std::vector< std::string > &SubList=std::vector< std::string >())
 setValue: PropertyLinkSub-compatible overload More...
 
void setValue (DocumentObject *, const char *)
 Sets the property. More...
 
void setValues (const std::vector< DocumentObject * > &, const std::vector< const char * > &)
 
void setValues (const std::vector< DocumentObject * > &, const std::vector< std::string > &, std::vector< ShadowSub > &&ShadowSubList={})
 
void setValues (std::vector< DocumentObject * > &&, std::vector< std::string > &&subs, 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...
 
bool upgrade (Base::XMLReader &reader, const char *typeName)
 
virtual ~PropertyLinkSubList ()
 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 PropertyCopyOnImportExternal (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 PropertyCopyOnLabelChange (App::DocumentObject *obj, const std::string &ref, const char *newLabel) const
 Update object label reference in this property. More...
 
virtual PropertyCopyOnLinkReplace (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 PropertyCopy (void) const =0
 Returns a new copy of the property (mainly for Undo/Redo and transactions) 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...
 
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 PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
virtual Type getTypeId () const
 
bool isDerivedFrom (const Type type) const
 
BaseClassoperator= (const BaseClass &)=default
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Additional Inherited Members

- Public Types inherited from App::PropertyLinkSubList
typedef std::pair< DocumentObject *, std::vector< std::string > > SubSet
 
- 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
}
 
- 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::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=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 ()
 
- Public Attributes inherited from App::Property
boost::signals2::signal< void(const App::Property &)> signalChanged
 
- 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...
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 
- 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...
 

Detailed Description

The general Link Property with Child scope.

Constructor & Destructor Documentation

◆ PropertyLinkSubListChild()

App::PropertyLinkSubListChild::PropertyLinkSubListChild ( )

References App::Child.


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