Kanzi  3.9.6
Kanzi Engine API
kanzi::MessageBindingSource Class Reference

Message binding source. More...

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

Inheritance diagram for kanzi::MessageBindingSource:
[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 message binding source. More...
 

Protected Member Functions

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

Protected Attributes

PropertyField m_field
 Property field to read from message. More...
 
AbstractPropertyType m_propertyType
 Property type to read from message. More...
 

Detailed Description

Message binding source.

Has no attach functionality. Message reference is set to the runtime.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ MessageBindingSource()

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

Constructor.

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

Member Function Documentation

◆ create()

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

Creates a message binding source.

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

◆ getPropertyType()

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

Gets the source property type.

Returns
Property type.

◆ getPropertyField()

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

Gets the source property field.

Returns
Property field.

◆ createRuntimeOverride()

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

Member Data Documentation

◆ m_propertyType

AbstractPropertyType kanzi::MessageBindingSource::m_propertyType
protected

Property type to read from message.

◆ m_field

PropertyField kanzi::MessageBindingSource::m_field
protected

Property field to read from message.


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