 |
Inviwo
0.9.10.1
Inviwo documentation
|
|
Inviwo
0.9.10.1
Inviwo documentation
|
The StringProperty holds a string as value. More...
#include <stringproperty.h>
Inheritance diagram for inviwo::StringProperty:Public Member Functions | |
| virtual std::string | getClassIdentifier () const override |
| StringProperty (std::string identifier, std::string displayName, std::string value="", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default) | |
| Constructor for the StringProperty The PropertySemantics can be set to Editor. Then a TextEditorWidget will be used instead of a StringPropertyWidget. | |
| StringProperty (const StringProperty &rhs) | |
| StringProperty & | operator= (const std::string &value) |
| virtual StringProperty * | clone () const override |
| virtual Document | getDescription () const override |
| Public Member Functions inherited from inviwo::TemplateProperty< std::string > | |
| TemplateProperty (const std::string &identifier, const std::string &displayName, const std::string &value=std::string(), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default) | |
| TemplateProperty< std::string > & | operator= (const std::string &value) |
| virtual | operator std::string & () |
| virtual | operator const std::string & () const |
| virtual std::string & | get () |
| virtual const std::string & | get () const |
| const std::string & | operator * () const |
| std::string & | operator * () |
| const std::string * | operator-> () const |
| std::string * | operator-> () |
| virtual void | set (const std::string &value) |
| void | set (const TemplateProperty< std::string > *srcProperty) |
| virtual void | set (const Property *srcProperty) override |
| virtual TemplateProperty & | setCurrentStateAsDefault () override |
| virtual TemplateProperty & | resetToDefaultState () override |
| virtual void | serialize (Serializer &s) const override |
| virtual void | deserialize (Deserializer &d) override |
| Public Member Functions inherited from inviwo::Property | |
| Property (const std::string &identifier="", const std::string &displayName="", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default) | |
| virtual | ~Property () |
| Removes itself from its PropertyOwner. | |
| virtual Property & | setIdentifier (const std::string &identifier) |
| virtual std::string | getIdentifier () const |
| virtual std::vector< std::string > | getPath () const |
| virtual Property & | setDisplayName (const std::string &displayName) |
| A property's name displayed to the user. | |
| virtual std::string | getDisplayName () const |
| virtual std::string | getClassIdentifierForWidget () const |
| Returns which property's widget should be used when the WidgetFactory tries to create a widget. Defaults to getClassIdentifier(), should only be overridden if a subclass want to reuse another property's widget. | |
| virtual Property & | setSemantics (const PropertySemantics &semantics) |
| virtual PropertySemantics | getSemantics () const |
| virtual Property & | setReadOnly (bool value) |
| Enable or disable editing of property. | |
| virtual bool | getReadOnly () const |
| virtual Property & | setInvalidationLevel (InvalidationLevel invalidationLevel) |
| virtual InvalidationLevel | getInvalidationLevel () const |
| virtual void | setOwner (PropertyOwner *owner) |
| PropertyOwner * | getOwner () |
| const PropertyOwner * | getOwner () const |
| void | registerWidget (PropertyWidget *propertyWidget) |
| void | deregisterWidget (PropertyWidget *propertyWidget) |
| const std::vector< PropertyWidget * > & | getWidgets () const |
| void | setInitiatingWidget (PropertyWidget *propertyWidget) |
| void | clearInitiatingWidget () |
| bool | hasWidgets () const |
| virtual Property & | propertyModified () |
| virtual void | setValid () |
| virtual Property & | setModified () |
| virtual bool | isModified () const |
| std::shared_ptr< std::function< void()> > | onChangeScoped (std::function< void()> callback) |
| const BaseCallBack * | onChange (std::function< void()> callback) |
| void | removeOnChange (const BaseCallBack *callback) |
| template<typename T > | |
| const BaseCallBack * | onChange (T *object, void(T::*method)()) |
| template<typename T > | |
| void | removeOnChange (T *object) |
| virtual Property & | setUsageMode (UsageMode usageMode) |
| virtual UsageMode | getUsageMode () const |
| virtual void | setSerializationMode (PropertySerializationMode mode) |
| virtual PropertySerializationMode | getSerializationMode () const |
| virtual Property & | setVisible (bool val) |
| virtual bool | getVisible () const |
| template<typename P , typename DecisionFunc > | |
| Property & | visibilityDependsOn (P &prop, DecisionFunc callback) |
| template<typename P , typename DecisionFunc > | |
| Property & | readonlyDependsOn (P &prop, DecisionFunc callback) |
| template<typename P > | |
| Property & | autoLinkToProperty (const std::string &propertyPath) |
| const std::vector< std::pair< std::string, std::string > > & | getAutoLinkToProperty () const |
| Public Member Functions inherited from inviwo::Observable< PropertyObserver > | |
| Observable (const Observable< PropertyObserver > &other) | |
| Observable (Observable< PropertyObserver > &&other) | |
| Observable< PropertyObserver > & | operator= (const Observable< PropertyObserver > &other) |
| Observable< PropertyObserver > & | operator= (Observable< PropertyObserver > &&other) |
| void | addObserver (PropertyObserver *observer) |
| void | removeObserver (PropertyObserver *observer) |
| virtual void | startBlockingNotifications () override final |
| virtual void | stopBlockingNotifications () override final |
| Public Member Functions inherited from inviwo::MetaDataOwner | |
| MetaDataOwner (const MetaDataOwner &rhs)=default | |
| MetaDataOwner & | operator= (const MetaDataOwner &rhs)=default |
| void | copyMetaDataFrom (const MetaDataOwner &src) |
| void | copyMetaDataTo (MetaDataOwner &dst) |
| template<typename T > | |
| T * | createMetaData (const std::string &key) |
| template<typename T , typename U > | |
| void | setMetaData (const std::string &key, U value) |
| template<typename T > | |
| bool | unsetMetaData (const std::string &key) |
| unset, i.e. remove the metadata entry matching the given key and type More... | |
| template<typename T , typename U > | |
| U | getMetaData (const std::string &key, U val) const |
| template<typename T > | |
| T * | getMetaData (const std::string &key) |
| template<typename T > | |
| const T * | getMetaData (const std::string &key) const |
| MetaDataMap * | getMetaDataMap () |
| const MetaDataMap * | getMetaDataMap () const |
| template<typename T > | |
| bool | hasMetaData (const std::string &key) const |
Static Public Attributes | |
| static const std::string | classIdentifier = "org.inviwo.StringProperty" |
Additional Inherited Members | |
| Public Types inherited from inviwo::TemplateProperty< std::string > | |
| using | value_type = std::string |
| Static Public Member Functions inherited from inviwo::Property | |
| template<typename T , typename U > | |
| static void | setStateAsDefault (T &property, const U &state) |
| Protected Member Functions inherited from inviwo::TemplateProperty< std::string > | |
| TemplateProperty (const TemplateProperty &rhs)=default | |
| Protected Member Functions inherited from inviwo::Property | |
| Property (const Property &rhs) | |
| Property & | operator= (const Property &that)=delete |
| void | updateWidgets () |
| void | notifyAboutChange () |
| Protected Member Functions inherited from inviwo::PropertyObservable | |
| void | notifyObserversOnSetIdentifier (Property *property, const std::string &identifier) |
| void | notifyObserversOnSetDisplayName (Property *property, const std::string &displayName) |
| void | notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics) |
| void | notifyObserversOnSetReadOnly (Property *property, bool readonly) |
| void | notifyObserversOnSetVisible (Property *property, bool visible) |
| void | notifyObserversOnSetUsageMode (Property *property, UsageMode usageMode) |
| Protected Member Functions inherited from inviwo::Observable< PropertyObserver > | |
| void | forEachObserver (C callback) |
| Protected Member Functions inherited from inviwo::ObservableInterface | |
| void | addObservationHelper (Observer *observer) |
| void | removeObservationHelper (Observer *observer) |
| Protected Attributes inherited from inviwo::TemplateProperty< std::string > | |
| ValueWrapper< std::string > | value_ |
| Protected Attributes inherited from inviwo::Property | |
| CallBackList | onChangeCallback_ |
| PropertySerializationMode | serializationMode_ |
| Protected Attributes inherited from inviwo::MetaDataOwner | |
| MetaDataMap | metaData_ |
The StringProperty holds a string as value.
The string property has 2 different widgets, one that just displays the value of the string. The other one makes it possible to edit the string. To use the editor widget you must specify it in the constructor and set the property semantics to Editor.
|
overridevirtual |
Creates a clone of this property. The clone will have the same identifier, hence the identifier must be changed if the clone should be added to the same owner as this. The new clone does not have any owner set.
Implements inviwo::TemplateProperty< std::string >.
1.8.15 