App::Property Class Reference

Base class of all properties This is the father of all properties. More...

#include <Property.h>

Public Types
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 }

Public Member Functions
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...
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 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...
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 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...
virtual PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object. More...
bool	isDerivedFrom (const Type type) const
virtual void	setPyObject (PyObject *)
virtual	~BaseClass ()
	Destruction. More...

Static Public Member Functions
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 (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
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	DynamicProperty
class	PropertyContainer
struct	PropertyData

Additional Inherited Members
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

Base class of all properties This is the father of all properties.

Properties are objects which are used in the document tree to parametrize e.g. features and their graphical output. They are also used to gain access from the scripting facility. /par This abstract base class defines all methods shared by all possible properties. It is also possible to define user properties and use them in the framework...

Member Enumeration Documentation

Status

enum App::Property::Status

Enumerator
Touched
Immutable
ReadOnly
Hidden
Transient
MaterialEdit
NoMaterialListEdit
Output
LockDynamic
NoModify
PartialTrigger
NoRecompute
Single
Ordered
EvalOnRestore
PropStaticBegin
PropDynamic
PropNoPersist
PropNoRecompute
PropReadOnly
PropTransient
PropHidden
PropOutput
PropStaticEnd
User1
User2
User3
User4

Constructor & Destructor Documentation

Property()

Property::Property

(

)

~Property()

Property::~Property ( )

virtual

Member Function Documentation

aboutToSetChildValue()

virtual void App::Property::aboutToSetChildValue ( Property &  )

virtual

Called before a child property changing value.

Reimplemented in App::PropertyXLinkSubList, and App::PropertyXLinkContainer.

Referenced by App::PropertyXLink::aboutToSetValue().

aboutToSetValue()

void Property::aboutToSetValue ( void  )

protectedvirtual

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

Reimplemented in App::PropertyFileIncluded, and App::PropertyXLink.

References App::PropertyContainer::onBeforeChange().

Referenced by App::PropertyXLinkSubList::aboutToSetChildValue(), App::PropertyFileIncluded::aboutToSetValue(), App::PropertyXLink::aboutToSetValue(), App::PropertyXLinkContainer::breakLink(), App::PropertyPythonObject::Paste(), Path::PropertyTool::Paste(), Path::PropertyTooltable::Paste(), Path::PropertyPath::Paste(), Points::PropertyPointKernel::Paste(), Mesh::PropertyNormalList::Paste(), Robot::PropertyTrajectory::Paste(), Fem::PropertyPostDataObject::Paste(), Fem::PropertyFemMesh::Paste(), Part::PropertyPartShape::Paste(), Part::PropertyShapeHistory::Paste(), Mesh::PropertyCurvatureList::Paste(), Inspection::PropertyDistanceList::Paste(), Part::PropertyFilletEdges::Paste(), Mesh::PropertyMeshKernel::Paste(), App::PropertyXLinkSubList::Paste(), App::PropertyPythonObject::Restore(), Points::PropertyPointKernel::Restore(), Mesh::PropertyMeshKernel::Restore(), App::PropertyPythonObject::RestoreDocFile(), Path::PropertyPath::RestoreDocFile(), Fem::PropertyPostDataObject::RestoreDocFile(), Fem::PropertyFemMesh::RestoreDocFile(), Points::PropertyPointKernel::RestoreDocFile(), Mesh::PropertyMeshKernel::RestoreDocFile(), Mesh::PropertyMeshKernel::setPointIndices(), App::PropertyPythonObject::setPyObject(), App::PropertyPythonObject::setValue(), Spreadsheet::PropertyColumnWidths::setValue(), Spreadsheet::PropertyRowHeights::setValue(), Mesh::PropertyNormalList::setValue(), Points::PropertyPointKernel::setValue(), Path::PropertyTool::setValue(), Path::PropertyPath::setValue(), Path::PropertyTooltable::setValue(), Robot::PropertyTrajectory::setValue(), Fem::PropertyPostDataObject::setValue(), Fem::PropertyFemMesh::setValue(), Part::PropertyPartShape::setValue(), Part::PropertyShapeHistory::setValue(), Mesh::PropertyCurvatureList::setValue(), Inspection::PropertyDistanceList::setValue(), Part::PropertyFilletEdges::setValue(), Mesh::PropertyMeshKernel::setValue(), App::PropertyLink::setValue(), App::PropertyLinkSub::setValue(), App::PropertyLinkSubList::setValue(), Fem::PropertyFemMesh::setValuePtr(), Mesh::PropertyMeshKernel::setValuePtr(), Spreadsheet::PropertyColumnWidths::setValues(), Spreadsheet::PropertyRowHeights::setValues(), Mesh::PropertyNormalList::setValues(), Part::PropertyShapeHistory::setValues(), Mesh::PropertyCurvatureList::setValues(), Inspection::PropertyDistanceList::setValues(), Part::PropertyFilletEdges::setValues(), App::PropertyLinkSubList::setValues(), Points::PropertyPointKernel::startEditing(), Mesh::PropertyMeshKernel::startEditing(), Mesh::PropertyMeshKernel::swapMesh(), Fem::PropertyFemMesh::transformGeometry(), Part::PropertyPartShape::transformGeometry(), Mesh::PropertyNormalList::transformGeometry(), Points::PropertyPointKernel::transformGeometry(), Mesh::PropertyCurvatureList::transformGeometry(), and Mesh::PropertyMeshKernel::transformGeometry().

afterRestore()

virtual void App::Property::afterRestore ( )

virtual

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 in App::PropertyXLinkContainer, App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyLinkSubList, App::PropertyLinkSub, App::PropertyExpressionEngine, and Spreadsheet::PropertySheet.

canonicalPath()

ObjectIdentifier Property::canonicalPath ( const App::ObjectIdentifier &  p ) const

virtual

Convert p to a canonical representation of it.

Reimplemented in App::PropertyExpressionEngine, and Sketcher::PropertyConstraintList.

Referenced by Gui::ExpressionBinding::bind().

Copy()

Property * Property::Copy ( void  ) const

pure virtual

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

Implemented in App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyPersistentObject, App::PropertyMaterialList, App::PropertyLinkSubList, App::PropertyColorList, App::PropertyLinkSub, App::PropertyBoolList, App::PropertyStringList, App::PropertyLinkList, App::PropertyLink, App::PropertyFloatList, App::PropertyPlacementList, App::PropertyPlacement, App::PropertyIntegerList, App::PropertyVectorList, Sketcher::PropertyConstraintList, App::PropertyExpressionEngine, App::PropertyVector, Spreadsheet::PropertySheet, App::PropertyMaterial, App::PropertyColor, App::PropertyBool, App::PropertyUUID, App::PropertyString, App::PropertyFloat, App::PropertyMap, App::PropertyIntegerSet, App::PropertyPlacementLink, App::PropertyMatrix, Mesh::PropertyMeshKernel, Points::PropertyCurvatureList, Part::PropertyFilletEdges, Inspection::PropertyDistanceList, App::PropertyEnumeration, Mesh::PropertyCurvatureList, Points::PropertyNormalList, Part::PropertyShapeHistory, Part::PropertyPartShape, App::PropertyPath, Fem::PropertyFemMesh, Points::PropertyGreyValueList, Fem::PropertyPostDataObject, Robot::PropertyTrajectory, Mesh::PropertyNormalList, Points::PropertyPointKernel, Path::PropertyPath, App::PropertyFileIncluded, Path::PropertyTool, Path::PropertyTooltable, Spreadsheet::PropertyColumnWidths, Spreadsheet::PropertyRowHeights, Spreadsheet::PropertySpreadsheetQuantity, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyGeomFormatList, Part::PropertyGeometryList, App::PropertyInteger, TechDraw::PropertyCenterLineList, and App::PropertyPythonObject.

Referenced by App::TransactionObject::addOrRemoveProperty(), SketcherGui::ViewProviderCustom::onChanged(), PartGui::ViewProviderCustom::onChanged(), and App::TransactionObject::setProperty().

destroy()

void Property::destroy ( Property *  p )

static

For safe deleting of a dynamic property.

References App::PropertyCleaner::add().

Referenced by App::DynamicProperty::removeDynamicProperty().

getContainer()

PropertyContainer* App::Property::getContainer

(

void

)

const

Get a pointer to the PropertyContainer derived class the property belongs to.

Referenced by App::TransactionObject::addOrRemoveProperty(), Gui::PropertyEditor::PropertyEditor::appendProperty(), App::PropertyLink::breakLink(), App::PropertyLinkList::breakLink(), App::PropertyLinkSub::breakLink(), App::PropertyLinkSubList::breakLink(), App::PropertyXLinkSubList::breakLink(), App::PropertyXLinkContainer::breakLink(), App::PropertyExpressionEngine::canonicalPath(), App::PropertyXLinkContainer::clearDeps(), App::PropertyLinkSub::CopyOnImportExternal(), App::PropertyLinkSubList::CopyOnImportExternal(), App::PropertyXLink::CopyOnImportExternal(), App::PropertyLinkSub::CopyOnLabelChange(), App::PropertyLinkSubList::CopyOnLabelChange(), App::PropertyXLink::CopyOnLabelChange(), App::PropertyLink::CopyOnLinkReplace(), App::PropertyLinkList::CopyOnLinkReplace(), App::PropertyLinkSub::CopyOnLinkReplace(), App::PropertyLinkSubList::CopyOnLinkReplace(), App::PropertyXLink::CopyOnLinkReplace(), App::PropertyExpressionEngine::execute(), Part::PropertyPartShape::getPaths(), getPaths(), App::PropertyContainerPy::getPropertyByName(), App::PropertyLinkBase::hasSetValue(), Spreadsheet::PropertySheet::insertColumns(), Spreadsheet::PropertySheet::insertRows(), App::GeoFeatureGroupExtension::isLinkValid(), App::ObjectIdentifier::ObjectIdentifier(), PartGui::ViewProviderPartExt::onChanged(), PartGui::PropertyEnumAttacherItem::openTask(), App::DocumentObjectT::operator=(), Spreadsheet::PropertySheet::removeColumns(), Spreadsheet::PropertySheet::removeRows(), App::PropertyLink::resetLink(), App::PropertyLink::Restore(), App::PropertyLinkList::Restore(), App::PropertyLinkSub::Restore(), App::PropertyLinkSubList::Restore(), App::PropertyXLink::Restore(), Path::PropertyPath::RestoreDocFile(), Fem::PropertyPostDataObject::RestoreDocFile(), Part::PropertyPartShape::RestoreDocFile(), App::PropertyXLink::restoreLink(), App::PropertyLinkSub::Save(), App::PropertyLinkSubList::Save(), App::PropertyXLink::Save(), App::PropertyXLinkContainer::Save(), Fem::PropertyPostDataObject::SaveDocFile(), Part::PropertyPartShape::SaveDocFile(), App::PropertyLinkList::set1Value(), App::PropertyXLink::setAllowPartial(), App::TransactionObject::setProperty(), App::LinkBaseExtension::setProperty(), App::PropertyLinkList::setSize(), App::PropertyLink::setValue(), App::PropertyLinkSub::setValue(), App::PropertyLinkSubList::setValue(), App::PropertyXLink::setValue(), App::PropertyLinkList::setValues(), App::PropertyLinkSubList::setValues(), Gui::RecoveryWriter::shouldWrite(), App::PropertyXLinkContainer::updateDeps(), Spreadsheet::PropertySheet::updateElementReference(), App::PropertyLinkSubList::updateElementReference(), App::PropertyXLinkSub::upgrade(), App::PropertyXLinkSubList::upgrade(), App::PropertyLinkList::~PropertyLinkList(), App::PropertyLinkSub::~PropertyLinkSub(), and App::PropertyLinkSubList::~PropertyLinkSubList().

getDocumentation()

const char * Property::getDocumentation

(

void

)

const

Get the documentation of this property.

References App::PropertyContainer::getPropertyDocumentation().

Referenced by App::DynamicProperty::addProperty(), and Gui::PropertyEditor::PropertyItem::toolTip().

getEditorName()

virtual const char* App::Property::getEditorName ( void  ) const

virtual

Get the class name of the associated property editor item.

Reimplemented in App::PropertyXLinkSubList, App::PropertyXLinkSub, App::PropertyMaterialList, App::PropertyLinkSubList, App::PropertyLinkSub, App::PropertyStringList, App::PropertyLinkList, App::PropertyLink, App::PropertyFloatList, App::PropertyPlacement, App::PropertyIntegerList, App::PropertyVector, Sketcher::PropertyConstraintList, App::PropertyMaterial, App::PropertyColor, App::PropertyBool, App::PropertyFont, App::PropertyString, App::PropertyPrecision, App::PropertyFloatConstraint, App::PropertyFloat, App::PropertyIntegerConstraint, App::PropertyMatrix, Mesh::PropertyMeshKernel, App::PropertyEnumeration, App::PropertyDirection, App::PropertyAngle, App::PropertyPosition, App::PropertyVectorDistance, Fem::PropertyFemMesh, App::PropertyPath, App::PropertyQuantityConstraint, App::PropertyFileIncluded, App::PropertyInteger, App::PropertyQuantity, and App::PropertyFile.

Referenced by Gui::PropertyEditor::PropertyModel::appendProperty(), Gui::PropertyEditor::PropertyModel::buildUp(), and Gui::PropertyEditor::PropertyEditor::updateEditorMode().

getFullName()

std::string Property::getFullName

(

)

const

References App::PropertyContainer::getFullName().

Referenced by StdCmdExpression::copyExpressions(), Gui::ViewProviderDocumentObject::onChanged(), App::PropertyContainerPy::setCustomAttributes(), Gui::Document::slotChangedObject(), and Gui::Document::slotChangePropertyEditor().

getGroup()

const char * Property::getGroup

(

void

)

const

Get the group of this property.

References App::PropertyContainer::getPropertyGroup().

Referenced by App::DynamicProperty::addProperty(), Gui::PropertyEditor::PropertyModel::appendProperty(), Gui::PropertyEditor::PropertyModel::buildUp(), and Part::Primitive::onChanged().

getMemSize()

virtual unsigned int App::Property::getMemSize ( void  ) const

overridevirtual

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.

See also

Base::Persistence

Implements Base::Persistence.

Reimplemented in App::PropertyXLinkSubList, App::PropertyPersistentObject, App::PropertyMaterialList, App::PropertyLinkSubList, App::PropertyColorList, App::PropertyLinkSub, App::PropertyBoolList, App::PropertyStringList, App::PropertyLinkList, App::PropertyLink, App::PropertyFloatList, App::PropertyPlacementList, App::PropertyPlacement, App::PropertyIntegerList, App::PropertyVectorList, Spreadsheet::PropertySheet, Sketcher::PropertyConstraintList, App::PropertyExpressionEngine, App::PropertyVector, App::PropertyMaterial, App::PropertyColor, App::PropertyBool, App::PropertyUUID, App::PropertyString, App::PropertyFloat, App::PropertyMap, App::PropertyIntegerSet, App::PropertyMatrix, Points::PropertyCurvatureList, Mesh::PropertyMeshKernel, Part::PropertyFilletEdges, Inspection::PropertyDistanceList, Mesh::PropertyCurvatureList, Points::PropertyNormalList, Part::PropertyShapeHistory, Part::PropertyPartShape, App::PropertyPath, Fem::PropertyFemMesh, Points::PropertyGreyValueList, Fem::PropertyPostDataObject, Robot::PropertyTrajectory, Mesh::PropertyNormalList, Points::PropertyPointKernel, Path::PropertyPath, App::PropertyFileIncluded, Path::PropertyTool, Path::PropertyTooltable, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyGeomFormatList, Part::PropertyGeometryList, App::PropertyInteger, TechDraw::PropertyCenterLineList, and App::PropertyPythonObject.

Referenced by App::PropertyFileIncluded::getMemSize().

getName()

const char * Property::getName

(

void

)

const

get the name of this property in the belonging container

Referenced by App::DynamicProperty::addProperty(), Gui::PropertyEditor::PropertyModel::appendProperty(), Gui::PropertyEditor::PropertyModel::buildUp(), PartDesignGui::TaskHoleParameters::changedObject(), App::PropertyExpressionEngine::execute(), Part::PropertyPartShape::getPaths(), getPaths(), App::GeoFeaturePy::getPropertyNameOfGeometry(), TechDraw::DrawView::handleChangedPropertyType(), App::ObjectIdentifier::ObjectIdentifier(), PartGui::ViewProviderCustom::onChanged(), SketcherGui::ViewProviderCustom::onChanged(), PartDesign::Boolean::onChanged(), Gui::PropertyView::onTimer(), App::DocumentObjectT::operator=(), App::PropertyContainer::Restore(), Mesh::PropertyNormalList::Save(), Mesh::PropertyCurvatureList::Save(), Inspection::PropertyDistanceList::Save(), Part::PropertyFilletEdges::Save(), App::DocumentObjectPy::setCustomAttributes(), App::LinkBaseExtension::setProperty(), ShapeCache::slotChanged(), Spreadsheet::SheetObserver::slotChangedObject(), Gui::Document::slotChangedObject(), App::PropertyLinkBase::tryReplaceLink(), PartDesignGui::ViewProviderBody::unifyVisualProperty(), PartDesignGui::ViewProviderDatumLine::updateData(), Gui::ViewProviderVRMLObject::updateData(), PartDesignGui::ViewProviderDatumCoordinateSystem::updateData(), Gui::ViewProviderDragger::updateData(), Gui::ViewProviderAnnotation::updateData(), InspectionGui::ViewProviderInspection::updateData(), PartDesignGui::ViewProvider::updateData(), FemGui::ViewProviderFemConstraintPressure::updateData(), FemGui::ViewProviderFemPostPipeline::updateData(), FemGui::ViewProviderFemConstraintGear::updateData(), FemGui::ViewProviderFemConstraintPulley::updateData(), FemGui::ViewProviderFemConstraintForce::updateData(), FemGui::ViewProviderFemConstraintBearing::updateData(), FemGui::ViewProviderFemConstraintFixed::updateData(), FemGui::ViewProviderFemConstraintFluidBoundary::updateData(), PartDesignGui::ViewProviderDatumPlane::updateData(), FemGui::ViewProviderFemConstraintPlaneRotation::updateData(), FemGui::ViewProviderFemConstraintContact::updateData(), FemGui::ViewProviderFemConstraintHeatflux::updateData(), PartGui::ViewProviderSpline::updateData(), FemGui::ViewProviderFemConstraintDisplacement::updateData(), FemGui::ViewProviderFemConstraintTemperature::updateData(), Gui::ViewProviderInventorObject::updateData(), FemGui::ViewProviderFemConstraintTransform::updateData(), FemGui::ViewProviderFemPostFunctionProvider::updateData(), Gui::ViewProviderMeasureDistance::updateData(), PartGui::ViewProviderPartExt::updateData(), Gui::ViewProviderAnnotationLabel::updateData(), App::PropertyXLink::upgrade(), App::PropertyXLinkSub::upgrade(), App::PropertyXLinkSubList::upgrade(), and App::ObjectIdentifier::verify().

getPaths()

void Property::getPaths ( std::vector< App::ObjectIdentifier > &  paths ) const

virtual

Get valid paths for this property; used by auto completer.

Reimplemented in App::PropertyPlacement, App::PropertyVector, Sketcher::PropertyConstraintList, Part::PropertyPartShape, and Fem::PropertyPostDataObject.

References getContainer(), and getName().

getPathValue()

const boost::any Property::getPathValue ( const App::ObjectIdentifier &  path ) const

virtual

Get value of property.

Reimplemented in App::PropertyPlacement, App::PropertyVector, Sketcher::PropertyConstraintList, App::PropertyExpressionEngine, App::PropertyBool, App::PropertyString, App::PropertyFloat, App::PropertyQuantity, App::PropertyEnumeration, and App::PropertyInteger.

Referenced by App::PropertyExpressionEngine::execute(), App::PropertyVector::getPathValue(), App::PropertyPlacement::getPathValue(), App::ObjectIdentifier::getValue(), and App::PropertyExpressionEngine::setValue().

getPyPathValue()

virtual bool App::Property::getPyPathValue ( const App::ObjectIdentifier &  , Py::Object &    ) const

virtual

Get Python value of property.

Reimplemented in App::PropertyPlacement, App::PropertyVector, and Sketcher::PropertyConstraintList.

Referenced by App::ObjectIdentifier::getPyValue().

getStatus()

unsigned long App::Property::getStatus

(

)

const

return the status bits

Referenced by App::TransactionObject::addOrRemoveProperty(), App::PropertyContainerPy::setEditorMode(), and App::TransactionObject::setProperty().

getType()

short Property::getType

(

void

)

const

Get the type of the property in the container.

References Hidden, NoRecompute, Output, ReadOnly, and Transient.

Referenced by App::DynamicProperty::addProperty(), App::PropertyContainerPy::getEditorMode(), App::DynamicProperty::getPropertyType(), App::PropertyContainer::getPropertyType(), App::PropertyContainerPy::getTypeOfProperty(), Gui::PropertyView::isPropertyHidden(), Gui::LinkView::onLinkedUpdateData(), PathScripts.PathToolEdit.ToolEditor::updateToolType(), and PathScripts.PathToolEdit.ToolEditor::updateUI().

hasSetChildValue()

virtual void App::Property::hasSetChildValue ( Property &  )

virtual

Called when a child property has changed value.

Reimplemented in App::PropertyXLinkSubList, and Spreadsheet::PropertySheet.

Referenced by App::PropertyXLink::hasSetValue().

hasSetValue()

void Property::hasSetValue ( void  )

protectedvirtual

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

Reimplemented in App::PropertyXLink, App::PropertyLinkBase, Spreadsheet::PropertySheet, and App::PropertyExpressionEngine.

References App::PropertyContainer::onChanged(), StatusBits, and Touched.

Referenced by Points::PropertyPointKernel::finishEditing(), Mesh::PropertyMeshKernel::finishEditing(), App::PropertyLinkBase::hasSetValue(), App::PropertyPythonObject::Paste(), Path::PropertyTooltable::Paste(), Path::PropertyTool::Paste(), Path::PropertyPath::Paste(), Points::PropertyPointKernel::Paste(), Mesh::PropertyNormalList::Paste(), Fem::PropertyPostDataObject::Paste(), Robot::PropertyTrajectory::Paste(), Fem::PropertyFemMesh::Paste(), Part::PropertyPartShape::Paste(), Part::PropertyShapeHistory::Paste(), Mesh::PropertyCurvatureList::Paste(), Inspection::PropertyDistanceList::Paste(), Part::PropertyFilletEdges::Paste(), Mesh::PropertyMeshKernel::Paste(), App::PropertyPythonObject::Restore(), Points::PropertyPointKernel::Restore(), Mesh::PropertyMeshKernel::Restore(), App::PropertyPythonObject::RestoreDocFile(), Path::PropertyPath::RestoreDocFile(), Fem::PropertyPostDataObject::RestoreDocFile(), Fem::PropertyFemMesh::RestoreDocFile(), Points::PropertyPointKernel::RestoreDocFile(), Mesh::PropertyMeshKernel::RestoreDocFile(), Mesh::PropertyMeshKernel::setPointIndices(), App::PropertyPythonObject::setPyObject(), App::PropertyPythonObject::setValue(), Spreadsheet::PropertyColumnWidths::setValue(), Spreadsheet::PropertyRowHeights::setValue(), Mesh::PropertyNormalList::setValue(), Points::PropertyPointKernel::setValue(), Path::PropertyPath::setValue(), Path::PropertyTool::setValue(), Path::PropertyTooltable::setValue(), Fem::PropertyPostDataObject::setValue(), Robot::PropertyTrajectory::setValue(), Fem::PropertyFemMesh::setValue(), Part::PropertyPartShape::setValue(), Part::PropertyShapeHistory::setValue(), Mesh::PropertyCurvatureList::setValue(), Inspection::PropertyDistanceList::setValue(), Part::PropertyFilletEdges::setValue(), Mesh::PropertyMeshKernel::setValue(), Fem::PropertyFemMesh::setValuePtr(), Mesh::PropertyMeshKernel::setValuePtr(), Spreadsheet::PropertyColumnWidths::setValues(), Spreadsheet::PropertyRowHeights::setValues(), Mesh::PropertyNormalList::setValues(), Part::PropertyShapeHistory::setValues(), Mesh::PropertyCurvatureList::setValues(), Inspection::PropertyDistanceList::setValues(), Part::PropertyFilletEdges::setValues(), Mesh::PropertyMeshKernel::swapMesh(), Fem::PropertyFemMesh::transformGeometry(), Part::PropertyPartShape::transformGeometry(), Mesh::PropertyNormalList::transformGeometry(), Points::PropertyPointKernel::transformGeometry(), Mesh::PropertyCurvatureList::transformGeometry(), and Mesh::PropertyMeshKernel::transformGeometry().

isReadOnly()

bool App::Property::isReadOnly

(

)

const

References ReadOnly.

Referenced by Gui::ExpressionBinding::apply(), PartDesignGui::TaskHoleParameters::apply(), Gui::QuantitySpinBox::apply(), PartDesignGui::TaskHoleParameters::changedObject(), and PartDesign::Hole::onChanged().

isSinglePrecision()

bool App::Property::isSinglePrecision

(

)

const

Gets precision of properties using floating point numbers.

References Single.

isTouched()

bool App::Property::isTouched

(

void

)

const

Test if this property is touched.

Referenced by App::RangeExpression::isTouched(), Part::Boolean::mustExecute(), PartDesign::Body::mustExecute(), PartDesign::ProfileBased::mustExecute(), TechDraw::DrawViewBalloon::mustExecute(), Surface::Filling::mustExecute(), PartDesign::Hole::mustExecute(), TechDraw::DrawProjGroupItem::mustExecute(), Part::MultiCommon::mustExecute(), Part::MultiFuse::mustExecute(), Surface::Cut::mustExecute(), PartDesign::Mirrored::mustExecute(), PartDesign::MultiTransform::mustExecute(), Part::Compound::mustExecute(), PartDesign::Scaled::mustExecute(), Part::Face::mustExecute(), Part::Section::mustExecute(), Part::Circle::mustExecute(), Part::CurveNet::mustExecute(), TechDraw::DrawRichAnno::mustExecute(), Part::ImportBrep::mustExecute(), Part::ImportIges::mustExecute(), PartDesign::Fillet::mustExecute(), PartDesign::LinearPattern::mustExecute(), TechDraw::DrawViewCollection::mustExecute(), Part::Mirroring::mustExecute(), Part::RuledSurface::mustExecute(), PartDesign::PolarPattern::mustExecute(), Part::Box::mustExecute(), PartDesign::FeatureAddSub::mustExecute(), PartDesign::Loft::mustExecute(), Sketcher::SketchObjectSF::mustExecute(), Surface::Extend::mustExecute(), Surface::GeomFillSurface::mustExecute(), Surface::Sewing::mustExecute(), TechDraw::DrawView::mustExecute(), Part::Vertex::mustExecute(), PartDesign::Thickness::mustExecute(), Part::ImportStep::mustExecute(), PartDesign::Chamfer::mustExecute(), Part::Offset::mustExecute(), Part::Revolution::mustExecute(), PartDesign::Pipe::mustExecute(), Mesh::Curvature::mustExecute(), Sandbox::SandboxObject::mustExecute(), PartDesign::Boolean::mustExecute(), Part::Offset2D::mustExecute(), TechDraw::DrawLeaderLine::mustExecute(), TechDraw::DrawProjGroup::mustExecute(), Mesh::FixDefects::mustExecute(), PartDesign::Pocket::mustExecute(), PartDesign::Groove::mustExecute(), PartDesign::Revolution::mustExecute(), Part::Loft::mustExecute(), PartDesign::ShapeBinder::mustExecute(), PartDesign::Pad::mustExecute(), PartDesign::Box::mustExecute(), TechDraw::DrawViewPart::mustExecute(), Part::Extrusion::mustExecute(), TechDraw::DrawViewDimension::mustExecute(), Part::Line::mustExecute(), PartDesign::Transformed::mustExecute(), Part::Sweep::mustExecute(), Part::FilletBase::mustExecute(), Part::Plane::mustExecute(), PartDesign::Cylinder::mustExecute(), App::Origin::mustExecute(), Part::Thickness::mustExecute(), Part::Sphere::mustExecute(), PartDesign::Sphere::mustExecute(), Part::Ellipsoid::mustExecute(), Part::Cylinder::mustExecute(), PartDesign::Cone::mustExecute(), Inspection::Feature::mustExecute(), Part::Prism::mustExecute(), Part::RegularPolygon::mustExecute(), PartDesign::Ellipsoid::mustExecute(), Part::Cone::mustExecute(), PartDesign::Torus::mustExecute(), Part::Torus::mustExecute(), Part::Helix::mustExecute(), PartDesign::Prism::mustExecute(), Part::Spiral::mustExecute(), PartDesign::Wedge::mustExecute(), Part::Wedge::mustExecute(), Part::Ellipse::mustExecute(), and TechDrawGui::MDIViewPage::updateTemplate().

onContainerRestored()

virtual void App::Property::onContainerRestored ( )

virtual

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 in App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyLinkSubList, App::PropertyLinkSub, App::PropertyExpressionEngine, and Spreadsheet::PropertySheet.

Paste()

void Property::Paste ( const Property &  from )

pure virtual

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

Implemented in App::PropertyXLinkSubList, App::PropertyXLink, App::PropertyPersistentObject, App::PropertyMaterialList, App::PropertyLinkSubList, App::PropertyColorList, App::PropertyLinkSub, App::PropertyBoolList, App::PropertyStringList, App::PropertyLinkList, App::PropertyLink, App::PropertyFloatList, App::PropertyPlacementList, App::PropertyPlacement, App::PropertyIntegerList, App::PropertyVectorList, App::PropertyExpressionEngine, App::PropertyVector, App::PropertyMaterial, App::PropertyColor, App::PropertyBool, App::PropertyUUID, App::PropertyString, App::PropertyFloat, App::PropertyMap, App::PropertyIntegerSet, App::PropertyPlacementLink, App::PropertyMatrix, App::PropertyEnumeration, App::PropertyPath, App::PropertyFileIncluded, App::PropertyInteger, App::PropertyPythonObject, Sketcher::PropertyConstraintList, Mesh::PropertyMeshKernel, Points::PropertyCurvatureList, Mesh::PropertyCurvatureList, Points::PropertyNormalList, Part::PropertyPartShape, Fem::PropertyFemMesh, Points::PropertyGreyValueList, Fem::PropertyPostDataObject, Robot::PropertyTrajectory, Mesh::PropertyNormalList, Points::PropertyPointKernel, Path::PropertyPath, Path::PropertyTool, Path::PropertyTooltable, Spreadsheet::PropertyRowHeights, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyGeomFormatList, Part::PropertyGeometryList, and TechDraw::PropertyCenterLineList.

Referenced by PartDesignGui::TaskFeaturePick::makeCopy(), PartDesignGui::ViewProviderBody::unifyVisualProperty(), and Spreadsheet::Sheet::updateAlias().

purgeTouched()

void App::Property::purgeTouched

(

void

)

Reset this property touched.

Referenced by TechDraw::DrawProjGroup::addProjection(), TechDraw::DrawView::checkScale(), TechDraw::DrawProjGroupItem::execute(), TechDraw::DrawProjGroup::execute(), TechDraw::DrawViewPart::execute(), TechDraw::DrawViewBalloon::handleXYLock(), TechDraw::DrawView::handleXYLock(), TechDraw::DrawView::onChanged(), and Gui::Application::reopen().

setContainer()

void Property::setContainer

(

PropertyContainer *

Father

)

Is called by the framework to set the father (container)

Referenced by App::DynamicProperty::addDynamicProperty(), Part::Chamfer::execute(), Part::Fillet::execute(), Part::Compound::execute(), TechDraw::DrawView::handleChangedPropertyType(), Part::Part2DObject::handleChangedPropertyType(), TechDraw::DrawPage::handleChangedPropertyType(), PartGui::ViewProviderPartExt::onChanged(), App::PropertyXLinkSub::upgrade(), and App::PropertyXLinkSubList::upgrade().

setPathValue()

void Property::setPathValue ( const App::ObjectIdentifier &  path, const boost::any &  value  )

virtual

Set value of property.

Reimplemented in App::PropertyPlacement, Sketcher::PropertyConstraintList, App::PropertyBool, App::PropertyString, App::PropertyFloat, App::PropertyEnumeration, App::PropertyInteger, and App::PropertyQuantity.

Referenced by App::PropertyExpressionEngine::execute(), and App::PropertyPlacement::setPathValue().

setReadOnly()

void Property::setReadOnly

(

bool

readOnly

)

Sets property editable/grayed out in property editor.

References ReadOnly, and setStatus().

Referenced by PartDesign::Hole::onChanged(), and Part::Revolution::onChanged().

setSinglePrecision()

void App::Property::setSinglePrecision

(

bool

single

)

Sets precision of properties using floating point numbers to single, the default is double.

References Single.

setStatus()

void Property::setStatus	(	Status	pos,
		bool	on
	)

References setStatusValue(), and StatusBits.

Referenced by MeshGui::ViewProviderMesh::attach(), TechDraw::DrawViewBalloon::DrawViewBalloon(), TechDraw::DrawViewDimension::DrawViewDimension(), TechDraw::DrawViewDimExtent::DrawViewDimExtent(), TechDraw::DrawViewBalloon::handleXYLock(), TechDraw::DrawView::handleXYLock(), Gui::ViewProviderDocumentObject::hide(), Part::Box::onChanged(), TechDraw::DrawView::onChanged(), PartDesign::ProfileBased::onChanged(), Gui::ViewProviderDocumentObject::onChanged(), Part::Box::Restore(), Gui::ViewProviderLink::setElementColors(), App::LinkBaseExtension::setProperty(), setReadOnly(), Gui::ViewProviderDocumentObject::show(), Spreadsheet::Sheet::updateAlias(), MeshGui::ViewProviderMesh::updateData(), Gui::ViewProviderLink::updateDataPrivate(), PartDesign::Chamfer::updateProperties(), PartDesignGui::ViewProviderDatum::ViewProviderDatum(), Gui::ViewProviderLink::ViewProviderLink(), and Gui::ViewProviderTextDocument::ViewProviderTextDocument().

setStatusValue()

void Property::setStatusValue

(

unsigned long

status

)

References Hidden, App::PropertyContainer::onPropertyStatusChanged(), PropDynamic, PropHidden, PropNoRecompute, PropOutput, PropReadOnly, PropTransient, ReadOnly, and StatusBits.

Referenced by App::TransactionObject::applyChn(), Part::Box::Restore(), App::PropertyContainer::Restore(), App::PropertyContainerPy::setEditorMode(), and setStatus().

testStatus()

bool App::Property::testStatus

(

Status

pos

)

const

Referenced by PartDesignGui::ViewProviderBody::canDropObjects(), App::PropertyExpressionEngine::execute(), App::GeoFeatureGroupExtension::extensionOnChanged(), App::GroupExtension::extensionOnChanged(), App::LinkBaseExtension::extensionOnChanged(), App::PropertyContainerPy::getEditorMode(), TechDraw::DrawViewBalloon::handleXYLock(), TechDraw::DrawView::handleXYLock(), Gui::ViewProviderDocumentObject::hide(), Gui::PropertyView::isPropertyHidden(), Part::Box::onChanged(), Gui::ViewProviderDocumentObject::onChanged(), Gui::LinkView::onLinkedUpdateData(), Gui::PropertyView::onTimer(), Gui::ViewProviderDocumentObject::removeDynamicProperty(), App::PropertyContainerPy::setCustomAttributes(), App::DocumentObjectPy::setCustomAttributes(), Gui::ViewProviderDocumentObject::show(), Gui::Document::slotChangedObject(), App::LinkBaseExtension::update(), Gui::ViewProviderLink::updateDataPrivate(), and Gui::PropertyEditor::PropertyEditor::updateEditorMode().

touch()

void Property::touch

(

)

Property status handling.

Set the property touched

References App::PropertyContainer::onChanged(), StatusBits, and Touched.

Referenced by Sketcher::SketchObjectPy::addConstraint(), Spreadsheet::PropertySheet::afterRestore(), Gui::ViewProviderPythonFeatureImp::attach(), App::Document::Document(), Gui::ViewProviderTextDocument::doubleClicked(), Part::Fillet::execute(), Part::Chamfer::execute(), TechDraw::DrawTemplate::execute(), Part::Compound::execute(), Part::Feature::execute(), Fem::Constraint::execute(), PartGui::ViewProviderPartExt::forceUpdate(), Spreadsheet::PropertySheet::invalidateDependants(), PartDesignGui::ViewProviderBody::onChanged(), Fem::ConstraintTransform::onChanged(), Fem::ConstraintGear::onChanged(), Fem::ConstraintBearing::onChanged(), Fem::ConstraintPulley::onChanged(), TechDraw::DrawViewDimension::onChanged(), Fem::Constraint::onDocumentRestored(), App::VRMLObject::RestoreDocFile(), App::Document::saveAs(), Gui::AlignmentGroup::setAlignable(), PartGui::ViewProviderPartExt::unsetHighlightedEdges(), PartGui::ViewProviderPartExt::unsetHighlightedFaces(), PartGui::ViewProviderPartExt::unsetHighlightedPoints(), Gui::ViewProviderGeometryObject::ViewProviderGeometryObject(), and PartGui::ViewProviderPartExt::ViewProviderPartExt().

verifyPath()

void Property::verifyPath ( const App::ObjectIdentifier &  p ) const

protectedvirtual

Verify a path for the current property.

Friends And Related Function Documentation

DynamicProperty

friend class DynamicProperty

friend

PropertyContainer

friend class PropertyContainer

friend

PropertyData

friend struct PropertyData

friend

Member Data Documentation

StatusBits

std::bitset<32> App::Property::StatusBits

protected

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.

The bits and their meaning are listed below: 0 - object is marked as 'touched' 1 - object is marked as 'immutable' 2 - object is marked as 'read-only' (for property editor) 3 - object is marked as 'hidden' (for property editor)

Referenced by App::DynamicProperty::addDynamicProperty(), hasSetValue(), App::PropertyContainer::Restore(), setStatus(), setStatusValue(), and touch().

---

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

• src/App/Property.h
• src/App/Property.cpp