Kanzi  3.9.4
Kanzi Engine API
kanzi::VariableBindingSource Class Reference

Variable binding source. More...

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

Inheritance diagram for kanzi::VariableBindingSource:
[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::BindingSource
BindingSourceRuntimePtr createRuntime (BindingLookupContextPtr lookupContext)
 Creates binding source runtime. More...
 
virtual ~BindingSource ()
 Destructor. More...
 

Static Public Member Functions

static BindingSourcePtr create (AbstractPropertyType propertyType, PropertyField field)
 Creates a variable binding source. More...
 
static BindingSourcePtr create (AbstractPropertyType propertyType)
 Creates a variable binding source. More...
 

Protected Member Functions

BindingSourceRuntimePtr createRuntimeOverride (BindingLookupContextPtr lookupContext) override
 BindingSource::createRuntime implementation. More...
 
 VariableBindingSource (AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingSource
 BindingSource ()
 Constructor. More...
 

Protected Attributes

PropertyField m_field
 Source property field. More...
 
AbstractPropertyType m_propertyType
 Source property type. More...
 

Detailed Description

Variable binding source.

VariableBindingSource binds to a VariableBindingTargetRuntime in a context that holds variable binding targets. This mechanism is intended to allow bindings to be used in a binding host that is not a PropertyObject to avoid the overhead of PropertyObject interface. There is no property object to store the value to - the variable bound to is the exact VariableBindingTargetRuntime itself.

See also
RenderEntry3D
Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ VariableBindingSource()

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

Constructor.

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

Member Function Documentation

◆ create() [1/2]

static BindingSourcePtr kanzi::VariableBindingSource::create ( AbstractPropertyType  propertyType,
PropertyField  field 
)
static

Creates a variable binding source.

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

◆ create() [2/2]

static BindingSourcePtr kanzi::VariableBindingSource::create ( AbstractPropertyType  propertyType)
inlinestatic

Creates a variable binding source.

Uses whole property value.

Parameters
propertyTypeProperty type to listen to.

◆ getPropertyType()

AbstractPropertyType kanzi::VariableBindingSource::getPropertyType ( ) const
inline

Gets the source property type.

Returns
Property type.

◆ getPropertyField()

PropertyField kanzi::VariableBindingSource::getPropertyField ( ) const
inline

Gets the source property field.

Returns
Property field.

◆ createRuntimeOverride()

BindingSourceRuntimePtr kanzi::VariableBindingSource::createRuntimeOverride ( BindingLookupContextPtr  lookupContext)
overrideprotectedvirtual

Member Data Documentation

◆ m_propertyType

AbstractPropertyType kanzi::VariableBindingSource::m_propertyType
protected

Source property type.

◆ m_field

PropertyField kanzi::VariableBindingSource::m_field
protected

Source property field.


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