inviwo::StringProperty Class Reference

The StringProperty holds a string as value. More...

#include <stringproperty.h>

Inheritance diagram for inviwo::StringProperty:

Public Member Functions
virtual std::string_view	getClassIdentifier () const override
	StringProperty (std::string_view identifier, std::string_view displayName, Document help, std::string_view 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 (std::string_view identifier, std::string_view displayName, std::string_view 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
StringProperty &	set (std::string_view value)
StringProperty &	set (const char *value)
StringProperty &	setDefault (std::string_view value)
	operator std::string_view () const
virtual Document	getDescription () const override
Public Member Functions inherited from inviwo::TemplateProperty< std::string >
	TemplateProperty (std::string_view identifier, std::string_view displayName, Document help, const std::string &value=std::string(), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
TemplateProperty< std::string > &	operator= (const std::string &value)
	operator const std::string & () const
const std::string &	get () const
const std::string &	operator* () const
const std::string *	operator-> () const
virtual void	set (const std::string &value)
virtual TemplateProperty &	setCurrentStateAsDefault () override
TemplateProperty &	setDefault (const std::string &value)
virtual TemplateProperty &	resetToDefaultState () override
virtual bool	isDefaultState () const override
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override
Public Member Functions inherited from inviwo::Property
	Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)
	Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)
virtual	~Property ()
	Removes itself from its PropertyOwner.
virtual Property &	setIdentifier (std::string_view identifier)
virtual const std::string &	getIdentifier () const
const std::string &	getPath () const
	Get the property path as string.
void	getPath (std::pmr::string &out) const
virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.
virtual const std::string &	getDisplayName () const
virtual std::string_view	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 ()
void	updateWidgets ()
bool	hasWidgets () const
virtual Property &	setSerializationMode (PropertySerializationMode mode)
virtual PropertySerializationMode	getSerializationMode () const
virtual bool	needsSerialization () const
virtual Property &	propertyModified ()
virtual void	setValid ()
virtual Property &	setModified ()
virtual bool	isModified () const
virtual void	set (const Property *src)
std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> callback)
const BaseCallBack *	onChange (std::function< void()> callback)
void	removeOnChange (const BaseCallBack *callback)
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)
const Document &	getHelp () const
Document &	getHelp ()
Property &	setHelp (Document help)
template<typename P>
Property &	autoLinkToProperty (std::string_view propertyPath)
const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const
virtual void	accept (NetworkVisitor &visitor)
	Accept a NetworkVisitor, the visitor will visit this Property.
Public Member Functions inherited from inviwo::Observable< PropertyObserver >
Observable< PropertyObserver > &	operator= (const 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 (MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default
MetaDataOwner &	operator= (MetaDataOwner &)=default
void	copyMetaDataFrom (const MetaDataOwner &src)
void	copyMetaDataTo (MetaDataOwner &dst)
template<typename T> requires std::derived_from<T, MetaData>
T *	createMetaData (std::string_view key)
template<typename T, typename U> requires std::derived_from<T, MetaData> && Settable<T, U>
void	setMetaData (std::string_view key, U value)
template<typename T> requires std::derived_from<T, MetaData>
bool	unsetMetaData (std::string_view key)
	unset, i.e. remove the metadata entry matching the given key and type
template<typename T, typename U> requires std::derived_from<T, MetaData> && Gettable<T, U>
U	getMetaData (std::string_view key, U val) const
template<typename T> requires std::derived_from<T, MetaData>
T *	getMetaData (std::string_view key)
template<typename T> requires std::derived_from<T, MetaData>
const T *	getMetaData (std::string_view key) const
MetaDataMap *	getMetaDataMap ()
const MetaDataMap *	getMetaDataMap () const
bool	hasMetaData (std::string_view key) const
template<typename T> requires std::derived_from<T, MetaData>
bool	hasMetaData (std::string_view key) const
void	serialize (Serializer &s) const
void	deserialize (Deserializer &d)

Static Public Attributes
static constexpr std::string_view	classIdentifier {"org.inviwo.StringProperty"}

Additional Inherited Members
Public Types inherited from inviwo::TemplateProperty< std::string >
using	value_type
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::Property
	Property (const Property &rhs)
Property &	operator= (const Property &that)=delete
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)
Protected Member Functions inherited from inviwo::Observable< PropertyObserver >
void	forEachObserver (C callback)
Protected Member Functions inherited from inviwo::ObservableInterface
virtual void	addObserver (Observer *observer)=0
virtual void	removeObserver (Observer *observer)=0
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_

Detailed Description

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.

See also

StringPropertyWidgetQt

TextEditorWidgetQt

Member Function Documentation

clone()

virtual StringProperty * inviwo::StringProperty::clone ( ) const

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 >.

getClassIdentifier()

virtual std::string_view inviwo::StringProperty::getClassIdentifier ( ) const

overridevirtual

Implements inviwo::Property.

getDescription()

virtual Document inviwo::StringProperty::getDescription ( ) const

overridevirtual

This function should describe the state of the property By default this will return a document describing all the state. i.e. Identifier, DisplayName, Help, InvalidationLevel, PropertySemantics, etc. Derived properties should extend this function and add their state, usually values etc. The description is usually shown as a tooltip in the GUI.

Reimplemented from inviwo::Property.

---

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

• stringproperty.h