Kanzi 3.9.10
kanzi::ObjectPropertyExpressionValueSource Class Reference

Object Property expression value source. More...

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

Inheritance diagram for kanzi::ObjectPropertyExpressionValueSource:
[legend]

Public Member Functions

string getPath () const
 Gets the source object path.
 
PropertyField getPropertyField () const
 Gets the source property field.
 
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 ObjectPropertyExpressionValueSourceSharedPtr create (string_view path, AbstractPropertyType propertyType)
 Creates an object property expression value source.
 
static ObjectPropertyExpressionValueSourceSharedPtr create (string_view path, AbstractPropertyType propertyType, PropertyField field)
 Creates an object property expression value source.
 

Protected Member Functions

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

Protected Attributes

PropertyField m_field
 Property field to read when property is changed.
 
string m_path
 Path to object to listen to.
 
AbstractPropertyType m_propertyType
 Property type to listen to.
 

Detailed Description

Object Property expression value source.

Resolves an object by path and reads a property.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ ObjectPropertyExpressionValueSource()

kanzi::ObjectPropertyExpressionValueSource::ObjectPropertyExpressionValueSource ( string_view path,
AbstractPropertyType propertyType,
PropertyField field )
inlineprotected

Constructor.

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

Member Function Documentation

◆ create() [1/2]

static ObjectPropertyExpressionValueSourceSharedPtr kanzi::ObjectPropertyExpressionValueSource::create ( string_view path,
AbstractPropertyType propertyType,
PropertyField field )
static

Creates an object property expression value source.

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

◆ create() [2/2]

static ObjectPropertyExpressionValueSourceSharedPtr kanzi::ObjectPropertyExpressionValueSource::create ( string_view path,
AbstractPropertyType propertyType )
inlinestatic

Creates an object 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::ObjectPropertyExpressionValueSource::getPath ( ) const
inline

Gets the source object path.

Returns
Path to object.

◆ getPropertyType()

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

Gets the source property type.

Returns
Property type.

◆ getPropertyField()

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

Gets the source property field.

Returns
Property field.

◆ createRuntimeOverride()

AbstractExpressionValueSourceRuntimePtr kanzi::ObjectPropertyExpressionValueSource::createRuntimeOverride ( ExpressionBindingSourceRuntime & host)
overrideprotectedvirtual

◆ convertToBindingSourceOverride()

BindingSourcePtr kanzi::ObjectPropertyExpressionValueSource::convertToBindingSourceOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_path

string kanzi::ObjectPropertyExpressionValueSource::m_path
protected

Path to object to listen to.

◆ m_propertyType

AbstractPropertyType kanzi::ObjectPropertyExpressionValueSource::m_propertyType
protected

Property type to listen to.

◆ m_field

PropertyField kanzi::ObjectPropertyExpressionValueSource::m_field
protected

Property field to read when property is changed.


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