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

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

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

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

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::Condition
void	attach (Trigger *trigger)
	Attach function for condition. More...

void	detach ()
	Detach function for condition. More...

bool	check ()
	Check function for condition. More...

ConditionSharedPtr	copy () const

Trigger *	getTrigger () const

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

Static Public Member Functions inherited from kanzi::Condition
static ConditionSharedPtr	loadCondition (KzcInputStream inputStream, Domain domain, const KzuBinaryFileInfo *file)

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. 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
	ExpressionCondition (Domain *domain)
	Creates a trigger condition that you can attach to a Trigger. More...

virtual bool	onCheck () KZ_OVERRIDE
	Check function for condition. More...

virtual ConditionSharedPtr	clone () const KZ_OVERRIDE

void	onCopy (ExpressionCondition const &other)

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

virtual void	onAttach ()
	Attach function for condition. More...

virtual void	onDetach ()
	Detach function for condition. More...

void	onCopy (Condition const &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, 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)

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

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

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

enum kanzi::ExpressionCondition::Operand

Trigger condition operand position.

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

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

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

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

static

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.

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

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

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.

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.

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

virtual

Reimplemented from kanzi::Condition.

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

virtual

Reimplemented from kanzi::Condition.

virtual bool kanzi::ExpressionCondition::onCheck ( )

protectedvirtual

Check function for condition.

Implements kanzi::Condition.

virtual ConditionSharedPtr kanzi::ExpressionCondition::clone ( ) const

protectedvirtual

Implements kanzi::Condition.

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

protected

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

kanzi/core.ui/condition/expression_condition.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation