Kanzi  3.9.5
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...
 
BindingProcessorRuntimeConstIterator beginProcessorRuntimes () const
 Gets an iterator to the beginning of binding processors. More...
 
void createBindingProcessorRuntimes (const AbstractBinding &binding)
 Creates a processor runtime for each BindingProcessor held by the binding parameter. More...
 
void detach ()
 Detaches the binding source runtime. More...
 
BindingProcessorRuntimeConstIterator endProcessorRuntimes () const
 Gets an iterator to the end of binding processors. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Returns the source lookup context. More...
 
BindingLookupContextgetLookupContext () const
 Returns the 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 ()=default
 Destructor. More...
 

Static Public Member Functions

static BindingSourceRuntimePtr create (ManualBindingSource &bindingSource, BindingLookupContextPtr lookupContext)
 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 (ManualBindingSource &bindingSource, BindingLookupContextPtr lookupContext)
 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

ManualBindingSourcem_source
 Binding source that created the runtime. 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...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors (for the source, forward direction). More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BindingSourceRuntime
using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor runtime constant iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 Binding processor runtime container type. More...
 

Detailed Description

Runtime for manual binding source.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ ManualBindingSourceRuntime()

kanzi::ManualBindingSourceRuntime::ManualBindingSourceRuntime ( ManualBindingSource bindingSource,
BindingLookupContextPtr  lookupContext 
)
inlineexplicitprotected

Constructor.

Parameters
bindingSourceBinding source that created the runtime.
lookupContextLookup context for this binding source runtime.

Member Function Documentation

◆ create()

static BindingSourceRuntimePtr kanzi::ManualBindingSourceRuntime::create ( ManualBindingSource bindingSource,
BindingLookupContextPtr  lookupContext 
)
static

Creates a manual binding source runtime.

Parameters
bindingSourceBinding source that created the runtime.
lookupContextLookup context for this binding source runtime.
Returns
The created manual binding source runtime.

◆ getPath()

string kanzi::ManualBindingSourceRuntime::getPath ( ) const

Gets path to object.

Returns
Path to object.

◆ getPropertyType()

AbstractPropertyType kanzi::ManualBindingSourceRuntime::getPropertyType ( ) const

Gets property type.

Returns
Property type for this source.

◆ getPropertyField()

PropertyField kanzi::ManualBindingSourceRuntime::getPropertyField ( ) const

Gets property field.

Returns
Property type for this source.

◆ attachForReadOverride()

void kanzi::ManualBindingSourceRuntime::attachForReadOverride ( )
overrideprotectedvirtual

◆ attachForWriteOverride()

void kanzi::ManualBindingSourceRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::ManualBindingSourceRuntime::detachOverride ( )
overrideprotectedvirtual

◆ isConnectedOverride()

bool kanzi::ManualBindingSourceRuntime::isConnectedOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_source

ManualBindingSource& kanzi::ManualBindingSourceRuntime::m_source
protected

Binding source that created the runtime.


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