inviwo::ButtonProperty Class Reference

The Button property class provides buttons that you can bind functions to. More...

#include <buttonproperty.h>

Inheritance diagram for inviwo::ButtonProperty:

Public Member Functions
virtual std::string_view	getClassIdentifier () const override
	ButtonProperty (std::string_view identifier, std::string_view displayName, Document help, std::function< void()> callback, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	ButtonProperty (std::string_view identifier, std::string_view displayName, std::function< void()> callback, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	ButtonProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	ButtonProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
	ButtonProperty (const ButtonProperty &rhs)
	ButtonProperty (const ButtonProperty &rhs, std::function< void()> callback)
virtual ButtonProperty *	clone () const override
virtual void	set (const Property *src) override
virtual void	pressButton ()
virtual ButtonProperty &	propertyModified () override
virtual ButtonProperty &	resetToDefaultState () override
virtual bool	isDefaultState () const 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 Property &	setCurrentStateAsDefault ()
virtual bool	needsSerialization () const
virtual void	setValid ()
virtual Property &	setModified ()
virtual bool	isModified () const
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override
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)
virtual Document	getDescription () const
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.ButtonProperty"}

Additional Inherited Members
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::Property
CallBackList	onChangeCallback_
PropertySerializationMode	serializationMode_
Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Detailed Description

The Button property class provides buttons that you can bind functions to.

The button property has a widget witch creates a button and register a function to it. You can only assign one function to the property. To bind a function to a button property use onChange. Example usage:

myButton_.onChange([&](){doSomthing();});

See also

ButtonPropertyWidgetQt

Member Function Documentation

clone()

virtual ButtonProperty * inviwo::ButtonProperty::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::Property.

getClassIdentifier()

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

overridevirtual

Implements inviwo::Property.

isDefaultState()

virtual bool inviwo::ButtonProperty::isDefaultState ( ) const

overridevirtual

Check if the property is in it's default state, i.e. resetToDefaultState would do nothing

See also

setCurrentStateAsDefault

resetToDefaultState

Reimplemented from inviwo::Property.

pressButton()

virtual void inviwo::ButtonProperty::pressButton ( )

virtual

Causes onChange to be called.

See also

propertyModified

onChange

propertyModified()

virtual ButtonProperty & inviwo::ButtonProperty::propertyModified ( )

overridevirtual

Reimplemented from inviwo::Property.

resetToDefaultState()

virtual ButtonProperty & inviwo::ButtonProperty::resetToDefaultState ( )

overridevirtual

Reset the state of the property back to it's default value. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.

set()

virtual void inviwo::ButtonProperty::set ( const Property * src )

overridevirtual

Overrides the default implementation to enable buttons to be linked. Will cause the button to be pressed when a linked button is pressed.

Parameters

src	Button property

Reimplemented from inviwo::Property.

---

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

• buttonproperty.h