Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::VariableExpressionValueSource Class Reference

Variable expression value source. More...

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

Inheritance diagram for kanzi::VariableExpressionValueSource:
[legend]

Public Member Functions

PropertyField getPropertyField () const
 Gets the source property field. More...
 
AbstractPropertyType getPropertyType () const
 Gets the source property type. More...
 
- Public Member Functions inherited from kanzi::AbstractExpressionValueSource
BindingSourcePtr convertToBindingSource ()
 Converts this expression value source to a matching binding source. More...
 
AbstractExpressionValueSourceRuntimePtr createRuntime (ExpressionBindingSourceRuntime &host)
 Creates a runtime for this expression value source. More...
 
virtual ~AbstractExpressionValueSource ()
 Destructor. More...
 

Static Public Member Functions

static VariableExpressionValueSourceSharedPtr create (AbstractPropertyType propertyType, PropertyField field)
 Creates a variable expression value source. More...
 
static VariableExpressionValueSourceSharedPtr create (AbstractPropertyType propertyType)
 Creates a variable expression value source. More...
 

Protected Member Functions

BindingSourcePtr convertToBindingSourceOverride () override
 AbstractExpressionValueSource::convertToBindingSourceOverride() implementation. More...
 
AbstractExpressionValueSourceRuntimePtr createRuntimeOverride (ExpressionBindingSourceRuntime &host) override
 AbstractExpressionValueSource::createRuntimeOverride() implementation. More...
 
 VariableExpressionValueSource (AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractExpressionValueSource
 AbstractExpressionValueSource ()
 Constructor. More...
 

Protected Attributes

PropertyField m_field
 Property field to read when property is changed. More...
 
AbstractPropertyType m_propertyType
 Property type to listen to. More...
 

Detailed Description

Variable expression value source.

Reads a variable in a variable host.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

kanzi::VariableExpressionValueSource::VariableExpressionValueSource ( AbstractPropertyType  propertyType,
PropertyField  field 
)
inlineprotected

Constructor.

Parameters
propertyTypeProperty type to listen to.
fieldProperty field to read.

Member Function Documentation

static VariableExpressionValueSourceSharedPtr kanzi::VariableExpressionValueSource::create ( AbstractPropertyType  propertyType,
PropertyField  field 
)
static

Creates a variable expression value source.

Parameters
propertyTypeProperty type to listen to.
fieldProperty field to read.
Returns
Newly created object property expression value source.
static VariableExpressionValueSourceSharedPtr kanzi::VariableExpressionValueSource::create ( AbstractPropertyType  propertyType)
inlinestatic

Creates a variable expression value source.

Uses the whole property.

Parameters
propertyTypeProperty type to listen to.
Returns
Newly created object property expression value source.
AbstractPropertyType kanzi::VariableExpressionValueSource::getPropertyType ( ) const
inline

Gets the source property type.

Returns
Property type.
PropertyField kanzi::VariableExpressionValueSource::getPropertyField ( ) const
inline

Gets the source property field.

Returns
Property field.
AbstractExpressionValueSourceRuntimePtr kanzi::VariableExpressionValueSource::createRuntimeOverride ( ExpressionBindingSourceRuntime host)
overrideprotectedvirtual
BindingSourcePtr kanzi::VariableExpressionValueSource::convertToBindingSourceOverride ( )
overrideprotectedvirtual

Member Data Documentation

AbstractPropertyType kanzi::VariableExpressionValueSource::m_propertyType
protected

Property type to listen to.

PropertyField kanzi::VariableExpressionValueSource::m_field
protected

Property field to read when property is changed.


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