A class that is able to read arguments from message and translates them to action arguments. More...

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

Inheritance diagram for kanzi::ForwardingAction:

Public Types
typedef map< AbstractPropertyType, BindingSharedPtr >	BindingContainer

typedef BindingContainer::const_iterator	BindingConstIterator

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
BindingSharedPtr	addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument)
	Add binding from value to object node or message argument. More...

BindingSharedPtr	addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField)
	Add binding from value to object node or message argument. More...

BindingSharedPtr	addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument)
	Add binding from message argument to object node or message argument. More...

BindingSharedPtr	addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Add binding from message argument to object node or message argument. More...

BindingSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument)
	Add binding from property to object node or message argument. More...

BindingSharedPtr	addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField)
	Add binding from property to object node or message argument. More...

BindingConstIterator	beginBindings () const

BindingConstIterator	endBindings () const

virtual void	load (KzcInputStream inputStream, const KzuBinaryFileInfo file) KZ_OVERRIDE

virtual void	load (KzbFile &kzbFile, KzbMemoryParser &parser) KZ_OVERRIDE

Public Member Functions inherited from kanzi::Action
string	getName () const

void	attach (Trigger *trigger)
	Attaches the action to a trigger. More...

void	detach ()
	Detaches the action. More...

void	invoke ()
	Invokes the action. More...

ActionSharedPtr	copy () const
	Create a copy of the action. More...

Trigger *	getTrigger () const
	Returns the trigger the action is attached to. More...

chrono::milliseconds	getDelay () const

void	setDelay (chrono::milliseconds delay)

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...

void	removeKzbProperties ()

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

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 >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. 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...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

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...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void owner)

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Static Public Member Functions
static ForwardingActionSharedPtr	create (Domain *domain, string_view name)

Static Public Member Functions inherited from kanzi::Action
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static ActionSharedPtr	loadAction (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file)

static ActionSharedPtr	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)

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 Member Functions
	ForwardingAction (Domain *domain, string_view name)
	Create a set property action. More...

BindingSharedPtr	loadBinding (KzcInputStream inputStream, const KzuBinaryFileInfo file)
	Loads binding object from binary. More...

BindingSharedPtr	loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser)

void	addBinding (AbstractPropertyType argumentType, BindingSharedPtr binding)
	Adds binding object to action. More...

void	removeBinding (AbstractPropertyType argumentType)
	Removes binding object from action. More...

void	removeAllBindings ()
	Removes all binding objects from this action. More...

void	onCopy (const ForwardingAction &other)

Variant	getArgument (AbstractPropertyType argumentType)

void	setSource (BindingSharedPtr binding, const Variant &sourceValue)
	Called when value binding is added. More...

void	setSource (BindingSharedPtr binding, AbstractPropertyType sourceArgument, PropertyField sourceField)
	Called when argument binding is added. More...

void	setSource (BindingSharedPtr binding, string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField)
	Called when property binding is added. More...

virtual void	setTarget (BindingSharedPtr, AbstractPropertyType targetArgument, PropertyField targetField)
	Called when binding is added, does nothing by default but allows derived classes to set the binding target. More...

Protected Member Functions inherited from kanzi::Action
	Action (Domain *domain, string_view name)

virtual void	onAttach ()
	Callback called during attach. More...

virtual void	onDetach ()
	Callback called during detach. More...

virtual void	onInvoke ()
	Callback called during invoke. More...

virtual void	onPrepareDelayedInvoke ()
	Callback called before delayed invoke. More...

virtual void	onDelayedInvoke ()
	Callback called during delayed invoke. More...

virtual void	onUnprepareDelayedInvoke ()
	Callback called after delayed invoke. More...

virtual ActionSharedPtr	clone () const =0

void	onCopy (const Action &other)

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

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

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Additional Inherited Members
Static Public Attributes inherited from kanzi::Action
static PropertyType< int >	DelayProperty
	Delay property. More...

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

A class that is able to read arguments from message and translates them to action arguments.

It is then possible for the action to decide what to do with the arguments. It is possible for example to utilize the action arguments to set a property of a node or to dispatch a message containing a value of the action argument.

Member Typedef Documentation

typedef map<AbstractPropertyType, BindingSharedPtr> kanzi::ForwardingAction::BindingContainer

typedef BindingContainer::const_iterator kanzi::ForwardingAction::BindingConstIterator

Constructor & Destructor Documentation

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

explicitprotected

Create a set property action.

Member Function Documentation

static ForwardingActionSharedPtr kanzi::ForwardingAction::create	(	Domain *	domain,
		string_view	name
	)

static

BindingSharedPtr kanzi::ForwardingAction::addValueBinding	(	const Variant &	sourceValue,
		AbstractPropertyType	targetArgument
	)

Add binding from value to object node or message argument.

Parameters

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

Returns: The created binding object.

BindingSharedPtr kanzi::ForwardingAction::addValueBinding	(	const Variant &	sourceValue,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

Add binding from value to object node or message argument.

Parameters

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

Returns: The created binding object.

BindingSharedPtr kanzi::ForwardingAction::addArgumentBinding	(	AbstractPropertyType	sourceArgument,
		AbstractPropertyType	targetArgument
	)

Add binding from message argument to object node or message argument.

Parameters

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

Returns: The created binding object.

BindingSharedPtr kanzi::ForwardingAction::addArgumentBinding	(	AbstractPropertyType	sourceArgument,
		PropertyField	sourceField,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

Add binding from message argument to object node or message argument.

Parameters

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

Returns: The created binding object.

BindingSharedPtr kanzi::ForwardingAction::addPropertyBinding	(	string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		AbstractPropertyType	targetArgument
	)

Add binding from property to object node or message argument.

Parameters

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

Returns: The created binding object.

BindingSharedPtr kanzi::ForwardingAction::addPropertyBinding	(	string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		PropertyField	sourceField,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

Add binding from property to object node or message argument.

Parameters

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

Returns: The created binding object.

BindingConstIterator kanzi::ForwardingAction::beginBindings ( ) const

BindingConstIterator kanzi::ForwardingAction::endBindings ( ) const

virtual void kanzi::ForwardingAction::load	(	KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

Reimplemented from kanzi::Action.

Reimplemented in kanzi::SetPropertyAction.

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

virtual

Reimplemented from kanzi::Action.

Reimplemented in kanzi::SetPropertyAction.

BindingSharedPtr kanzi::ForwardingAction::loadBinding	(	KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

protected

Loads binding object from binary.

Parameters

inputStream	The input stream.
file	The binary file.

Returns: The binding object that was loaded.

BindingSharedPtr kanzi::ForwardingAction::loadBinding	(	KzbFile &	kzbFile,
		KzbMemoryParser &	parser
	)

protected

void kanzi::ForwardingAction::addBinding	(	AbstractPropertyType	argumentType,
		BindingSharedPtr	binding
	)

protected

Adds binding object to action.

Parameters

argumentType	Type of the argument.
binding	Binding object to add.

void kanzi::ForwardingAction::removeBinding ( AbstractPropertyType argumentType )

protected

Removes binding object from action.

Parameters

argumentType Type of the argument to remove.

void kanzi::ForwardingAction::removeAllBindings ( )

protected

Removes all binding objects from this action.

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

protected

Variant kanzi::ForwardingAction::getArgument ( AbstractPropertyType argumentType )

protected

void kanzi::ForwardingAction::setSource	(	BindingSharedPtr	binding,
		const Variant &	sourceValue
	)

protected

Called when value binding is added.

void kanzi::ForwardingAction::setSource	(	BindingSharedPtr	binding,
		AbstractPropertyType	sourceArgument,
		PropertyField	sourceField
	)

protected

Called when argument binding is added.

void kanzi::ForwardingAction::setSource	(	BindingSharedPtr	binding,
		string_view	sourceObjectPath,
		AbstractPropertyType	sourcePropertyType,
		PropertyField	sourceField
	)

protected

Called when property binding is added.

virtual void kanzi::ForwardingAction::setTarget	(	BindingSharedPtr	,
		AbstractPropertyType	targetArgument,
		PropertyField	targetField
	)

protectedvirtual

Called when binding is added, does nothing by default but allows derived classes to set the binding target.

Reimplemented in kanzi::SetPropertyAction, and kanzi::DispatchMessageAction.

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

kanzi/core.ui/action/forwarding_action.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation