Actions are small operations that Kanzi executes when the trigger event that contains that action occurs and the trigger conditions are met. More...

#include <kanzi/core.ui/action/action.hpp>

Inheritance diagram for kanzi::Action:

[legend]

Public Member Functions
void	attach (Trigger *trigger)
	Attaches an Action to a Trigger. More...

ActionSharedPtr	copy () const

void	detach ()
	Detaches the Action from the Trigger. More...

Trigger *	getTrigger () const
	Returns the pointer to a Trigger to which an Action is attached. More...

void	invoke ()
	Invokes the Action. More...

Public Member Functions inherited from kanzi::ActionBase
string	getName () const
	Returns the name of the action. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Provides the Kanzi Studio editor metadata for the SetPropertyAction. More...

Static Public Member Functions inherited from kanzi::ActionBase
static ActionBaseSharedPtr	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads an ActionBase from a kzb file. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Provides the Kanzi Studio editor metadata for the ActionBase. More...

template<typename TAction >
static shared_ptr< TAction >	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads an TAction from a kzb file. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
	Action (Domain *domain, string_view name)
	Constructor. More...

virtual ActionSharedPtr	clone () const =0
	Overridable function for copying an Action. More...

virtual void	onDelayedInvoke ()
	Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires. More...

virtual void	onInvoke ()
	Callback called by Kanzi when the action is invoked by its trigger without delay. More...

virtual void	onPrepareDelayedInvoke ()
	Callback called by Kanzi when the action is invoked by its trigger with delay. More...

virtual void	onUnprepareDelayedInvoke ()
	Kanzi calls this callback when an action is invoked by trigger with delay, after onDelayedInvoke() callback, or when it cancels a delayed execution. More...

Protected Member Functions inherited from kanzi::ActionBase
	ActionBase (Domain *domain, string_view name)
	Constructor. More...

virtual void	load (KzbFile &, KzbMemoryParser &parser)
	Overridable function for loading an action from a kzb file. More...

virtual void	onAttach ()
	Overridable method called during attach. More...

virtual void	onDetach ()
	Overridable method called during detach. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Properties
static PropertyType< int >	DelayProperty
	Delays all invocations of an action by the amount in milliseconds. More...

chrono::milliseconds	getDelay () const
	Returns the delay in milliseconds that Kanzi waits before it invokes an action. More...

void	setDelay (chrono::milliseconds delay)
	Sets the delay in milliseconds that Kanzi waits before it invokes an action. More...

Additional Inherited Members
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Actions are small operations that Kanzi executes when the trigger event that contains that action occurs and the trigger conditions are met.

Action is the base class for actions. For example, if you want to perform a simple operation, such as set a value of a property, you can use a trigger with the SetPropertyAction action.

Kanzi provides a number of built-in action classes, such as SetPropertyAction that you can use to set the value of a property of a target node, and DispatchMessageAction that you can use to dispatch a message of specified type to a specified target. However, Kanzi also enables you to define your own actions by deriving from the Action class.

When you want to create an action that receives arguments of its triggering message or properties of a node, derive that action from the ForwardingAction class, which provides generic functionality for this purpose.

You can delay the invocation of an action by the amount of time that you set in the DelayProperty.

Examples

To create a custom action class:

    class SetVisibilityAction;
    typedef shared_ptr<SetVisibilityAction> SetVisibilityActionSharedPtr;
    // A sample action class that sets the Node::VisibleProperty in the host node based on the value of its own ValueProperty.
    class SetVisibilityAction : public Action
    {
    public:
        // Declare properties.
        static PropertyType<bool> ValueProperty;
        // Register the class and its properties.
        KZ_METACLASS_BEGIN(SetVisibilityAction, Action, "ActionSnippet.SetVisibilityAction")
            KZ_METACLASS_PROPERTY_TYPE(ValueProperty);
        KZ_METACLASS_END()
        // Define constructor and create functions.
        explicit SetVisibilityAction(Domain* domain, string_view name) :
            Action(domain, name)
        {
        }
        static SetVisibilityActionSharedPtr create(Domain* domain, string_view name)
        {
            return make_shared<SetVisibilityAction>(domain, name);
        }
        // Implement makeEditorInfo() to register metadata with Kanzi Studio.
        static PropertyTypeEditorInfoSharedPtr makeEditorInfo()
        {
            return PropertyTypeEditorInfoSharedPtr(
                KZ_DECLARE_EDITOR_METADATA(
                    metadata.displayName = "Set Visibility";
                    metadata.tooltip = "Sets the visibility of the host node.";
                ));
        }
    protected:
        // Implement clone() override.
        // Kanzi calls this function on the action instance loaded inside a prefab,
        // to create a copy that it attaches to the host trigger.
        ActionSharedPtr clone() const override
        {
            // Create an instance of SetVisibilityAction.
            auto action = make_shared<SetVisibilityAction>(getDomain(), getName());
            // Copy to the action the required data.
            action->onCopy(*this);
            return action;
        }
        // Implement onCopy(). You call this function from the clone() implementation, to copy the required data from a prefab instance to the copy.
        void onCopy(const SetVisibilityAction& other)
        {
            // Call base class implementation.
            Action::onCopy(other);
            // Copy any additional data.
        }
        // In onInvoke() override, implement the behavior of the action when Kanzi executes the action without a delay.
        void onInvoke() override
        {
            // Get the value of the action's ValueProperty.
            bool value = getProperty(ValueProperty);
            // Apply to the trigger's host.
            getTrigger()->getNode()->setProperty(Node::VisibleProperty, value);
        }
        // In onPrepareDelayedInvoke() override, implement preparations for the delayed execution of the action.
        void onPrepareDelayedInvoke() override
        {
            // Call base class implementation.
            Action::onPrepareDelayedInvoke();
            // Cache the current value of the ValueProperty.
            m_cachedValueProperty = getProperty(ValueProperty);
        }
        // In onPrepareDelayedInvoke() override, implement the delayed execution behavior, that is when the delay duration has expired.
        void onDelayedInvoke() override
        {
            // Apply the cached value of the ValueProperty to the host of the trigger.
            getTrigger()->getNode()->setProperty(Node::VisibleProperty, m_cachedValueProperty);
            // Call the base class implementation.
            Action::onDelayedInvoke();
        }
        // In onUnprepareDelayedInvoke() override, implement rollback for any prepations made in onPrepareDelayedInvoke().
        // Kanzi calls this callback when an action is invoked by trigger with delay, after onDelayedInvoke() callback, or when it cancels a delayed execution.
        // An example of cancellation of delayed execution is when you detach the action before the execution is done.
        void onUnprepareDelayedInvoke() override
        {
            // Call the base class implementation. 
            Action::onUnprepareDelayedInvoke();
        }
    private:
        bool m_cachedValueProperty = false;
    };

Constructor & Destructor Documentation

◆ Action()

kanzi::Action::Action	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Constructor.

Parameters

domain	Pointer to the domain.
name	Name for the action.

Member Function Documentation

◆ getDelay()

chrono::milliseconds kanzi::Action::getDelay ( ) const

inline

Returns the delay in milliseconds that Kanzi waits before it invokes an action.

You can set the delay in the DelayProperty.

Returns: Delay for the action in milliseconds.

◆ setDelay()

void kanzi::Action::setDelay ( chrono::milliseconds delay )

inline

Sets the delay in milliseconds that Kanzi waits before it invokes an action.

Parameters

delay The delay in milliseconds for invoking the action.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Action::makeEditorInfo ( )

static

Provides the Kanzi Studio editor metadata for the SetPropertyAction.

Returns: Shared pointer to the created PropertyTypeEditorInfo instance.

◆ invoke()

void kanzi::Action::invoke ( )

Invokes the Action.

◆ copy()

ActionSharedPtr kanzi::Action::copy ( ) const

Returns: Shared pointer to the created Action instance.

◆ getTrigger()

Trigger* kanzi::Action::getTrigger ( ) const

Returns the pointer to a Trigger to which an Action is attached.

Returns: The pointer to the Trigger.

◆ attach()

void kanzi::Action::attach ( Trigger * trigger )

Attaches an Action to a Trigger.

Parameters

trigger Pointer to the Trigger to which you want to attach the Action.

◆ detach()

void kanzi::Action::detach ( )

Detaches the Action from the Trigger.

◆ clone()

virtual ActionSharedPtr kanzi::Action::clone ( ) const

protectedpure virtual

Overridable function for copying an Action.

Implementations must call onCopy() on the new instances.

Implemented in kanzi::DispatchMessageAction, kanzi::SetPropertyAction, kanzi::WriteLogAction, kanzi::MoveFocusAction, and kanzi::TrySetFocusAction.

◆ onInvoke()

virtual void kanzi::Action::onInvoke ( )

protectedvirtual

Callback called by Kanzi when the action is invoked by its trigger without delay.

Use this to execute an action without delay.

Reimplemented in kanzi::ForwardingAction, kanzi::DispatchMessageAction, kanzi::SetPropertyAction, kanzi::WriteLogAction, kanzi::MoveFocusAction, and kanzi::TrySetFocusAction.

◆ onPrepareDelayedInvoke()

virtual void kanzi::Action::onPrepareDelayedInvoke ( )

protectedvirtual

Callback called by Kanzi when the action is invoked by its trigger with delay.

Use this to prepare for delayed execution.

Reimplemented in kanzi::ForwardingAction, kanzi::DispatchMessageAction, and kanzi::SetPropertyAction.

◆ onDelayedInvoke()

virtual void kanzi::Action::onDelayedInvoke ( )

protectedvirtual

Callback called by Kanzi when the action is invoked by trigger with delay, after the delay duration expires.

Use this to execute an action with delay.

Reimplemented in kanzi::DispatchMessageAction, kanzi::SetPropertyAction, kanzi::WriteLogAction, kanzi::MoveFocusAction, and kanzi::TrySetFocusAction.

◆ onUnprepareDelayedInvoke()

virtual void kanzi::Action::onUnprepareDelayedInvoke ( )

protectedvirtual

Kanzi calls this callback when an action is invoked by trigger with delay, after onDelayedInvoke() callback, or when it cancels a delayed execution.

An example of cancellation of delayed execution is when you detach the action before the execution is done. Use this function to roll back any preparations made for a delayed execution.

Member Data Documentation

◆ DelayProperty

PropertyType<int> kanzi::Action::DelayProperty

static

Delays all invocations of an action by the amount in milliseconds.

The default value is 0.

See also: setDelay(), getDelay()

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

kanzi/core.ui/action/action.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Examples

Constructor & Destructor Documentation

◆ Action()

Member Function Documentation

◆ getDelay()

◆ setDelay()

◆ makeEditorInfo()

◆ invoke()

◆ copy()

◆ getTrigger()

◆ attach()

◆ detach()

◆ clone()

◆ onInvoke()

◆ onPrepareDelayedInvoke()

◆ onDelayedInvoke()

◆ onUnprepareDelayedInvoke()

Member Data Documentation

◆ DelayProperty