App::PropertyIntegerConstraint Class Reference
Constraint integer properties This property fulfills the need of a constraint integer. More...
#include <PropertyStandard.h>
Classes | |
| struct Constraints | |
| Constraint methods. More... | |
Public Member Functions | |
| const Constraints * getConstraints (void) const | |
| get the constraint struct More... | |
| virtual const char * getEditorName (void) const | |
| Get the class name of the associated property editor item. More... | |
| PropertyIntegerConstraint () | |
| Standard constructor. More... | |
| void setConstraints (const Constraints *sConstraint) | |
| setting the boundaries This sets the constraint struct. More... | |
| virtual void setPyObject (PyObject *) | |
| virtual ~PropertyIntegerConstraint () | |
| destructor More... | |
 Public Member Functions inherited from App::PropertyInteger | |
| virtual Property * Copy (void) const | |
| Returns a new copy of the property (mainly for Undo/Redo and transactions) More... | |
| virtual unsigned int getMemSize (void) const | |
| 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 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 | |
| This method returns a string representation of the property. More... | |
| virtual void Paste (const Property &from) | |
| Paste the value from the property (mainly for Undo/Redo and transactions) More... | |
| PropertyInteger () | |
| 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... | |
| virtual void setPathValue (const App::ObjectIdentifier &path, const boost::any &value) | |
| Set value of property. More... | |
| void setValue (long) | |
| Sets the property. More... | |
| virtual ~PropertyInteger () | |
| 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... | |
| 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
Constraint integer properties This property fulfills the need of a constraint integer.
It holds basically a state (integer) and a struct of boundaries. If the boundaries is not set it acts basically like an IntegerProperty and does no checking. The constraints struct can be created on the heap or build in.
Constructor & Destructor Documentation
◆ PropertyIntegerConstraint()
| PropertyIntegerConstraint::PropertyIntegerConstraint | ( | ) |
Standard constructor.
◆ ~PropertyIntegerConstraint()
|
virtual |
destructor
Member Function Documentation
◆ getConstraints()
| const PropertyIntegerConstraint::Constraints * PropertyIntegerConstraint::getConstraints | ( | void | ) | const |
get the constraint struct
◆ getEditorName()
|
virtual |
Get the class name of the associated property editor item.
Reimplemented from App::PropertyInteger.
◆ setConstraints()
| void PropertyIntegerConstraint::setConstraints | ( | const Constraints * | sConstraint | ) |
setting the boundaries This sets the constraint struct.
It can be dynamically allocated or set as a static in the class the property belongs to:
const Constraints percent = {0,100,1}
Referenced by App::FeatureTest::FeatureTest(), PartDesignGui::ViewProviderDatumCoordinateSystem::ViewProviderDatumCoordinateSystem(), and Gui::ViewProviderGeometryObject::ViewProviderGeometryObject().
◆ setPyObject()
|
virtual |
Reimplemented from App::PropertyInteger.
The documentation for this class was generated from the following files:
- src/App/PropertyStandard.h
- src/App/PropertyStandard.cpp
