Kanzi  3.9.4
Kanzi Engine API
kanzi::ResourceBindingSourceRuntime Class Reference

Runtime for object property binding source. More...

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

Inheritance diagram for kanzi::ResourceBindingSourceRuntime:
[legend]

Public Types

using ResourceListener = ContentReference< Resource >
 Resource listener type. More...
 
using ResourceListenerPtr = unique_ptr< ResourceListener >
 Resource listener unique pointer type. More...
 
- 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...
 

Public Member Functions

ResourceID getResourceID () const
 Gets path to object. More...
 
 ~ResourceBindingSourceRuntime () override
 Destructor. 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 (const ResourceBindingSource &source, BindingLookupContextPtr lookupContext)
 Create a resource 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...
 
bool readOverride (Variant &value) override
 BindingSourceRuntime::readOverride() implementation. More...
 
 ResourceBindingSourceRuntime (const ResourceBindingSource &source, BindingLookupContextPtr lookupContext)
 Constructor. More...
 
void resourceCallback ()
 Callback for resource change. More...
 
bool writeOverride (const Variant &value) override
 BindingSourceRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
 BindingSourceRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 

Protected Attributes

ResourceListenerPtr m_listener
 Listener for resource changes. More...
 
const ResourceBindingSourcem_source
 Host binding source. 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...
 

Detailed Description

Runtime for object property binding source.

Since
Kanzi 3.7.0

Member Typedef Documentation

◆ ResourceListener

◆ ResourceListenerPtr

Resource listener unique pointer type.

Constructor & Destructor Documentation

◆ ~ResourceBindingSourceRuntime()

kanzi::ResourceBindingSourceRuntime::~ResourceBindingSourceRuntime ( )
override

Destructor.

◆ ResourceBindingSourceRuntime()

kanzi::ResourceBindingSourceRuntime::ResourceBindingSourceRuntime ( const ResourceBindingSource source,
BindingLookupContextPtr  lookupContext 
)
inlineexplicitprotected

Constructor.

Parameters
sourceHost object property binding source.
lookupContextLookup context for this binding source runtime.

Member Function Documentation

◆ create()

static BindingSourceRuntimePtr kanzi::ResourceBindingSourceRuntime::create ( const ResourceBindingSource source,
BindingLookupContextPtr  lookupContext 
)
static

Create a resource binding source runtime.

Parameters
sourceHost object property binding target.
lookupContextLookup context for the binding.
Returns
The created resource binding source runtime.

◆ getResourceID()

ResourceID kanzi::ResourceBindingSourceRuntime::getResourceID ( ) const

Gets path to object.

Required by inheriting classes.

Returns
Path to object.

◆ resourceCallback()

void kanzi::ResourceBindingSourceRuntime::resourceCallback ( )
protected

Callback for resource change.

◆ attachForReadOverride()

void kanzi::ResourceBindingSourceRuntime::attachForReadOverride ( )
overrideprotectedvirtual

◆ attachForWriteOverride()

void kanzi::ResourceBindingSourceRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::ResourceBindingSourceRuntime::detachOverride ( )
overrideprotectedvirtual

◆ readOverride()

bool kanzi::ResourceBindingSourceRuntime::readOverride ( Variant value)
overrideprotectedvirtual

◆ writeOverride()

bool kanzi::ResourceBindingSourceRuntime::writeOverride ( const Variant value)
overrideprotectedvirtual

◆ isConnectedOverride()

bool kanzi::ResourceBindingSourceRuntime::isConnectedOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_listener

ResourceListenerPtr kanzi::ResourceBindingSourceRuntime::m_listener
protected

Listener for resource changes.

◆ m_source

const ResourceBindingSource& kanzi::ResourceBindingSourceRuntime::m_source
protected

Host binding source.


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