Kanzi  3.9.6
Kanzi Engine API
kanzi::RenderPropertyExpressionValueSource Class Reference

Render property expression value source. More...

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

Inheritance diagram for kanzi::RenderPropertyExpressionValueSource:
[legend]

Public Member Functions

string getPath () const
 Gets the source object path. 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 RenderPropertyExpressionValueSourceSharedPtr create (string_view path, AbstractPropertyType propertyType)
 Creates a render property expression value source. More...
 

Protected Member Functions

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

Protected Attributes

string m_path
 Path to object to listen to. More...
 
AbstractPropertyType m_propertyType
 Property type to listen to. More...
 

Detailed Description

Render property expression value source.

Used for reading properties used as render values.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ RenderPropertyExpressionValueSource()

kanzi::RenderPropertyExpressionValueSource::RenderPropertyExpressionValueSource ( string_view  path,
AbstractPropertyType  propertyType 
)
inlineprotected

Constructor.

Parameters
pathPath to object.
propertyTypeProperty type to listen to.

Member Function Documentation

◆ create()

static RenderPropertyExpressionValueSourceSharedPtr kanzi::RenderPropertyExpressionValueSource::create ( string_view  path,
AbstractPropertyType  propertyType 
)
static

Creates a render property expression value source.

Uses the whole property.

Parameters
pathPath to object.
propertyTypeProperty type to listen to.
Returns
Newly created object property expression value source.

◆ getPath()

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

Gets the source object path.

Returns
Path to object.

◆ getPropertyType()

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

Gets the source property type.

Returns
Property type.

◆ createRuntimeOverride()

AbstractExpressionValueSourceRuntimePtr kanzi::RenderPropertyExpressionValueSource::createRuntimeOverride ( ExpressionBindingSourceRuntime host)
overrideprotectedvirtual

◆ convertToBindingSourceOverride()

BindingSourcePtr kanzi::RenderPropertyExpressionValueSource::convertToBindingSourceOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_path

string kanzi::RenderPropertyExpressionValueSource::m_path
protected

Path to object to listen to.

◆ m_propertyType

AbstractPropertyType kanzi::RenderPropertyExpressionValueSource::m_propertyType
protected

Property type to listen to.


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