Kanzi 4.1.0
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.
 
AbstractPropertyType getPropertyType () const
 Gets the source property type.
 
- Public Member Functions inherited from kanzi::AbstractExpressionValueSource
BindingSourcePtr convertToBindingSource ()
 Converts this expression value source to a matching binding source.
 
AbstractExpressionValueSourceRuntimePtr createRuntime (ExpressionBindingSourceRuntime &host)
 Creates a runtime for this expression value source.
 
virtual ~AbstractExpressionValueSource ()
 Destructor.
 

Static Public Member Functions

static RenderPropertyExpressionValueSourceSharedPtr create (string_view path, AbstractPropertyType propertyType)
 Creates a render property expression value source.
 

Protected Member Functions

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

Protected Attributes

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

Friends

string to_string (const RenderPropertyExpressionValueSource &expressionValueSource, size_t initialIndent, size_t incrementIndent)
 Converts render property expression value source to string.
 

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

Friends And Related Symbol Documentation

◆ to_string

string to_string ( const RenderPropertyExpressionValueSource & expressionValueSource,
size_t initialIndent,
size_t incrementIndent )
friend

Converts render property expression value source to string.

Parameters
expressionValueSourceExpression value source to convert.
initialIndentInitial indentation state the output starts at.
incrementIndentIndentation increment for each successive recursive structure.
Returns
String representation of the binding.
Since
Kanzi 4.1.0

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: