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>
Public Member Functions | |
void | attach (Trigger *trigger) |
Attaches an Action to a Trigger. | |
ActionSharedPtr | copy () const |
void | detach () |
Detaches the Action from the Trigger. | |
Trigger * | getTrigger () const |
Returns the pointer to a Trigger to which an Action is attached. | |
void | invoke () |
Invokes the Action. | |
Public Member Functions inherited from kanzi::ActionBase | |
string | getName () const |
Returns the name of the action. | |
Public Member Functions inherited from kanzi::Object | |
AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
Applies a style to an object. | |
void | applyObjectStyles () |
Apply all styles for an object node. | |
Domain * | getDomain () const |
Returns the domain the object belongs to. | |
const Metaclass * | getDynamicMetaclass () const override |
Returns the metaclass of the dynamic type of the object. | |
MainLoopScheduler * | getMainLoopScheduler () const |
Returns the MainLoopScheduler instance of the associated Domain. | |
detail::MessageDispatcher * | getMessageDispatcher () const |
Returns the message dispatcher of the object. | |
ResourceManager * | getResourceManager () const |
Returns the resource manager of the object. | |
ScriptingContextSharedPtr | getScriptingContext () const |
Gets the scripting context of the object. | |
Object (Domain *domain) | |
void | setScriptingContext (ScriptingContextSharedPtr context) |
Sets the scripting context of the object. | |
void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
void | unapplyObjectStyles () |
Unapplies and removes all applied styles. | |
~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. | |
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 | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
Adds a property modifier without notifying handlers. | |
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, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
template<typename DataType > | |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
PropertyStorageContainer::iterator | beginPropertyStorage () |
Returns the begin iterator to the internal property storage container. | |
PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
Returns the begin iterator to the internal property storage container. | |
void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
Copies local value of single property from another object. | |
void | copyLocalValues (const PropertyObject &other) |
Copies all local values from another object. | |
PropertyStorageContainer::iterator | endPropertyStorage () |
Returns the end iterator to the internal property storage container. | |
PropertyStorageContainer::const_iterator | endPropertyStorage () const |
Returns the end iterator to the internal property storage container. | |
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. | |
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. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property type. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property disregarding modifiers. | |
template<typename DataType > | |
size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
Gets number of current notification handlers for given property type. | |
bool | hasBaseValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value, disregarding modifiers. | |
bool | hasLocalValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a local value set for the property. | |
bool | hasNonClassValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a value of any precedence higher than class default value set for the property. | |
bool | hasValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value. | |
bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
virtual void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
Virtual function to handle property change notifications. | |
PropertyObject () | |
void | removeKzbProperties () |
Remove all KZB properties. | |
void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
Remove all KZB properties that are not included in a given set. | |
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. | |
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. | |
void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. | |
void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. | |
virtual | ~PropertyObject () |
Static Public Member Functions | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Provides the Kanzi Studio editor metadata for the SetPropertyAction. | |
Static Public Member Functions inherited from kanzi::ActionBase | |
static ActionBaseSharedPtr | loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser) |
Loads an ActionBase from a kzb file. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Provides the Kanzi Studio editor metadata for the ActionBase. | |
template<typename TAction > | |
static shared_ptr< TAction > | loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser) |
Loads an TAction from a kzb file. | |
Static Public Member Functions inherited from kanzi::Object | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. | |
Static Public Member Functions inherited from kanzi::MetaObject | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. | |
Properties | |
static PropertyType< int > | DelayProperty |
Delays all invocations of an action by the amount in milliseconds. | |
chrono::milliseconds | getDelay () const |
Returns the delay in milliseconds that Kanzi waits before it invokes an action. | |
void | setDelay (chrono::milliseconds delay) |
Sets the delay in milliseconds that Kanzi waits before it invokes an action. | |
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. | |
Protected Attributes inherited from kanzi::Object | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. | |
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.
To create a custom action class:
|
explicitprotected |
Constructor.
domain | Pointer to the domain. |
name | Name for the action. |
|
inline |
Returns the delay in milliseconds that Kanzi waits before it invokes an action.
You can set the delay in the DelayProperty.
|
inline |
Sets the delay in milliseconds that Kanzi waits before it invokes an action.
delay | The delay in milliseconds for invoking the action. |
|
static |
Provides the Kanzi Studio editor metadata for the SetPropertyAction.
ActionSharedPtr kanzi::Action::copy | ( | ) | const |
Trigger * kanzi::Action::getTrigger | ( | ) | const |
|
protectedpure virtual |
Overridable function for copying an Action.
Implementations must call onCopy() on the new instances.
Implemented in kanzi::ExecuteLuaAction, kanzi::DispatchMessageAction, kanzi::MoveFocusAction, kanzi::SetPropertyAction, kanzi::TrySetFocusAction, and kanzi::WriteLogAction.
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::ExecuteLuaAction, kanzi::DispatchMessageAction, kanzi::ForwardingAction, kanzi::MoveFocusAction, kanzi::SetPropertyAction, kanzi::TrySetFocusAction, and kanzi::WriteLogAction.
Callback called by Kanzi when the action is invoked by its trigger with delay.
Use this to prepare for delayed execution.
Reimplemented in kanzi::DispatchMessageAction, kanzi::ForwardingAction, and kanzi::SetPropertyAction.
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::ExecuteLuaAction, kanzi::DispatchMessageAction, kanzi::MoveFocusAction, kanzi::SetPropertyAction, kanzi::TrySetFocusAction, and kanzi::WriteLogAction.
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.
|
static |
Delays all invocations of an action by the amount in milliseconds.
The default value is 0.