Kanzi  3.9.5
Kanzi Engine API
kanzi::ApplyPropertyAction Class Reference

An ApplyPropertyAction sets a property to the requested value for as long as the condition is met in the DataTrigger that sets off this action. More...

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

Inheritance diagram for kanzi::ApplyPropertyAction:
[legend]

Static Public Member Functions

static auto create (Domain *domain, string_view name)
 Creates an instance of ApplyPropertyAction. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides Kanzi Studio editor metadata for ApplyPropertyAction. More...
 
- Static Public Member Functions inherited from kanzi::ApplyAction
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the Kanzi Studio editor metadata for the ApplyAction. 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 MetaclassgetStaticMetaclass ()
 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 MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

Properties
static PropertyType< string > TargetObjectPathProperty
 TargetObjectPathProperty property. More...
 

Protected Member Functions

void applyOverride () override
 ApplyAction::applyOverride() implementation. More...
 
 ApplyPropertyAction (Domain *domain, string_view name)
 Creates an ApplyPropertyAction. More...
 
ApplyActionSharedPtr clone () const override
 Action::clone() implementation. More...
 
void setPropertyModifierOnTarget ()
 Sets a property modifier for a binding target runtime based on the stored binding. More...
 
void unapplyOverride () override
 ApplyAction::unapplyOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::ForwardingApplyAction
 ForwardingApplyAction (Domain *domain, string_view name)
 Creates a ForwardingApplyAction. More...
 
void loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads a binding from a kzb file. More...
 
void onCopy (const ForwardingApplyAction &other)
 Deriving classes must call this function when creating instances of ForwardingApplyAction inside implementations of clone(). More...
 
void removeBinding ()
 Remove the stored binding information. More...
 
- Protected Member Functions inherited from kanzi::ApplyAction
 ApplyAction (Domain *domain, string_view name)
 Constructor. More...
 
void applyWhenTargetIsAlive (NodeSharedPtr hostNode, string_view targetPath, AbstractPropertyType targetPropertyType, PropertyValidatorFunctionType isPropertyChangeValid)
 Use this method when Kanzi cannot find the node on which to apply an Action during ApplyAction. More...
 
- Protected Member Functions inherited from kanzi::ActionBase
 ActionBase (Domain *domain, string_view name)
 Constructor. 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::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (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::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (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)
 

Additional Inherited Members

- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Member Functions inherited from kanzi::ForwardingApplyAction
void addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument)
 Adds a binding from a message argument to a node or a message argument. More...
 
void addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from a message argument to a node or a message argument. More...
 
void addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument)
 Adds a binding from a property to a node or a message argument. More...
 
void addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from a property to a node or a message argument. More...
 
void addResourceBinding (ResourceID id, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from a resource ID to a property. More...
 
void addResourceBinding (string_view id, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from a resource ID to a property in a node. More...
 
void addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField)
 Adds a binding from a value to a node or a message argument. More...
 
optional< BindingInfogetBindingInfo () const
 Returns the Binding information that this ForwardingApplyAction stores. More...
 
void load (KzbFile &kzbFile, KzbMemoryParser &parser) override
 Action::load() implementation. More...
 
- Public Member Functions inherited from kanzi::ApplyAction
void apply ()
 Applies an ApplyAction to the node that this action targets. More...
 
void attach (DataTriggerComponent *trigger)
 Attaches an Action to a DataTrigger. More...
 
ApplyActionSharedPtr copy () const
 
void detach ()
 Detaches the Action from the DataTrigger. More...
 
DataTriggerComponentgetTrigger () const
 Returns the pointer to a DataTrigger to which an Action is attached. More...
 
void unapply ()
 Unapplies an ApplyAction by rolling back the changes made on apply(), and restoring the state of the target node to its previous value. 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...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () 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 ()
 
- Protected Types inherited from kanzi::ApplyAction
using PropertyValidatorFunctionType = function< bool(const Variant &value)>
 Validator function to validate if a change in a property is valid to apply the Action or not. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::ForwardingApplyAction
optional< BindingInfom_bindingInfo
 Binding information to set to a target object on invoke. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

An ApplyPropertyAction sets a property to the requested value for as long as the condition is met in the DataTrigger that sets off this action.

When the trigger condition is no longer met, Kanzi rolls back the value of that property to the value before the action was applied, or to the value set while Kanzi was applying an ApplyPropertyAction. Use the ApplyPropertyAction only with a DataTrigger.

For example, when the value of a property changes from 5 to 9 while Kanzi is applying an ApplyPropertyAction on that property, when a DataTrigger that set off that action, rolls back that property value, the value is 9, and not 5.

When you want to set a value of a property only when a condition in a Trigger is met, always use a DataTrigger. For example, use one DataTrigger with an ApplyPropertyAction instead of any other trigger to set the value of a property when the condition in that trigger is met and another trigger to roll back the value of the same property when the condition in the first trigger is no longer met.

Since
Kanzi 3.9.0

Examples

To use an ApplyPropertyAction to set the value of a property when a condition in a DataTrigger is met:

// Create an instance of an Apply Property action.
auto action = ApplyPropertyAction::create(domain, "applyAction");
// Set the path of the target node to which you want to add the Apply Property action.
action->setProperty(ApplyPropertyAction::TargetObjectPathProperty, "targetNode");
// Create a binding to configure how you want to set a property of the target node.
action->addValueBinding(Variant(targetPropertyTargetValue), MyPropertyB, PropertyField::PropertyFieldWhole);
// Create a condition expression for the Data Trigger.
// Condition: sourceNode.MyPropertyA == m_sourcePropertyTriggeringValue.
valueSources.push_back(ObjectPropertyExpressionValueSource::create("sourceNode", MyPropertyA, PropertyFieldWhole));
operations.push_back(BindingExpressionOpCode(BindingExpressionArgumentTypeSourceRegister0, PropertyFieldWhole,
vector<Variant> constantRegisters;
constantRegisters.emplace_back(m_sourcePropertyTriggeringValue);
// Create an expression binding.
auto binding = ExpressionBinding::create(operations, valueSources, constantRegisters, 2);
// Create a Data Trigger, add the condition and the Apply Property action that you created earlier, and add the trigger to the Screen node.
auto dataTrigger = DataTrigger::create(domain, "data trigger");
dataTrigger->setConditionExpression(binding);
dataTrigger->addAction(action);
screen->addNodeComponent(dataTrigger);
screen->attach();
// Since the condition of the Data Trigger is not met, the property of the target node does not change.
sourceNode->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue1);
assertEquals(targetPropertyDefaultValue, targetNode->getProperty(MyPropertyB));
// Set the property of the source node to meet the condition. When the condition is met,
// the trigger sets off the Apply Property action, and the action updates the property in the target node.
sourceNode->setProperty(MyPropertyA, m_sourcePropertyTriggeringValue);
assertEquals(targetPropertyTargetValue, targetNode->getProperty(MyPropertyB));
// As soon as the condition of the Data Trigger is not met,
// Kanzi rolls back the property in the target node to the value before the Apply Property action was applied.
sourceNode->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue2);
assertEquals(targetPropertyDefaultValue, targetNode->getProperty(MyPropertyB));

Constructor & Destructor Documentation

◆ ApplyPropertyAction()

kanzi::ApplyPropertyAction::ApplyPropertyAction ( Domain domain,
string_view  name 
)
explicitprotected

Creates an ApplyPropertyAction.

Parameters
domainDomain to use.
nameName of this action instance.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ApplyPropertyAction::makeEditorInfo ( )
static

Provides Kanzi Studio editor metadata for ApplyPropertyAction.

Returns
Shared pointer to the created PropertyTypeEditorInfo instance.

◆ create()

static auto kanzi::ApplyPropertyAction::create ( Domain domain,
string_view  name 
)
inlinestatic

Creates an instance of ApplyPropertyAction.

Parameters
domainPointer to domain.
nameName of this action instance.
Returns
Shared pointer to the created ApplyPropertyAction instance.

◆ clone()

ApplyActionSharedPtr kanzi::ApplyPropertyAction::clone ( ) const
overrideprotectedvirtual

Action::clone() implementation.

Implements kanzi::ApplyAction.

◆ applyOverride()

void kanzi::ApplyPropertyAction::applyOverride ( )
overrideprotectedvirtual

ApplyAction::applyOverride() implementation.

Implements kanzi::ApplyAction.

◆ unapplyOverride()

void kanzi::ApplyPropertyAction::unapplyOverride ( )
overrideprotectedvirtual

◆ setPropertyModifierOnTarget()

void kanzi::ApplyPropertyAction::setPropertyModifierOnTarget ( )
protected

Sets a property modifier for a binding target runtime based on the stored binding.

Member Data Documentation

◆ TargetObjectPathProperty

PropertyType<string> kanzi::ApplyPropertyAction::TargetObjectPathProperty
static

TargetObjectPathProperty property.

Sets the path to the object containing the target property. By default this property points to the node that owns this action. The default value is ".".


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