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>
Static Public Member Functions | |
static auto | create (Domain *domain, string_view name) |
Creates an instance of ApplyPropertyAction. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Provides Kanzi Studio editor metadata for ApplyPropertyAction. | |
Static Public Member Functions inherited from kanzi::ApplyAction | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Provides the Kanzi Studio editor metadata for the ApplyAction. | |
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. | |
Static Public Attributes | |
Properties | |
static PropertyType< string > | TargetObjectPathProperty |
TargetObjectPathProperty property. | |
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 |
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. | |
void | addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField) |
Adds a binding from a message argument to a node or a message argument. | |
void | addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument) |
Adds a binding from a property to a node or a message argument. | |
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. | |
void | addResourceBinding (ResourceID id, AbstractPropertyType targetArgument, PropertyField targetField) |
Adds a binding from a resource ID to a property. | |
void | addResourceBinding (string_view id, AbstractPropertyType targetArgument, PropertyField targetField) |
Adds a binding from a resource ID to a property in a node. | |
void | addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField) |
Adds a binding from a value to a node or a message argument. | |
optional< BindingInfo > | getBindingInfo () const |
Returns the Binding information that this ForwardingApplyAction stores. | |
void | load (KzbFile &kzbFile, KzbMemoryParser &parser) override |
Action::load() implementation. | |
Public Member Functions inherited from kanzi::ApplyAction | |
void | apply () |
Applies an ApplyAction to the node that this action targets. | |
void | attach (DataTriggerComponent *trigger) |
Attaches an Action to a DataTrigger. | |
ApplyActionSharedPtr | copy () const |
void | detach () |
Detaches the Action from the DataTrigger. | |
DataTriggerComponent * | getTrigger () const |
Returns the pointer to a DataTrigger to which an Action is attached. | |
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. | |
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 () |
Protected Types inherited from kanzi::ApplyAction | |
using | PropertyValidatorFunctionType |
Validator function to validate if a change in a property is valid to apply the Action or not. | |
Protected Types inherited from kanzi::Object | |
typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
Applied style container. | |
Protected Attributes inherited from kanzi::ForwardingApplyAction | |
optional< BindingInfo > | m_bindingInfo |
Binding information to set to a target object on invoke. | |
Protected Attributes inherited from kanzi::Object | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. | |
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.
To use an ApplyPropertyAction to set the value of a property when a condition in a DataTrigger is met:
|
explicitprotected |
Creates an ApplyPropertyAction.
domain | Domain to use. |
name | Name of this action instance. |
|
static |
Provides Kanzi Studio editor metadata for ApplyPropertyAction.
Creates an instance of ApplyPropertyAction.
domain | Pointer to domain. |
name | Name of this action instance. |
|
overrideprotectedvirtual |
Action::clone() implementation.
Implements kanzi::ApplyAction.
|
overrideprotectedvirtual |
ApplyAction::applyOverride() implementation.
Implements kanzi::ApplyAction.
|
overrideprotectedvirtual |
ApplyAction::unapplyOverride() implementation.
Implements kanzi::ApplyAction.
|
protected |
Sets a property modifier for a binding target runtime based on the stored binding.
|
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 ".".