Kanzi  3.9.5
Kanzi Engine API
kanzi::ExpressionBindingProcessor Class Reference

Expression binding processor. More...

#include <kanzi/core.ui/binding/expression_binding_processor.hpp>

Inheritance diagram for kanzi::ExpressionBindingProcessor:
[legend]

Public Member Functions

 ~ExpressionBindingProcessor () override=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::BindingProcessor
BindingProcessorRuntimePtr createRuntime ()
 Creates a runtime for the binding processor. More...
 
virtual ~BindingProcessor ()=default
 Destructor. More...
 
- 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 ExpressionBindingProcessorSharedPtr create (Domain *, string_view)
 ExpressionBindingProcessor is legacy code and should be removed. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- 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...
 

Public Attributes

PropertyField firstArgumentField
 Cached first argument field. More...
 
const VariantfirstArgumentRegister
 Register for first argument to processor function. More...
 
PropertyField outputField
 Cached output field. More...
 
VariantoutputRegister
 Register for output argument of processor function. More...
 
BindingExpressionFunction processorFunction
 Expression function pointer. More...
 
bool requiresTargetRead
 Does target value need to be read when evaluating. More...
 
PropertyField secondArgumentField
 Cached second argument field. More...
 
const VariantsecondArgumentRegister
 Register for second argument to processor function. More...
 
Variant targetValue
 Target value. More...
 
PropertyField thirdArgumentField
 Cached third argument field. More...
 
const VariantthirdArgumentRegister
 Register for third argument to processor function. More...
 

Static Public Attributes

Properties
static PropertyType< int > Argument1Property
 Argument1 property. More...
 
static PropertyType< KzuPropertyBinaryTargetAttributeArgument1FieldProperty
 Argument1Field property. More...
 
static PropertyType< int > Argument2Property
 Argument2 property. More...
 
static PropertyType< KzuPropertyBinaryTargetAttributeArgument2FieldProperty
 Argument2Field property. More...
 
static PropertyType< int > Argument3Property
 Argument3 property. More...
 
static PropertyType< KzuPropertyBinaryTargetAttributeArgument3FieldProperty
 Argument3Field property. More...
 
static PropertyType< KzuExpressionValidatorOperationOperationProperty
 Operation property. More...
 
static PropertyType< KzuPropertyBinaryTargetAttributeOutputFieldProperty
 OutputField property. More...
 
static PropertyType< int > OutputProperty
 Output property. More...
 

Protected Member Functions

 ExpressionBindingProcessor (Domain *domain)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingProcessor
 BindingProcessor (Domain *domain)
 Constructor. More...
 
virtual BindingProcessorRuntimePtr createRuntimeOverride ()=0
 Virtual method for creating a runtime for the binding processor. 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

- 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
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::BindingProcessor
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Expression binding processor.

Superseded by BindingExpressionOpCode.

Constructor & Destructor Documentation

◆ ~ExpressionBindingProcessor()

kanzi::ExpressionBindingProcessor::~ExpressionBindingProcessor ( )
overridedefault

Destructor.

◆ ExpressionBindingProcessor()

kanzi::ExpressionBindingProcessor::ExpressionBindingProcessor ( Domain domain)
explicitprotected

Constructor.

Parameters
domainDomain to use.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ExpressionBindingProcessor::makeEditorInfo ( )
static

◆ create()

static ExpressionBindingProcessorSharedPtr kanzi::ExpressionBindingProcessor::create ( Domain ,
string_view   
)
inlinestatic

ExpressionBindingProcessor is legacy code and should be removed.

Returns
nullptr.

Member Data Documentation

◆ Argument1Property

PropertyType<int> kanzi::ExpressionBindingProcessor::Argument1Property
static

Argument1 property.

The default value is 0.

◆ Argument1FieldProperty

PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::ExpressionBindingProcessor::Argument1FieldProperty
static

Argument1Field property.

The default value is KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY.

◆ Argument2Property

PropertyType<int> kanzi::ExpressionBindingProcessor::Argument2Property
static

Argument2 property.

The default value is 0.

◆ Argument2FieldProperty

PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::ExpressionBindingProcessor::Argument2FieldProperty
static

Argument2Field property.

The default value is KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY.

◆ Argument3Property

PropertyType<int> kanzi::ExpressionBindingProcessor::Argument3Property
static

Argument3 property.

The default value is 0.

◆ Argument3FieldProperty

PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::ExpressionBindingProcessor::Argument3FieldProperty
static

Argument3Field property.

The default value is KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY.

◆ OperationProperty

PropertyType<KzuExpressionValidatorOperation> kanzi::ExpressionBindingProcessor::OperationProperty
static

Operation property.

The default value is KZU_EXPRESSION_VALIDATOR_OPERATION_ADD.

◆ OutputFieldProperty

PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::ExpressionBindingProcessor::OutputFieldProperty
static

OutputField property.

The default value is KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY.

◆ OutputProperty

PropertyType<int> kanzi::ExpressionBindingProcessor::OutputProperty
static

Output property.

The default value is 0.

◆ targetValue

Variant kanzi::ExpressionBindingProcessor::targetValue

Target value.

◆ firstArgumentRegister

const Variant* kanzi::ExpressionBindingProcessor::firstArgumentRegister

Register for first argument to processor function.

◆ secondArgumentRegister

const Variant* kanzi::ExpressionBindingProcessor::secondArgumentRegister

Register for second argument to processor function.

◆ thirdArgumentRegister

const Variant* kanzi::ExpressionBindingProcessor::thirdArgumentRegister

Register for third argument to processor function.

◆ outputRegister

Variant* kanzi::ExpressionBindingProcessor::outputRegister

Register for output argument of processor function.

◆ firstArgumentField

PropertyField kanzi::ExpressionBindingProcessor::firstArgumentField

Cached first argument field.

◆ secondArgumentField

PropertyField kanzi::ExpressionBindingProcessor::secondArgumentField

Cached second argument field.

◆ thirdArgumentField

PropertyField kanzi::ExpressionBindingProcessor::thirdArgumentField

Cached third argument field.

◆ outputField

PropertyField kanzi::ExpressionBindingProcessor::outputField

Cached output field.

◆ processorFunction

BindingExpressionFunction kanzi::ExpressionBindingProcessor::processorFunction

Expression function pointer.

◆ requiresTargetRead

bool kanzi::ExpressionBindingProcessor::requiresTargetRead

Does target value need to be read when evaluating.


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