All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::ExpressionBindingProcessor Class Reference

Expression validator. More...

#include <kanzi/binding/expression_binding_processor.hpp>

Inheritance diagram for kanzi::ExpressionBindingProcessor:
kanzi::BindingProcessor kanzi::Object

Public Member Functions

int getArgument1 () const
 Gets the value of Argument1Property. More...
 
void setArgument1 (int value)
 Sets the value of Argument1Property. More...
 
KzuPropertyBinaryTargetAttribute getArgument1Field () const
 Gets the value of Argument1FieldProperty. More...
 
void setArgument1Field (KzuPropertyBinaryTargetAttribute value)
 Sets the value of Argument1FieldProperty. More...
 
int getArgument2 () const
 Gets the value of Argument2Property. More...
 
void setArgument2 (int value)
 Sets the value of Argument2Property. More...
 
KzuPropertyBinaryTargetAttribute getArgument2Field () const
 Gets the value of Argument2FieldProperty. More...
 
void setArgument2Field (KzuPropertyBinaryTargetAttribute value)
 Sets the value of Argument2FieldProperty. More...
 
KzuExpressionValidatorOperation getOperation () const
 Gets the value of OperationProperty. More...
 
void setOperation (KzuExpressionValidatorOperation value)
 Sets the value of OperationProperty. More...
 
KzuPropertyBinaryTargetAttribute getOutputField () const
 Gets the value of OutputFieldProperty. More...
 
void setOutputField (KzuPropertyBinaryTargetAttribute value)
 Sets the value of OutputFieldProperty. More...
 
int getOutput () const
 Gets the value of OutputProperty. More...
 
void setOutput (int value)
 Sets the value of OutputProperty. More...
 
virtual ~ExpressionBindingProcessor ()
 
- Public Member Functions inherited from kanzi::BindingProcessor
void attach (Binding *rule)
 Attach binding processor. More...
 
void detach ()
 Detach binding processor. More...
 
void reattach ()
 Reattach a binding validator to the rule it already was in. More...
 
bool validate (Variant &value)
 Validates binding processor. More...
 
BindingProcessorSharedPtr copy ()
 Copy a validator. More...
 
virtual void load (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuPropertyManager * getPropertyManager () const
 Returns the property manager of the object. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const
 Returns the metaclass of the dynamic type of the object. More...
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
 Sets the local value of a property. More...
 
void setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
 Sets the local value of a resource id property with a resource pointer. More...
 
template<typename DataType >
DataType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
bool getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)
 
void setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
bool getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValues (const Object &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 

Static Public Member Functions

static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 
static
ExpressionBindingProcessorSharedPtr 
create (Domain *domain, string_view name)
 
- 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...
 

Public Attributes

Variant targetValue
 Target value. More...
 
const VariantfirstArgumentRegister
 Register for first argument to validator function. More...
 
const VariantsecondArgumentRegister
 Register for second argument to validator function. More...
 
VariantoutputRegister
 Register for output argument of validator function. More...
 
PropertyField firstArgumentField
 Cached first argument field. More...
 
PropertyField secondArgumentField
 Cached second argument field. More...
 
PropertyField outputField
 Cached output field. More...
 
KzuExpressionValidatorFunction validatorFunction
 Validator function pointer. More...
 
kzBool requiresTargetRead
 Does target value need to be read when evaluating. More...
 
- Public Attributes inherited from kanzi::BindingProcessor
Bindingm_rule
 Binding rule. More...
 

Static Public Attributes

static PropertyType< int > Argument1Property
 Argument1 property. More...
 
static PropertyType
< KzuPropertyBinaryTargetAttribute
Argument1FieldProperty
 Argument1Field property. More...
 
static PropertyType< int > Argument2Property
 Argument2 property. More...
 
static PropertyType
< KzuPropertyBinaryTargetAttribute
Argument2FieldProperty
 Argument2Field property. More...
 
static PropertyType
< KzuExpressionValidatorOperation
OperationProperty
 Operation property. More...
 
static PropertyType
< KzuPropertyBinaryTargetAttribute
OutputFieldProperty
 OutputField property. More...
 
static PropertyType< int > OutputProperty
 Output property. More...
 

Protected Member Functions

 ExpressionBindingProcessor (Domain *domain)
 
virtual void onAttach () KZ_OVERRIDE
 Base attach implementation. More...
 
virtual bool onValidate (Variant &sourceValue) KZ_OVERRIDE
 Validate function. More...
 
virtual BindingProcessorSharedPtr clone () const KZ_OVERRIDE
 
- Protected Member Functions inherited from kanzi::BindingProcessor
 BindingProcessor (Domain *domain)
 
virtual void onDetach ()
 Detach function for binding validators. More...
 
virtual void onCopy (BindingProcessor const &other)
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector
< AppliedStyleEntry * > 
AppliedStyleContainer
 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 validator.

Constructor & Destructor Documentation

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

Member Function Documentation

int kanzi::ExpressionBindingProcessor::getArgument1 ( ) const
inline

Gets the value of Argument1Property.

See also
setArgument1()
void kanzi::ExpressionBindingProcessor::setArgument1 ( int  value)
inline

Sets the value of Argument1Property.

See also
getArgument1()
KzuPropertyBinaryTargetAttribute kanzi::ExpressionBindingProcessor::getArgument1Field ( ) const
inline

Gets the value of Argument1FieldProperty.

See also
setArgument1Field()
void kanzi::ExpressionBindingProcessor::setArgument1Field ( KzuPropertyBinaryTargetAttribute  value)
inline

Sets the value of Argument1FieldProperty.

See also
getArgument1Field()
int kanzi::ExpressionBindingProcessor::getArgument2 ( ) const
inline

Gets the value of Argument2Property.

See also
setArgument2()
void kanzi::ExpressionBindingProcessor::setArgument2 ( int  value)
inline

Sets the value of Argument2Property.

See also
getArgument2()
KzuPropertyBinaryTargetAttribute kanzi::ExpressionBindingProcessor::getArgument2Field ( ) const
inline

Gets the value of Argument2FieldProperty.

See also
setArgument2Field()
void kanzi::ExpressionBindingProcessor::setArgument2Field ( KzuPropertyBinaryTargetAttribute  value)
inline

Sets the value of Argument2FieldProperty.

See also
getArgument2Field()
KzuExpressionValidatorOperation kanzi::ExpressionBindingProcessor::getOperation ( ) const
inline

Gets the value of OperationProperty.

See also
setOperation()
void kanzi::ExpressionBindingProcessor::setOperation ( KzuExpressionValidatorOperation  value)
inline

Sets the value of OperationProperty.

See also
getOperation()
KzuPropertyBinaryTargetAttribute kanzi::ExpressionBindingProcessor::getOutputField ( ) const
inline

Gets the value of OutputFieldProperty.

See also
setOutputField()
void kanzi::ExpressionBindingProcessor::setOutputField ( KzuPropertyBinaryTargetAttribute  value)
inline

Sets the value of OutputFieldProperty.

See also
getOutputField()
int kanzi::ExpressionBindingProcessor::getOutput ( ) const
inline

Gets the value of OutputProperty.

See also
setOutput()
void kanzi::ExpressionBindingProcessor::setOutput ( int  value)
inline

Sets the value of OutputProperty.

See also
getOutput()
static PropertyTypeEditorInfoSharedPtr kanzi::ExpressionBindingProcessor::makeEditorInfo ( )
static
static ExpressionBindingProcessorSharedPtr kanzi::ExpressionBindingProcessor::create ( Domain domain,
string_view  name 
)
static
virtual void kanzi::ExpressionBindingProcessor::onAttach ( )
protectedvirtual

Base attach implementation.

Reimplemented from kanzi::BindingProcessor.

virtual bool kanzi::ExpressionBindingProcessor::onValidate ( Variant value)
protectedvirtual

Validate function.

Implements kanzi::BindingProcessor.

virtual BindingProcessorSharedPtr kanzi::ExpressionBindingProcessor::clone ( ) const
protectedvirtual

Member Data Documentation

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

Argument1 property.

The default value is 0.

See also
setArgument1(), getArgument1()
PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::ExpressionBindingProcessor::Argument1FieldProperty
static

Argument1Field property.

The default value is KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY.

See also
setArgument1Field(), getArgument1Field()
PropertyType<int> kanzi::ExpressionBindingProcessor::Argument2Property
static

Argument2 property.

The default value is 0.

See also
setArgument2(), getArgument2()
PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::ExpressionBindingProcessor::Argument2FieldProperty
static

Argument2Field property.

The default value is KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY.

See also
setArgument2Field(), getArgument2Field()
PropertyType<KzuExpressionValidatorOperation> kanzi::ExpressionBindingProcessor::OperationProperty
static

Operation property.

The default value is KZU_EXPRESSION_VALIDATOR_OPERATION_ADD.

See also
setOperation(), getOperation()
PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::ExpressionBindingProcessor::OutputFieldProperty
static

OutputField property.

The default value is KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY.

See also
setOutputField(), getOutputField()
PropertyType<int> kanzi::ExpressionBindingProcessor::OutputProperty
static

Output property.

The default value is 0.

See also
setOutput(), getOutput()
Variant kanzi::ExpressionBindingProcessor::targetValue

Target value.

const Variant* kanzi::ExpressionBindingProcessor::firstArgumentRegister

Register for first argument to validator function.

const Variant* kanzi::ExpressionBindingProcessor::secondArgumentRegister

Register for second argument to validator function.

Variant* kanzi::ExpressionBindingProcessor::outputRegister

Register for output argument of validator function.

PropertyField kanzi::ExpressionBindingProcessor::firstArgumentField

Cached first argument field.

PropertyField kanzi::ExpressionBindingProcessor::secondArgumentField

Cached second argument field.

PropertyField kanzi::ExpressionBindingProcessor::outputField

Cached output field.

KzuExpressionValidatorFunction kanzi::ExpressionBindingProcessor::validatorFunction

Validator function pointer.

kzBool kanzi::ExpressionBindingProcessor::requiresTargetRead

Does target value need to be read when evaluating.


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