Message handler trigger. More...

#include <kanzi/core.ui/trigger/message_trigger.hpp>

Inheritance diagram for kanzi::MessageTrigger:

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static MessageTriggerSharedPtr	create (Domain *domain, string_view name)

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

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
	MessageTrigger (Domain *domain, string_view name)

virtual void	attachOverride () KZ_OVERRIDE
	NodeComponent::attachOverride() implementation. More...

virtual void	detachOverride () KZ_OVERRIDE
	NodeComponent::detachOverride() implementation. More...

void	messageNotification (MessageArguments &)

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

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

template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, TClass *nodeComponent, TMethod method)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More...

void	removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
	Removes message handler added via addNodeComponentMessageHandler function. More...

template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More...

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, PropertyStoragePtr &propertyStorage)

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::PropertyStorage &propertyStorage)

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 &otherPropertyStorage)
	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)

Properties
static PropertyType< string >	MessageTypeProperty
	MessageType property. More...

static PropertyType< bool >	SetHandledProperty
	SetHandled property. More...

static PropertyType< MessageRouting >	RoutingModeProperty
	RoutingMode property. More...

static PropertyType< string >	MessageSourceProperty
	MessageSource property. More...

string	getMessageType () const
	Gets the value of MessageTypeProperty. More...

void	setMessageType (string value)
	Sets the value of MessageTypeProperty. More...

bool	isSetHandled () const
	Gets the value of SetHandledProperty. More...

void	setSetHandled (bool value)
	Sets the value of SetHandledProperty. More...

MessageRouting	getRoutingMode () const
	Gets the value of RoutingModeProperty. More...

void	setRoutingMode (MessageRouting value)
	Sets the value of RoutingModeProperty. More...

string	getMessageSource () const
	Gets the value of MessageSourceProperty. More...

void	setMessageSource (string value)
	Sets the value of MessageSourceProperty. More...

Additional Inherited Members
Public Types inherited from kanzi::Trigger
typedef vector< ActionSharedPtr >	ActionContainer

typedef ActionContainer::const_iterator	ActionIterator

typedef vector< ConditionSharedPtr >	ConditionContainer

typedef ConditionContainer::const_iterator	ConditionIterator

Public Types inherited from kanzi::NodeComponent
enum	State { StateDetached, StateDetaching, StateAttaching, StateAttached }
	State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...

typedef NodeComponentTargetMessageArguments	NodeComponentMessageArguments
	Legacy name for NodeComponentTargetMessageArguments. More...

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 inherited from kanzi::Trigger
TriggerSharedPtr	copy () const
	Creates a copy of trigger. More...

void	addAction (ActionSharedPtr action)
	Adds an action to the trigger. More...

void	invokeActions () const
	Invokes actions in the trigger. More...

ActionIterator	beginActions () const

ActionIterator	endActions () const

void	addCondition (ConditionSharedPtr condition)
	Adds a condition to the trigger. More...

bool	checkConditions () const
	Checks against all conditions in the trigger. More...

ConditionIterator	beginConditions () const

ConditionIterator	endConditions () const

void *	getForwardedMessage () const
	Gets the value of ForwardedMessageProperty. More...

void	setForwardedMessage (void *value)
	Sets the value of ForwardedMessageProperty. More...

Public Member Functions inherited from kanzi::NodeComponent
virtual	~NodeComponent ()
	Destructor. More...

void	setName (string_view name)
	Sets the name of node component. More...

string	getName () const
	Gets the name of node component. More...

NodeSharedPtr	getNode () const
	Returns the node the node component is attached to or null pointer if node component is not attached to a node. More...

void	attach (NodeWeakPtr node)
	Attaches node component to node. More...

void	detach ()
	Detaches node component from the node it was attached to. More...

State	getState () const
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...

bool	isAttaching () const
	Indicates whether node component is in the process of attaching to a node. More...

bool	isAttached () const
	Indicates whether node component is attached to a node. More...

bool	isAttachingOrAttached () const
	Indicates whether node component is in the process of attaching to a node or already attached. More...

bool	isDetaching () const
	Indicates whether node component currently detaching from the node. More...

bool	isDetached () const
	Indicates whether node component is detached from any node. More...

bool	isDetachingOrDetached () const
	Indicates whether node component is in the process of detaching from the node or already detached. More...

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 Attributes inherited from kanzi::Trigger
static PropertyType< void * >	ForwardedMessageProperty
	ForwardedMessage property. More...

Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string >	NameProperty
	Name property specifies the name of node component. More...

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

Static Protected Member Functions inherited from kanzi::Trigger
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
static void	nodeComponentMessageHandler (TClass *nodeComponent, TMethod method, typename TMessageType::ArgumentsType &messageArguments)
	Handler function for node component messages. More...

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