Action is the base class for objects that execute something when the owning Trigger is activated. More...

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

Inheritance diagram for kanzi::Action:

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

virtual void	load (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

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

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

void	unapplyObjectStyle (AppliedStyleEntry *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 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...

Static Public Attributes
Properties
static PropertyType< int >	DelayProperty
	Delay property. More...

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

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntry * >	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

Action is the base class for objects that execute something when the owning Trigger is activated.

Constructor & Destructor Documentation

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

explicitprotected

Member Function Documentation

string kanzi::Action::getName ( ) const

void kanzi::Action::attach ( Trigger * trigger )

Attaches the action to a trigger.

void kanzi::Action::detach ( )

Detaches the action.

void kanzi::Action::invoke ( )

Invokes the action.

ActionSharedPtr kanzi::Action::copy ( ) const

Create a copy of the action.

Trigger* kanzi::Action::getTrigger ( ) const

Returns the trigger the action is attached to.

chrono::milliseconds kanzi::Action::getDelay ( ) const

inline

void kanzi::Action::setDelay ( chrono::milliseconds delay )

inline

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

virtual

Reimplemented in kanzi::ExecuteScriptAction, kanzi::ForwardingAction, and kanzi::SetPropertyAction.

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

virtual

Reimplemented in kanzi::ExecuteScriptAction, kanzi::ForwardingAction, and kanzi::SetPropertyAction.

static PropertyTypeEditorInfoSharedPtr kanzi::Action::makeEditorInfo ( )

static

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

static

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

static

virtual void kanzi::Action::onAttach ( )

protectedvirtual

Callback called during attach.

Reimplemented in kanzi::ExecuteScriptAction, kanzi::PlayAnimationAction, and kanzi::DispatchMessageAction.

virtual void kanzi::Action::onDetach ( )

protectedvirtual

Callback called during detach.

Reimplemented in kanzi::ExecuteScriptAction, and kanzi::PlayAnimationAction.

virtual void kanzi::Action::onInvoke ( )

protectedvirtual

Callback called during invoke.

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

virtual void kanzi::Action::onPrepareDelayedInvoke ( )

protectedvirtual

Callback called before delayed invoke.

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

virtual void kanzi::Action::onDelayedInvoke ( )

protectedvirtual

Callback called during delayed invoke.

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

virtual void kanzi::Action::onUnprepareDelayedInvoke ( )

protectedvirtual

Callback called after delayed invoke.

virtual ActionSharedPtr kanzi::Action::clone ( ) const

protectedpure virtual

Implemented in kanzi::ExecuteScriptAction, kanzi::PlayAnimationAction, kanzi::SetPropertyAction, and kanzi::DispatchMessageAction.

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

protected

Member Data Documentation

PropertyType<int> kanzi::Action::DelayProperty

static

Delay property.

The default value is 0.

See also: setDelay(), getDelay()

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

kanzi/core.ui/action/action.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation