Base abstraction for Actions for DataTrigger, such as ForwardingApplyAction and ApplyActivationAction. More...

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

Inheritance diagram for kanzi::ApplyAction:

Public Member Functions
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 ()

Static Public Member Functions
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.

Protected Types
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 Member Functions
	ApplyAction (Domain *domain, string_view name)
	Constructor.

virtual void	applyOverride ()=0
	Overridable method to apply an ApplyAction.

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.

virtual ApplyActionSharedPtr	clone () const =0
	Overridable function for copying an ApplyAction.

virtual void	unapplyOverride ()=0
	Overridable method to unapply an ApplyAction and restore the DataTriggerComponent node to its previous state.

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

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

virtual void	onAttach ()
	Overridable method called during attach.

virtual void	onDetach ()
	Overridable method called during detach.

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.

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

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

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

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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.

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

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

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

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

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.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

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

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

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

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 Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

Base abstraction for Actions for DataTrigger, such as ForwardingApplyAction and ApplyActivationAction.

An ApplyAction applies the changes described in the Action on apply(), and reverts them on unapply().

See also: ApplyAction::apply(), ApplyAction::unapply()

Since: Kanzi 3.9.0

Member Typedef Documentation

◆ PropertyValidatorFunctionType

using kanzi::ApplyAction::PropertyValidatorFunctionType

protected

Validator function to validate if a change in a property is valid to apply the Action or not.

Constructor & Destructor Documentation

◆ ApplyAction()

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

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name of the constructed ApplyAction.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ApplyAction::makeEditorInfo ( )

static

Provides the Kanzi Studio editor metadata for the ApplyAction.

Returns: Shared pointer to the created PropertyTypeEditorInfo instance.

◆ apply()

void kanzi::ApplyAction::apply ( )

Applies an ApplyAction to the node that this action targets.

◆ unapply()

void kanzi::ApplyAction::unapply ( )

Unapplies an ApplyAction by rolling back the changes made on apply(), and restoring the state of the target node to its previous value.

◆ copy()

ApplyActionSharedPtr kanzi::ApplyAction::copy ( ) const

Returns: Shared pointer to the created ApplyAction instance.

◆ getTrigger()

DataTriggerComponent * kanzi::ApplyAction::getTrigger ( ) const

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

Returns: The pointer to the DataTrigger.

◆ attach()

void kanzi::ApplyAction::attach ( DataTriggerComponent * trigger )

Attaches an Action to a DataTrigger.

Parameters

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

◆ detach()

void kanzi::ApplyAction::detach ( )

Detaches the Action from the DataTrigger.

◆ applyWhenTargetIsAlive()

void kanzi::ApplyAction::applyWhenTargetIsAlive	(	NodeSharedPtr	hostNode,
		string_view	targetPath,
		AbstractPropertyType	targetPropertyType,
		PropertyValidatorFunctionType	isPropertyChangeValid )

protected

Use this method when Kanzi cannot find the node on which to apply an Action during ApplyAction.

This method observes the path that you pass. When the node in that path becomes available, the method applies the Action. In case the Action is unapplied before the node becomes available, the class stops observing the path that you pass.

Parameters

hostNode	The node to which the modifier binding is added.
targetPath	The path to an unavailable node to which you want to apply an Action.
targetPropertyType	The property type, on the target node, to listen to.
isPropertyChangeValid	Validator function to validate if a change in targetPropertyType property is valid to apply the Action or not.

◆ clone()

virtual ApplyActionSharedPtr kanzi::ApplyAction::clone ( ) const

protectedpure virtual

Overridable function for copying an ApplyAction.

Implementations must call onCopy() on the new instances.

Implemented in kanzi::ApplyActivationAction, and kanzi::ApplyPropertyAction.

◆ applyOverride()

virtual void kanzi::ApplyAction::applyOverride ( )

protectedpure virtual

Overridable method to apply an ApplyAction.

Implemented in kanzi::ApplyActivationAction, and kanzi::ApplyPropertyAction.

◆ unapplyOverride()

virtual void kanzi::ApplyAction::unapplyOverride ( )

protectedpure virtual

Overridable method to unapply an ApplyAction and restore the DataTriggerComponent node to its previous state.

Implemented in kanzi::ApplyActivationAction, and kanzi::ApplyPropertyAction.

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

kanzi/core.ui/action/apply_action.hpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PropertyValidatorFunctionType

Constructor & Destructor Documentation

◆ ApplyAction()

Member Function Documentation

◆ makeEditorInfo()

◆ apply()

◆ unapply()

◆ copy()

◆ getTrigger()

◆ attach()

◆ detach()

◆ applyWhenTargetIsAlive()

◆ clone()

◆ applyOverride()

◆ unapplyOverride()