Use trigger conditions to set which conditions must be met for a Trigger to set off. More...

#include <kanzi/core.ui/condition/expression_condition.hpp>

Inheritance diagram for kanzi::ExpressionCondition:

Public Types
enum	Operand { OperandLHS , OperandRHS }
	Trigger condition operand position. More...

enum	Operation { OperationInvalid , OperationEqual , OperationNotEqual , OperationLess , OperationGreater , OperationLessOrEqual , OperationGreaterOrEqual }
	Trigger condition operation. More...

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

Public Member Functions
ManualBindingRuntimeSharedPtr	getLhsBinding () const
	Returns the binding that encapsulates the left-hand side operand of the condition.

Operation	getOperation () const
	Returns the condition operation.

ManualBindingRuntimeSharedPtr	getRhsBinding () const
	Returns the binding that encapsulates the right-hand side operand of the condition.

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

kzsError	setOperandMessageArgument (Operand operand, AbstractPropertyType messageArgument, PropertyField argumentField)
	Sets an operand in the comparison to be read from the forwarded message from the trigger.

kzsError	setOperandProperty (Operand operand, kzString objectPath, AbstractPropertyType propertyType, PropertyField propertyField)
	Sets an operand in the comparison to be read from an objects property.

kzsError	setOperandValue (Operand operand, const Variant &value)
	Sets an operand in the comparison to be read from a fixed value.

void	setOperation (Operation operation)
	Sets the comparisons operation for the condition. Not all property types support all operations. If the operation is not supported, the condition evaluates to KZ_FALSE.

Public Member Functions inherited from kanzi::Condition
void	attach (Trigger *trigger)
	Attach function for condition.

bool	check ()
	Check function for condition.

ConditionSharedPtr	copy () const

void	detach ()
	Detach function for condition.

Trigger *	getTrigger () const

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

Static Public Member Functions inherited from kanzi::Condition
static ConditionSharedPtr	loadCondition (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)

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 Member Functions
ConditionSharedPtr	clone () const override

	ExpressionCondition (Domain *domain)
	Creates a trigger condition that you can attach to a Trigger.

bool	onCheck () override
	Condition::onCheck() implementation.

void	onCopy (ExpressionCondition const &other)

Protected Member Functions inherited from kanzi::Condition
	Condition (Domain *domain)

virtual void	onAttach ()
	Attach function for condition.

void	onCopy (Condition const &other)

virtual void	onDetach ()
	Detach function for condition.

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
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

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

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

Detailed Description

Use trigger conditions to set which conditions must be met for a Trigger to set off.

For example, you can define conditions to set off a trigger when the user navigates to a specific Page node, enable the user to click a button only when that button is visible, or enable the user to scroll a Scroll View node only when a specific Page node is active.

Member Enumeration Documentation

◆ Operand

enum kanzi::ExpressionCondition::Operand

Trigger condition operand position.

Enumerator
OperandLHS	Left-hand side operand.
OperandRHS	Right-hand side operand.

◆ Operation

enum kanzi::ExpressionCondition::Operation

Trigger condition operation.

Enumerator
OperationInvalid	Invalid comparison.
OperationEqual	Equality comparison.
OperationNotEqual	Inequality comparison.
OperationLess	Less than comparison.
OperationGreater	Greater than comparison.
OperationLessOrEqual	Less than or equal comparison.
OperationGreaterOrEqual	Greater than or equal comparison.

Constructor & Destructor Documentation

◆ ExpressionCondition()

kanzi::ExpressionCondition::ExpressionCondition ( Domain * domain )

explicitprotected

Creates a trigger condition that you can attach to a Trigger.

The trigger condition compares two operands using a specified comparison Operation. To use the trigger condition, you must set both the two operands and the operation.

To set an operand to:

Fixed value, use setOperandValue().
Message argument from the message that the trigger forwards to the condition, use setOperandMessageArgument().
Property value of an object that you specify using a relative path to the trigger object, use setOperandProperty().

To set the comparison operation, use setOperation().

See also: Trigger::addCondition

Member Function Documentation

◆ create()

static ExpressionConditionSharedPtr kanzi::ExpressionCondition::create	(	Domain *	domain,
		string_view	name )

static

◆ setOperation()

void kanzi::ExpressionCondition::setOperation ( Operation operation )

Sets the comparisons operation for the condition. Not all property types support all operations. If the operation is not supported, the condition evaluates to KZ_FALSE.

◆ setOperandValue()

kzsError kanzi::ExpressionCondition::setOperandValue	(	Operand	operand,
		const Variant &	value )

Sets an operand in the comparison to be read from a fixed value.

◆ setOperandMessageArgument()

kzsError kanzi::ExpressionCondition::setOperandMessageArgument	(	Operand	operand,
		AbstractPropertyType	messageArgument,
		PropertyField	argumentField )

Sets an operand in the comparison to be read from the forwarded message from the trigger.

◆ setOperandProperty()

kzsError kanzi::ExpressionCondition::setOperandProperty	(	Operand	operand,
		kzString	objectPath,
		AbstractPropertyType	propertyType,
		PropertyField	propertyField )

Sets an operand in the comparison to be read from an objects property.

◆ load()

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

overridevirtual

Reimplemented from kanzi::Condition.

◆ getLhsBinding()

ManualBindingRuntimeSharedPtr kanzi::ExpressionCondition::getLhsBinding ( ) const

Returns the binding that encapsulates the left-hand side operand of the condition.

◆ getRhsBinding()

ManualBindingRuntimeSharedPtr kanzi::ExpressionCondition::getRhsBinding ( ) const

Returns the binding that encapsulates the right-hand side operand of the condition.

◆ getOperation()

Operation kanzi::ExpressionCondition::getOperation ( ) const

Returns the condition operation.

◆ onCheck()

bool kanzi::ExpressionCondition::onCheck ( )

overrideprotectedvirtual

Condition::onCheck() implementation.

Implements kanzi::Condition.

◆ clone()

ConditionSharedPtr kanzi::ExpressionCondition::clone ( ) const