Property wrapper around an Enumeration object. More...
#include <PropertyStandard.h>
Public Member Functions | |
| virtual Property * | Copy (void) const |
| Returns a new copy of the property (mainly for Undo/Redo and transactions) More... | |
| const char * | getEditorName (void) const |
| Get the class name of the associated property editor item. More... | |
| Enumeration | getEnum (void) const |
| Returns Enumeration object. More... | |
| const char ** | getEnums (void) const |
| get the pointer to the enum list More... | |
| std::vector< std::string > | getEnumVector (void) const |
| get all possible enum values as vector of strings More... | |
| virtual const boost::any | getPathValue (const App::ObjectIdentifier &) const |
| Get value of property. More... | |
| virtual PyObject * | getPyObject (void) |
| This method returns the Python wrapper for a C++ object. More... | |
| long | getValue (void) const |
| Returns current value of the enumeration as an integer. More... | |
| const char * | getValueAsString (void) const |
| get the value as string More... | |
| bool | isPartOf (const char *value) const |
| checks if a string is included in the enumeration More... | |
| bool | isValid (void) const |
| Returns true if the instance is in a usable state. More... | |
| bool | isValue (const char *value) const |
| checks if the property is set to a certain string value More... | |
| virtual void | Paste (const Property &from) |
| Paste the value from the property (mainly for Undo/Redo and transactions) More... | |
| PropertyEnumeration () | |
| Standard constructor. More... | |
| PropertyEnumeration (const Enumeration &e) | |
| Obvious constructor. More... | |
| virtual void | Restore (Base::XMLReader &reader) |
| This method is used to restore properties from an XML document. More... | |
| virtual void | Save (Base::Writer &writer) const |
| This method is used to save properties to an XML document. More... | |
| void | setEditorName (const char *name) |
| void | setEnums (const char **plEnums) |
| Enumeration methods. More... | |
| virtual void | setPathValue (const App::ObjectIdentifier &path, const boost::any &value) |
| Set value of property. More... | |
| virtual void | setPyObject (PyObject *) |
| void | setValue (const char *value) |
| set the enum by a string is slower than setValue(long). More... | |
| void | setValue (const Enumeration &source) |
| Setter using Enumeration. More... | |
| void | setValue (long) |
| set directly the enum value In DEBUG checks for boundaries. More... | |
| virtual | ~PropertyEnumeration () |
| destructor More... | |
 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... | |
| 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... | |
| 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 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... | |
| Property () | |
| void | purgeTouched (void) |
| Reset this property touched. More... | |
| void | setContainer (PropertyContainer *Father) |
| Is called by the framework to set the father (container) More... | |
| void | setReadOnly (bool readOnly) |
| Sets property editable/grayed out in property editor. More... | |
| void | setSinglePrecision (bool single) |
| Sets precision of properties using floating point numbers to single, the default is double. More... | |
| void | setStatus (Status pos, bool on) |
| void | setStatusValue (unsigned long status) |
| bool | testStatus (Status pos) const |
| void | touch () |
| Property status handling. More... | |
| virtual | ~Property () |
| Public Member Functions inherited from Base::Persistence | |
| void | dumpToStream (std::ostream &stream, int compression) |
| virtual Base::Type | getTypeId (void) const |
| virtual void | RestoreDocFile (Reader &) |
| This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More... | |
| void | restoreFromStream (std::istream &stream) |
| virtual void | SaveDocFile (Writer &) const |
| This method is used to save large amounts of data to a binary file. More... | |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. More... | |
| bool | isDerivedFrom (const Type type) const |
| virtual | ~BaseClass () |
| Destruction. More... | |
Additional Inherited Members | |
| Public Types inherited from App::Property | |
| enum | Status { Touched = 0, Immutable = 1, ReadOnly = 2, Hidden = 3, Transient = 4, MaterialEdit = 5, NoMaterialListEdit = 6, Output = 7, LockDynamic = 8, NoModify = 9, PartialTrigger = 10, NoRecompute = 11, Single = 12, Ordered = 13, EvalOnRestore = 14, PropStaticBegin = 21, PropDynamic = 21, PropNoPersist = 22, PropNoRecompute = 23, PropReadOnly = 24, PropTransient = 25, PropHidden = 26, PropOutput = 27, PropStaticEnd = 28, User1 = 28, User2 = 29, User3 = 30, User4 = 31 } |
| Static Public Member Functions inherited from App::Property | |
| static void | destroy (Property *p) |
| For safe deleting of a dynamic property. More... | |
| Static Public Member Functions inherited from Base::Persistence | |
| static void * | create (void) |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. More... | |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
| Static Public Member Functions inherited from Base::BaseClass | |
| static void * | create (void) |
| static Type | getClassTypeId (void) |
| static void | init (void) |
| Protected Member Functions 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
Property wrapper around an Enumeration object.
Constructor & Destructor Documentation
◆ PropertyEnumeration() [1/2]
| PropertyEnumeration::PropertyEnumeration | ( | ) |
Standard constructor.
◆ PropertyEnumeration() [2/2]
| PropertyEnumeration::PropertyEnumeration | ( | const Enumeration & | e | ) |
Obvious constructor.
◆ ~PropertyEnumeration()
|
virtual |
destructor
Member Function Documentation
◆ Copy()
|
virtual |
Returns a new copy of the property (mainly for Undo/Redo and transactions)
Implements App::Property.
◆ getEditorName()
|
virtual |
Get the class name of the associated property editor item.
Reimplemented from App::Property.
◆ getEnum()
| Enumeration PropertyEnumeration::getEnum | ( | void | ) | const |
Returns Enumeration object.
◆ getEnums()
| const char ** PropertyEnumeration::getEnums | ( | void | ) | const |
get the pointer to the enum list
Referenced by PartDesignGui::TaskHoleParameters::changedObject().
◆ getEnumVector()
| std::vector< std::string > PropertyEnumeration::getEnumVector | ( | void | ) | const |
get all possible enum values as vector of strings
Referenced by FemGui::TaskFemConstraintFluidBoundary::TaskFemConstraintFluidBoundary(), FemGui::TaskPostBox::updateEnumerationList(), and Gui::PropertyEditor::PropertyEnumItem::value().
◆ getPathValue()
|
virtual |
Get value of property.
Reimplemented from App::Property.
◆ getPyObject()
|
virtual |
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 Base::BaseClass.
◆ getValue()
| long PropertyEnumeration::getValue | ( | void | ) | const |
Returns current value of the enumeration as an integer.
Referenced by PartGui::TaskDlgAttacher::accept(), PartDesignGui::TaskChamferParameters::apply(), PartDesignGui::TaskHoleParameters::changedObject(), SurfaceGui::GeomFillSurface::changeFillType(), Gui::View3DInventorViewer::checkGroupOnTop(), Part::Extrusion::computeFinalParameters(), TechDrawGui::QGIViewBalloon::draw(), TechDrawGui::QGIViewDimension::drawAngle(), TechDrawGui::QGIViewDimension::drawDiameter(), TechDrawGui::QGIViewDimension::drawDistance(), Gui::ViewProviderAnnotationLabel::drawImage(), TechDrawGui::QGIViewDimension::drawRadius(), Part::RuledSurface::execute(), PartDesign::Thickness::execute(), PartDesign::Chamfer::execute(), Part::Offset::execute(), PartDesign::Pipe::execute(), Part::Offset2D::execute(), Part::Sweep::execute(), PartDesign::SubShapeBinder::execute(), Part::Thickness::execute(), Part::Helix::execute(), Gui::ViewProviderLink::finishRestoring(), Surface::GeomFillSurface::getFillingStyle(), PartDesign::ProfileBased::getSupportFace(), TechDrawGui::QGILeaderLine::makeLeaderPath(), PartDesign::Chamfer::mustExecute(), Gui::ViewProviderAnnotation::onChanged(), PartDesignGui::ViewProviderBody::onChanged(), PartDesignGui::ViewProviderBoolean::onChanged(), PartDesign::Hole::onChanged(), PartDesign::SubShapeBinder::onChanged(), PartGui::ViewProviderPartExt::onChanged(), Gui::ViewProviderDocumentObject::onChanged(), MeshGui::ViewProviderMesh::onChanged(), Gui::ViewProviderLink::onChanged(), Gui::ElementColors::Private::Private(), Attacher::AttachEnginePy::readParametersFromFeature(), TechDrawGui::QGILeaderLine::setArrows(), PartDesignGui::ViewProviderBody::setDisplayMode(), SurfaceGui::GeomFillSurface::setEditedObject(), PartDesignGui::ViewProviderDatumLine::setExtents(), PartDesignGui::ViewProviderDatumPlane::setExtents(), PartDesignGui::ViewProviderBody::setOverrideMode(), TechDrawGui::TaskLeaderLine::setUiEdit(), TechDrawGui::TaskDetail::setUiFromFeat(), PartDesign::Pipe::setupAlgorithm(), PartGui::TaskAttacher::TaskAttacher(), TechDrawGui::TaskBalloon::TaskBalloon(), PartDesignGui::TaskBooleanParameters::TaskBooleanParameters(), PartDesignGui::TaskPadParameters::TaskPadParameters(), PartDesignGui::TaskPipeOrientation::TaskPipeOrientation(), PartDesignGui::TaskPipeParameters::TaskPipeParameters(), PartDesignGui::TaskPipeScaling::TaskPipeScaling(), PartDesignGui::TaskPocketParameters::TaskPocketParameters(), TechDrawGui::TaskProjGroup::TaskProjGroup(), FemGui::TaskTetParameter::TaskTetParameter(), PartDesignGui::TaskThicknessParameters::TaskThicknessParameters(), RobotGui::TaskTrajectoryDressUpParameter::TaskTrajectoryDressUpParameter(), PartGui::ThicknessWidget::ThicknessWidget(), PartDesignGui::ViewProviderDatumLine::updateData(), PartDesignGui::ViewProviderDatumPlane::updateData(), FemGui::TaskPostBox::updateEnumerationList(), PartDesign::Chamfer::updateProperties(), TechDrawGui::TaskProjGroup::updateTask(), and Gui::PropertyEditor::PropertyEnumItem::value().
◆ getValueAsString()
| const char * PropertyEnumeration::getValueAsString | ( | void | ) | const |
get the value as string
Referenced by FemGui::TaskDlgFemConstraintFluidBoundary::accept(), TechDraw::DrawProjGroup::arrangeViewPointers(), TechDraw::DrawProjGroupItem::autoPosition(), PartDesignGui::TaskHoleParameters::changedObject(), TechDrawGui::QGIViewBalloon::draw(), TechDrawGui::QGIViewDimension::draw(), TechDraw::DrawProjGroup::dumpISO(), PartDesign::Hole::execute(), PartDesign::Boolean::execute(), TechDraw::DrawPage::getPageOrientation(), FemGui::TaskFemConstraintFluidBoundary::getTurbulenceModel(), TechDraw::DrawProjGroup::getViewIndex(), TechDrawGui::QGIProjGroup::itemChange(), PartDesignGui::ViewProviderBody::onChanged(), PartDesign::Hole::onChanged(), Fem::ConstraintTransform::onChanged(), Fem::ConstraintFluidBoundary::onChanged(), TechDrawGui::ViewProviderProjGroupItem::onDelete(), TechDraw::DrawProjGroup::purgeProjections(), TechDrawGui::TaskProjGroup::saveGroupState(), TechDrawGui::TaskSectionView::saveSectionState(), Gui::ViewProviderDocumentObject::setActiveMode(), FemGui::TaskFemConstraintFluidBoundary::TaskFemConstraintFluidBoundary(), FemGui::TaskFemConstraintHeatflux::TaskFemConstraintHeatflux(), FemGui::TaskFemConstraintTemperature::TaskFemConstraintTemperature(), FemGui::TaskFemConstraintTransform::TaskFemConstraintTransform(), TechDrawGui::TaskSectionView::TaskSectionView(), TechDraw::DrawProjGroupItem::unsetupObject(), FemGui::ViewProviderFemConstraintFluidBoundary::updateData(), FemGui::ViewProviderFemConstraintTransform::updateData(), TechDrawGui::ViewProviderProjGroupItem::updateData(), and TechDraw::DrawProjGroup::usedProjectionType().
◆ isPartOf()
| bool PropertyEnumeration::isPartOf | ( | const char * | value | ) | const |
checks if a string is included in the enumeration
◆ isValid()
| bool PropertyEnumeration::isValid | ( | void | ) | const |
Returns true if the instance is in a usable state.
Referenced by Gui::ViewProviderDocumentObject::setActiveMode().
◆ isValue()
| bool PropertyEnumeration::isValue | ( | const char * | value | ) | const |
checks if the property is set to a certain string value
Referenced by TechDraw::DrawProjGroup::arrangeViewPointers(), TechDraw::DrawView::checkScale(), TechDraw::DrawProjGroup::execute(), TechDraw::DrawViewPart::execute(), TechDraw::DrawViewDimension::execute(), TechDraw::DrawViewDimension::getDimValue(), TechDraw::DrawViewDimension::getFormatedValue(), TechDraw::DrawViewDimension::getPrefix(), TechDraw::DrawProjGroup::getViewIndex(), TechDraw::DrawViewDimension::isMultiValueSchema(), TechDraw::DrawView::onChanged(), TechDraw::DrawProjGroup::onChanged(), TechDraw::DrawViewDimension::onChanged(), TechDrawGui::TaskProjGroup::scaleManuallyChanged(), TechDrawGui::TaskProjGroup::TaskProjGroup(), and TechDrawGui::TaskProjGroup::viewToggled().
◆ Paste()
|
virtual |
Paste the value from the property (mainly for Undo/Redo and transactions)
Implements App::Property.
◆ Restore()
|
virtual |
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:
Implements Base::Persistence.
References Base::Console(), Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Base::XMLReader::hasAttribute(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), and Base::ConsoleSingleton::Warning().
Referenced by TechDraw::DrawViewBalloon::handleChangedPropertyName().
◆ Save()
|
virtual |
This method is used to save properties to an XML document.
A good example you'll find in PropertyStandard.cpp, e.g. the vector:
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
Implements Base::Persistence.
References Base::Writer::decInd(), Base::Writer::incInd(), Base::Writer::ind(), and Base::Writer::Stream().
◆ setEditorName()
| void App::PropertyEnumeration::setEditorName | ( | const char * | name | ) |
◆ setEnums()
| void PropertyEnumeration::setEnums | ( | const char ** | plEnums | ) |
Enumeration methods.
These all function as per documentation in Enumeration setting the enumaration string list The list is a NULL terminated array of pointers to a const char* string
Referenced by Gui::ViewProviderDocumentObject::attach(), PartDesign::Boolean::Boolean(), PartDesign::Chamfer::Chamfer(), Fem::ConstraintFluidBoundary::ConstraintFluidBoundary(), Fem::ConstraintHeatflux::ConstraintHeatflux(), Fem::ConstraintTemperature::ConstraintTemperature(), Fem::ConstraintTransform::ConstraintTransform(), TechDraw::DrawViewBalloon::DrawViewBalloon(), TechDraw::DrawViewDimension::DrawViewDimension(), Part::Extrusion::Extrusion(), App::FeatureTest::FeatureTest(), Surface::GeomFillSurface::GeomFillSurface(), Part::Helix::Helix(), PartDesign::Hole::onChanged(), Fem::ConstraintFluidBoundary::onChanged(), Part::RuledSurface::RuledSurface(), PartDesignGui::ViewProviderBoolean::ViewProviderBoolean(), Gui::ViewProviderLink::ViewProviderLink(), PartGui::ViewProviderPartExt::ViewProviderPartExt(), and Gui::ViewProviderDocumentObject::~ViewProviderDocumentObject().
◆ setPathValue()
|
virtual |
Set value of property.
Reimplemented from App::Property.
◆ setPyObject()
|
virtual |
Reimplemented from Base::BaseClass.
◆ setValue() [1/3]
| void PropertyEnumeration::setValue | ( | const char * | value | ) |
set the enum by a string is slower than setValue(long).
Use long if possible
Referenced by TechDrawGui::TaskBalloon::accept(), Gui::ViewProviderDocumentObject::attach(), SurfaceGui::GeomFillSurface::changeFillType(), TechDrawGui::TaskLeaderLine::commonFeatureUpdate(), Gui::ElementColors::ElementColors(), Part::Part2DObject::handleChangedPropertyType(), PartDesignGui::TaskFeaturePick::makeCopy(), Fem::ConstraintFluidBoundary::onChanged(), TechDraw::DrawViewDimension::onChanged(), TechDrawGui::TaskDetail::onScaleTypeEdit(), TechDrawGui::TaskProjGroup::projectionTypeChanged(), TechDrawGui::TaskProjGroup::restoreGroupState(), TechDrawGui::TaskSectionView::restoreSectionState(), TechDrawGui::TaskProjGroup::scaleTypeChanged(), TechDrawGui::TaskLeaderLine::updateLeaderFeature(), PartDesignGui::ViewProviderDatumCoordinateSystem::ViewProviderDatumCoordinateSystem(), Attacher::AttachEnginePy::writeParametersToFeature(), RobotGui::TaskTrajectoryDressUpParameter::writeValues(), and Gui::ElementColors::Private::~Private().
◆ setValue() [2/3]
| void PropertyEnumeration::setValue | ( | const Enumeration & | source | ) |
Setter using Enumeration.
◆ setValue() [3/3]
| void PropertyEnumeration::setValue | ( | long | value | ) |
set directly the enum value In DEBUG checks for boundaries.
Is faster than using setValue(const char*).
The documentation for this class was generated from the following files:
- src/App/PropertyStandard.h
- src/App/PropertyStandard.cpp
