Kanzi  3.9.4
Kanzi Engine API
kanzi::RenderPropertyBindingSource Class Reference

Render property binding source. More...

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

Inheritance diagram for kanzi::RenderPropertyBindingSource:
[legend]

Public Member Functions

string getPath () const
 Gets the path to object. 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 (string_view path, AbstractPropertyType propertyType)
 Creates an render property binding source. More...
 

Protected Member Functions

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

Protected Attributes

string m_path
 Path to look up. More...
 
AbstractPropertyType m_propertyType
 Property type to read. More...
 

Detailed Description

Render property binding source.

Render property binding source is used to read values into bindings associated with render states only reading from node properties.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ RenderPropertyBindingSource()

kanzi::RenderPropertyBindingSource::RenderPropertyBindingSource ( string_view  path,
AbstractPropertyType  propertyType 
)
inlineexplicitprotected

Constructor.

Parameters
pathPath to object.
propertyTypeProperty type to listen to.

Member Function Documentation

◆ create()

static BindingSourcePtr kanzi::RenderPropertyBindingSource::create ( string_view  path,
AbstractPropertyType  propertyType 
)
static

Creates an render property binding source.

Parameters
pathPath to object.
propertyTypeProperty type to listen to.
Returns
The created object property binding source.

◆ getPath()

string kanzi::RenderPropertyBindingSource::getPath ( ) const
inline

Gets the path to object.

Returns
Path.

◆ getPropertyType()

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

Gets the source property type.

Returns
Property type.

◆ createRuntimeOverride()

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

Member Data Documentation

◆ m_path

string kanzi::RenderPropertyBindingSource::m_path
protected

Path to look up.

◆ m_propertyType

AbstractPropertyType kanzi::RenderPropertyBindingSource::m_propertyType
protected

Property type to read.


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