Kanzi  3.9.5
Kanzi Engine API
kanzi::ExpressionCondition Class Reference

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:
[legend]

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< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

ManualBindingRuntimeSharedPtr getLhsBinding () const
 Returns the binding that encapsulates the left-hand side operand of the condition. More...
 
Operation getOperation () const
 Returns the condition operation. More...
 
ManualBindingRuntimeSharedPtr getRhsBinding () const
 Returns the binding that encapsulates the right-hand side operand of the condition. More...
 
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. 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...
 
kzsError setOperandValue (Operand operand, const Variant &value)
 Sets an operand in the comparison to be read from a fixed value. More...
 
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...
 
- Public Member Functions inherited from kanzi::Condition
void attach (Trigger *trigger)
 Attach function for condition. More...
 
bool check ()
 Check function for condition. More...
 
ConditionSharedPtr copy () const
 
void detach ()
 Detach function for condition. More...
 
TriggergetTrigger () const
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~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. More...
 
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 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, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
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...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
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. More...
 
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. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. 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 >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. 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...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
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. More...
 
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. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
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 MetaclassgetStaticMetaclass ()
 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 MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

ConditionSharedPtr clone () const override
 
 ExpressionCondition (Domain *domain)
 Creates a trigger condition that you can attach to a Trigger. More...
 
bool onCheck () override
 Condition::onCheck() implementation. More...
 
void onCopy (ExpressionCondition const &other)
 
- Protected Member Functions inherited from kanzi::Condition
 Condition (Domain *domain)
 
virtual void onAttach ()
 Attach function for condition. More...
 
void onCopy (Condition const &other)
 
virtual void onDetach ()
 Detach function for condition. More...
 
- 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::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 

Additional Inherited Members

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

◆ Operand

Trigger condition operand position.

Enumerator
OperandLHS 

Left-hand side operand.

OperandRHS 

Right-hand side operand.

◆ 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:

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
overrideprotectedvirtual

Implements kanzi::Condition.

◆ onCopy()

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

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