ForwardingApplyAction is the base class for the ApplyAction classes that read and send an argument, such as ApplyPropertyAction. More...

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

Inheritance diagram for kanzi::ForwardingApplyAction:

[legend]

Classes
struct	BindingInfo
	Stored info for a binding. More...

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

DataTriggerComponent *	getTrigger () 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...

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 ()

Protected Member Functions
	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...

virtual void	applyOverride ()=0
	Overridable method to apply an ApplyAction. 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...

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

virtual void	unapplyOverride ()=0
	Overridable method to unapply an ApplyAction and restore the DataTriggerComponent node to its previous state. 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::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 &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...

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)

Protected Attributes
optional< BindingInfo >	m_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...

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

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 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 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< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Detailed Description

ForwardingApplyAction is the base class for the ApplyAction classes that read and send an argument, such as ApplyPropertyAction.

ForwardingApplyAction contains functionality to read an argument from sources, such as messages, properties or set values, and allows the inheriting action class to use these values. This usually means sending messages or setting values of properties.

Since: Kanzi 3.9.0

Constructor & Destructor Documentation

◆ ForwardingApplyAction()

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

explicitprotected

Creates a ForwardingApplyAction.

Parameters

domain	Domain to use.
name	Name of this action instance.

Member Function Documentation

◆ addValueBinding()

void kanzi::ForwardingApplyAction::addValueBinding	(	const Variant &	sourceValue,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

Adds a binding from a value to a node or a message argument.

Use this function to set constant value to the sent message. Note that successive actions can override this value. You can retrieve the binding by calling getBindingInfo().

Parameters

sourceValue	Source value.
targetArgument	Target argument property type for the forwarded value.
targetField	Target property field of the argument property type.

◆ addArgumentBinding() [1/2]

void kanzi::ForwardingApplyAction::addArgumentBinding	(	AbstractPropertyType	sourceArgument,
		AbstractPropertyType	targetArgument
	)

Adds a binding from a message argument to a node or a message argument.

Use this function to bind from a source message argument to a target message argument. Both source and target property fields are PropertyFieldWhole. You can retrieve the binding by calling getBindingInfo().

Parameters

sourceArgument	Source message argument.
targetArgument	Target argument property type for the forwarded value.

◆ addArgumentBinding() [2/2]

void kanzi::ForwardingApplyAction::addArgumentBinding	(	AbstractPropertyType	sourceArgument,
		PropertyField	sourceField,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

Adds a binding from a message argument to a node or a message argument.

Use this function to bind from a source message argument to a target message argument. Source property field is PropertyFieldWhole. You can retrieve the binding by calling getBindingInfo().

Parameters

sourceArgument	Source message argument.
sourceField	Property field in the source argument property type.
targetArgument	Target argument property type for the forwarded value.
targetField	Property field in the target argument property type.

◆ addPropertyBinding() [1/2]

void kanzi::ForwardingApplyAction::addPropertyBinding	(	string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		AbstractPropertyType	targetArgument
	)

Adds a binding from a property to a node or a message argument.

Use this function to bind from source object properties to a target message argument. The source object is a Node or a RenderPass object. Target property field is PropertyFieldWhole. You can retrieve the binding by calling getBindingInfo().

Parameters

sourceObjectPath	Path to source object.
sourcePropertyType	Source property type.
targetArgument	Target argument property type for the forwarded value.

◆ addPropertyBinding() [2/2]

void kanzi::ForwardingApplyAction::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.

Use this function to bind from source object properties to target object properties. The function takes the path to the target node from the TargetObjectPathProperty. The source and target object is a Node or a RenderPass object. You can retrieve the binding by calling getBindingInfo().

Parameters

sourceObjectPath	Path to source object.
sourcePropertyType	Source property type.
sourceField	Property field in the source argument property type.
targetArgument	Target argument property type for the forwarded value.
targetField	Property field in the target argument property type.

◆ addResourceBinding() [1/2]

void kanzi::ForwardingApplyAction::addResourceBinding	(	ResourceID	id,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

Adds a binding from a resource ID to a property.

Use this function to bind resolve resources to a target message argument. You can retrieve the binding by calling getBindingInfo().

Parameters

id	Resource ID.
targetArgument	Target argument property type for the forwarded value.
targetField	Property field in the target argument property type.

◆ addResourceBinding() [2/2]

void kanzi::ForwardingApplyAction::addResourceBinding	(	string_view	id,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

Adds a binding from a resource ID to a property in a node.

Use this function to bind resolve resources to a target message argument. You can retrieve the binding by calling getBindingInfo().

Parameters

id	Name of the resource ID.
targetArgument	Target argument property type for the forwarded value.
targetField	Property field in the target argument property type.

◆ load()

void kanzi::ForwardingApplyAction::load	(	KzbFile &	kzbFile,
		KzbMemoryParser &	parser
	)

overridevirtual

Action::load() implementation.

Reimplemented from kanzi::ActionBase.

◆ getBindingInfo()

optional<BindingInfo> kanzi::ForwardingApplyAction::getBindingInfo ( ) const

Returns the Binding information that this ForwardingApplyAction stores.

Returns: The Binding information that this ForwardingApplyAction stores.

◆ onCopy()

void kanzi::ForwardingApplyAction::onCopy ( const ForwardingApplyAction & other )

protected

Deriving classes must call this function when creating instances of ForwardingApplyAction inside implementations of clone().

Parameters

other Source ForwardingApplyAction from which to copy.

See also: Action::clone()

◆ loadBinding()

void kanzi::ForwardingApplyAction::loadBinding	(	KzbFile &	kzbFile,
		KzbMemoryParser &	parser
	)

protected

Loads a binding from a kzb file.

Parameters

kzbFile	A kzb file from which you want to load a binding.
parser	The kzb file parser to use.

◆ removeBinding()

void kanzi::ForwardingApplyAction::removeBinding ( )

protected

Remove the stored binding information.

Member Data Documentation

◆ m_bindingInfo

optional<BindingInfo> kanzi::ForwardingApplyAction::m_bindingInfo

protected

Binding information to set to a target object on invoke.

The target object is a Node or a RenderPass object.

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

kanzi/ui/action/forwarding_apply_action.hpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ForwardingApplyAction()

Member Function Documentation

◆ addValueBinding()

◆ addArgumentBinding() [1/2]

◆ addArgumentBinding() [2/2]

◆ addPropertyBinding() [1/2]

◆ addPropertyBinding() [2/2]

◆ addResourceBinding() [1/2]

◆ addResourceBinding() [2/2]

◆ load()

◆ getBindingInfo()

◆ onCopy()

◆ loadBinding()

◆ removeBinding()

Member Data Documentation

◆ m_bindingInfo