Kanzi Engine API
kanzi::ManualBindingSourceRuntime Class Reference

Runtime for manual binding source. More...

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

Inheritance diagram for kanzi::ManualBindingSourceRuntime:
[legend]

Public Member Functions

string getPath () const
 Gets path to object. More...
 
PropertyField getPropertyField () const
 Gets property field. More...
 
AbstractPropertyType getPropertyType () const
 Gets property type. More...
 
- Public Member Functions inherited from kanzi::BindingSourceRuntime
void attachForRead ()
 Attaches the binding source runtime for reading. More...
 
void attachForWrite ()
 Attaches the binding source runtime for writing. More...
 
BindingProcessorConstIterator beginProcessors () const
 Gets an iterator to the beginning of binding processors. More...
 
void copyBindingProcessors (const AbstractBinding &processor)
 Copies forward direction processors from a binding. More...
 
void detach ()
 Detaches the binding source runtime. More...
 
BindingProcessorConstIterator endProcessors () const
 Gets an iterator to the end of binding processors. More...
 
BindingLookupContextgetLookupContext () const
 Accesses source lookup context. More...
 
bool isConnected ()
 Indicates whether this source is connected. More...
 
bool read (Variant &value)
 Reads a value from binding source. More...
 
void setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
 Sets the binding runtime. More...
 
bool write (const Variant &value)
 Writes a value to binding source. More...
 
virtual ~BindingSourceRuntime ()
 Destructor. More...
 

Static Public Member Functions

static BindingSourceRuntimePtr create (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Creates a manual binding source runtime. More...
 

Protected Member Functions

void attachForReadOverride () override
 BindingSourceRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingSourceRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingSourceRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingSourceRuntime::isConnectedOverride() implementation. More...
 
 ManualBindingSourceRuntime (BindingLookupContextPtr lookupContext, string_view path, AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
 BindingSourceRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 
virtual bool readOverride (Variant &value)=0
 Implementation-dependent read. More...
 
virtual bool writeOverride (const Variant &value)
 Implementation-dependent write. More...
 

Protected Attributes

PropertyField m_field
 Source property field. More...
 
string m_path
 Source path. More...
 
AbstractPropertyType m_propertyType
 Source property type. More...
 
- Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this source. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding source runtime is attached to. More...
 
BindingProcessorContainer m_processors
 Binding processors (for the source, forward direction). More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BindingSourceRuntime
typedef BindingProcessorContainer::const_iterator BindingProcessorConstIterator
 Binding processor iterator type. More...
 
typedef vector< BindingProcessorSharedPtrBindingProcessorContainer
 Binding processor container type. More...
 

Detailed Description

Runtime for manual binding source.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

kanzi::ManualBindingSourceRuntime::ManualBindingSourceRuntime ( BindingLookupContextPtr  lookupContext,
string_view  path,
AbstractPropertyType  propertyType,
PropertyField  field 
)
inlineexplicitprotected

Constructor.

Parameters
lookupContextLookup context for this binding source runtime.
pathSource path.
propertyTypeSource property type.
fieldSource property field.

Member Function Documentation

static BindingSourceRuntimePtr kanzi::ManualBindingSourceRuntime::create ( BindingLookupContextPtr  lookupContext,
string_view  path,
AbstractPropertyType  propertyType,
PropertyField  field 
)
static

Creates a manual binding source runtime.

Parameters
lookupContextLookup context for this binding source runtime.
pathSource path.
propertyTypeSource property type.
fieldSource property field.
Returns
The created manual binding source runtime.
string kanzi::ManualBindingSourceRuntime::getPath ( ) const
inline

Gets path to object.

Returns
Path to object.
AbstractPropertyType kanzi::ManualBindingSourceRuntime::getPropertyType ( ) const
inline

Gets property type.

Returns
Property type for this source.
PropertyField kanzi::ManualBindingSourceRuntime::getPropertyField ( ) const
inline

Gets property field.

Returns
Property type for this source.
void kanzi::ManualBindingSourceRuntime::attachForReadOverride ( )
overrideprotectedvirtual
void kanzi::ManualBindingSourceRuntime::attachForWriteOverride ( )
overrideprotectedvirtual
void kanzi::ManualBindingSourceRuntime::detachOverride ( )
overrideprotectedvirtual
bool kanzi::ManualBindingSourceRuntime::isConnectedOverride ( )
overrideprotectedvirtual

Member Data Documentation

string kanzi::ManualBindingSourceRuntime::m_path
protected

Source path.

AbstractPropertyType kanzi::ManualBindingSourceRuntime::m_propertyType
protected

Source property type.

PropertyField kanzi::ManualBindingSourceRuntime::m_field
protected

Source property field.


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