#include <App/PropertyStandard.h>
Detailed Description
Property wrapper around an Enumeration object.
Public Member Functions | |
| PropertyEnumeration () | |
| Standard constructor. | |
| PropertyEnumeration (const Enumeration &e) | |
| Obvious constructor. | |
| virtual | ~PropertyEnumeration () |
| destructor | |
| void | setEnums (const char **plEnums) |
| Enumeration methods. More... | |
| void | setValue (const char *value) |
| void | setValue (long) |
| void | setValue (const Enumeration &source) |
| Setter using Enumeration. | |
| long | getValue (void) const |
| Returns current value of the enumeration as an integer. | |
| bool | isValue (const char *value) const |
| checks if the property is set to a certain string value | |
| bool | isPartOf (const char *value) const |
| checks if a string is included in the enumeration | |
| const char * | getValueAsString (void) const |
| get the value as string | |
| Enumeration | getEnum (void) const |
| Returns Enumeration object. | |
| std::vector< std::string > | getEnumVector (void) const |
| get all possible enum values as vector of strings | |
| const char ** | getEnums (void) const |
| get the pointer to the enum list | |
| bool | isValid (void) const |
| Returns true if the instance is in a usable state. | |
 Public Member Functions inherited from App::Property | |
| virtual unsigned int | getMemSize (void) const |
| const char * | getName (void) const |
| get the name of this property in the belonging container | |
| short | getType (void) const |
| Get the type of the property in the container. | |
| const char * | getGroup (void) const |
| Get the group of this property. | |
| const char * | getDocumentation (void) const |
| Get the documentation of this property. | |
| void | setContainer (PropertyContainer *Father) |
| Is called by the framework to set the father (container) | |
| PropertyContainer * | getContainer (void) const |
| Get a pointer to the PropertyContainer derived class the property belongs to. | |
| virtual const App::ObjectIdentifier | canonicalPath (const App::ObjectIdentifier &p) const |
| Convert p to a canonical representation of it. | |
| virtual void | getPaths (std::vector< App::ObjectIdentifier > &paths) const |
| Get valid paths for this property; used by auto completer. | |
| void | touch () |
| Set the property touched. More... | |
| bool | isTouched (void) const |
| Test if this property is touched. | |
| void | purgeTouched (void) |
| Reset this property touched. | |
| unsigned long | getStatus () const |
| return the status bits | |
| void | setReadOnly (bool readOnly) |
| Sets property editable/grayed out in property editor. | |
| void | setSinglePrecision (bool single) |
| bool | isSinglePrecision () const |
| Gets precision of properties using floating point numbers. | |
| Public Member Functions inherited from Base::Persistence | |
| virtual void | SaveDocFile (Writer &) const |
| virtual void | RestoreDocFile (Reader &) |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. | |
| virtual | ~BaseClass () |
| Destruction. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Base::Persistence | |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. | |
| Protected Member Functions inherited from App::Property | |
| void | hasSetValue (void) |
| Gets called by all setValue() methods after the value has changed. | |
| void | aboutToSetValue (void) |
| Gets called by all setValue() methods before the value has changed. | |
| virtual void | verifyPath (const App::ObjectIdentifier &p) const |
| Verify a path for the current property. | |
| Protected Attributes inherited from App::Property | |
| std::bitset< 32 > | StatusBits |
Member Function Documentation
◆ setEnums()
| void App::PropertyEnumeration::setEnums | ( | const char ** | plEnums | ) |
Enumeration methods.
These all function as per documentation in Enumerationsetting the enumaration string list The list is a NULL terminated array of pointers to a const char* string
const char enums[] = {"Black","White","Other",NULL}
◆ setValue() [1/2]
| void App::PropertyEnumeration::setValue | ( | const char * | value | ) |
set the enum by a string is slower the setValue(long). Use long if possible
◆ setValue() [2/2]
| void App::PropertyEnumeration::setValue | ( | long | ) |
set directly the enum value In DEBUG checks for boundaries. Is faster then using setValue(const char*).
