Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::EventProperty Class Reference

#include <eventproperty.h>

Inheritance diagram for inviwo::EventProperty:

Public Types

using Action = std::function<void(Event*)>

Public Member Functions

virtual std::string_view getClassIdentifier () const override
 EventProperty (std::string_view identifier, std::string_view displayName, Document help, Action action, std::unique_ptr< EventMatcher > matcher, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 Constructor used to create a new action-key binding.
 EventProperty (std::string_view identifier, std::string_view displayName, Action action, std::unique_ptr< EventMatcher > matcher, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 Constructor used to create a new action-key binding.
 EventProperty (std::string_view identifier, std::string_view displayName, Document help, Action action, IvwKey key, KeyStates states=KeyState::Press, KeyModifiers modifier=KeyModifiers(flags::none), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 EventProperty (std::string_view identifier, std::string_view displayName, Action action, IvwKey key, KeyStates states=KeyState::Press, KeyModifiers modifier=KeyModifiers(flags::none), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 EventProperty (std::string_view identifier, std::string_view displayName, Document help, Action action, MouseButtons buttons, MouseStates states=MouseState::Press, KeyModifiers modifiers=KeyModifiers(flags::none), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 EventProperty (std::string_view identifier, std::string_view displayName, Action action, MouseButtons buttons, MouseStates states=MouseState::Press, KeyModifiers modifiers=KeyModifiers(flags::none), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 EventProperty (const EventProperty &rhs)
virtual EventPropertyclone () const override
void invokeEvent (Event *)
void setEventMatcher (std::unique_ptr< EventMatcher > matcher)
EventMatchergetEventMatcher () const
void setAction (Action action)
Action getAction () const
bool isEnabled () const
void setEnabled (bool enabled)
virtual EventPropertysetCurrentStateAsDefault () override
virtual EventPropertyresetToDefaultState () 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 PropertysetIdentifier (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 PropertysetDisplayName (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 PropertysetSemantics (const PropertySemantics &semantics)
virtual PropertySemantics getSemantics () const
virtual PropertysetReadOnly (bool value)
 Enable or disable editing of property.
virtual bool getReadOnly () const
virtual PropertysetInvalidationLevel (InvalidationLevel invalidationLevel)
virtual InvalidationLevel getInvalidationLevel () const
virtual void setOwner (PropertyOwner *owner)
PropertyOwnergetOwner ()
const PropertyOwnergetOwner () 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 PropertysetSerializationMode (PropertySerializationMode mode)
virtual PropertySerializationMode getSerializationMode () const
virtual bool needsSerialization () const
virtual PropertypropertyModified ()
virtual void setValid ()
virtual PropertysetModified ()
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 PropertysetVisible (bool val)
virtual bool getVisible () const
template<typename P, typename DecisionFunc>
PropertyvisibilityDependsOn (P &prop, DecisionFunc callback)
template<typename P, typename DecisionFunc>
PropertyreadonlyDependsOn (P &prop, DecisionFunc callback)
const DocumentgetHelp () const
DocumentgetHelp ()
PropertysetHelp (Document help)
virtual Document getDescription () const
template<typename P>
PropertyautoLinkToProperty (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
MetaDataOwneroperator= (const MetaDataOwner &rhs)=default
MetaDataOwneroperator= (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>
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
MetaDataMapgetMetaDataMap ()
const MetaDataMapgetMetaDataMap () 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.EventProperty"}

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)
Propertyoperator= (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

Property which contains one event matcher and one action to represent the current key binding for the contained action.

See also
EventPropertyWidgetQt

Constructor & Destructor Documentation

◆ EventProperty() [1/2]

inviwo::EventProperty::EventProperty ( std::string_view identifier,
std::string_view displayName,
Document help,
Action action,
std::unique_ptr< EventMatcher > matcher,
InvalidationLevel invalidationLevel = InvalidationLevel::InvalidOutput,
PropertySemantics semantics = PropertySemantics::Default )

Constructor used to create a new action-key binding.

The constructor creates a new binding between a specified action and event.

Parameters
identifier
displayName
help
matcherThe selection of events to bind to an action
actionThe action to executed upon the event.
invalidationLevel
semantics

◆ EventProperty() [2/2]

inviwo::EventProperty::EventProperty ( std::string_view identifier,
std::string_view displayName,
Action action,
std::unique_ptr< EventMatcher > matcher,
InvalidationLevel invalidationLevel = InvalidationLevel::InvalidOutput,
PropertySemantics semantics = PropertySemantics::Default )

Constructor used to create a new action-key binding.

The constructor creates a new binding between a specified action and event.

Parameters
identifier
displayName
matcherThe selection of events to bind to an action
actionThe action to executed upon the event.
invalidationLevel
semantics

Member Function Documentation

◆ clone()

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

◆ deserialize()

virtual void inviwo::EventProperty::deserialize ( Deserializer & d)
overridevirtual

Reimplemented from inviwo::Property.

◆ getClassIdentifier()

virtual std::string_view inviwo::EventProperty::getClassIdentifier ( ) const
overridevirtual

Implements inviwo::Property.

◆ isDefaultState()

virtual bool inviwo::EventProperty::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.

◆ resetToDefaultState()

virtual EventProperty & inviwo::EventProperty::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.

◆ serialize()

virtual void inviwo::EventProperty::serialize ( Serializer & s) const
overridevirtual

Reimplemented from inviwo::Property.

◆ setCurrentStateAsDefault()

virtual EventProperty & inviwo::EventProperty::setCurrentStateAsDefault ( )
overridevirtual

Save the current state of the property as the default. This state will then be used as a reference when serializing, only state different from the default will be serialized. This method should usually only be called once directly after construction in the processor constructor after setting property specific state. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.


The documentation for this class was generated from the following file:
  • eventproperty.h