Kanzi  3.9.8
Kanzi Engine C++ API
kanzi::DataSourceBindingSourceRuntime Class Reference

Runtime for object property binding source. More...

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

Inheritance diagram for kanzi::DataSourceBindingSourceRuntime:
[legend]

Public Member Functions

string getPath () const
 Gets path to data object. More...
 
 ~DataSourceBindingSourceRuntime () 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
 Gets the binding runtime. More...
 
BindingLookupContextgetLookupContext () const
 Gets the 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 DataSourceBindingSource &source)
 Create a new object property binding target runtime. More...
 

Protected Member Functions

void attachForReadOverride () override
 BindingSourceRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingSourceRuntime::attachForWriteOverride() implementation. More...
 
 DataSourceBindingSourceRuntime (const DataSourceBindingSource &source)
 Constructor. More...
 
void detachOverride () override
 BindingSourceRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingSourceRuntime::isConnectedOverride() implementation. More...
 
void localPropertyChange () override
 ObjectPropertyListenerImpl::localPropertyChange() implementation. More...
 
void onDataChanged ()
 Called when data source changes. More...
 
void onDataObjectChanged ()
 Called when data object within data source changes. More...
 
bool readOverride (Variant &) override
 BindingSourceRuntime::readOverride() implementation. More...
 
bool writeOverride (const Variant &value) override
 BindingSourceRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
 BindingSourceRuntime ()=default
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< ResourceSharedPtr, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
void attachLocalPropertyListener (PropertyObjectSharedPtr object, AbstractPropertyType propertyType)
 Installs local property listener. More...
 
void clearLocalPropertyListener ()
 Clears the property listener object. More...
 
void detachLocalPropertyListener (AbstractPropertyType propertyType)
 Uninstalls local property listener. More...
 
PropertyObjectSharedPtr getLocalPropertyListenerObject () const
 Gets the property object with a local property listener installed. More...
 
bool isLocalPropertyListenerInstalled () const
 Tells whether a local property listener has been installed. More...
 
 ObjectPropertyListenerImpl ()=default
 Constructor. More...
 
 ~ObjectPropertyListenerImpl ()
 Destructor. More...
 

Protected Attributes

weak_ptr< DataContextm_dataContext
 Data context connected to. More...
 
weak_ptr< DataObjectm_dataObject
 Data object connected to. More...
 
bool m_dataSourceChangeListenerRequested
 Boolean flag set to true if data source changes need a listener. More...
 
DataObject::ModifiedSubscriptionToken m_objectSubscription
 Token for data object subscription. More...
 
const DataSourceBindingSourcem_source
 Host binding source. More...
 
DataSource::ModifiedSubscriptionToken m_sourceSubscription
 Token for data object subscription. More...
 
- Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this source. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors (for the source, forward direction). More...
 
- Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< ResourceSharedPtr, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
PropertyObjectWeakPtr m_localPropertyListenerObject
 The object to which the local property listener has been installed. 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...
 
- Static Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< ResourceSharedPtr, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
static void localPropertyChangeCallback (PropertyObject &, const ResourceSharedPtr &, PropertyNotificationReason reason, void *userData)
 Property change callback for object property. More...
 

Detailed Description

Runtime for object property binding source.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

kanzi::DataSourceBindingSourceRuntime::~DataSourceBindingSourceRuntime ( )
override

Destructor.

kanzi::DataSourceBindingSourceRuntime::DataSourceBindingSourceRuntime ( const DataSourceBindingSource source)
inlineexplicitprotected

Constructor.

Parameters
sourceHost object property binding source.
Since
Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

static BindingSourceRuntimePtr kanzi::DataSourceBindingSourceRuntime::create ( const DataSourceBindingSource source)
static

Create a new object property binding target runtime.

Parameters
sourceHost object property binding target.
Since
Kanzi 3.9.6 Removed BindingLookupContextPtr.
string kanzi::DataSourceBindingSourceRuntime::getPath ( ) const

Gets path to data object.

Returns
Path to data object.
void kanzi::DataSourceBindingSourceRuntime::onDataChanged ( )
protected

Called when data source changes.

void kanzi::DataSourceBindingSourceRuntime::onDataObjectChanged ( )
protected

Called when data object within data source changes.

void kanzi::DataSourceBindingSourceRuntime::attachForReadOverride ( )
overrideprotectedvirtual
void kanzi::DataSourceBindingSourceRuntime::attachForWriteOverride ( )
overrideprotectedvirtual
void kanzi::DataSourceBindingSourceRuntime::detachOverride ( )
overrideprotectedvirtual
bool kanzi::DataSourceBindingSourceRuntime::readOverride ( Variant )
overrideprotectedvirtual
bool kanzi::DataSourceBindingSourceRuntime::writeOverride ( const Variant value)
overrideprotectedvirtual
bool kanzi::DataSourceBindingSourceRuntime::isConnectedOverride ( )
overrideprotectedvirtual
void kanzi::DataSourceBindingSourceRuntime::localPropertyChange ( )
overrideprotectedvirtual

Member Data Documentation

weak_ptr<DataObject> kanzi::DataSourceBindingSourceRuntime::m_dataObject
protected

Data object connected to.

weak_ptr<DataContext> kanzi::DataSourceBindingSourceRuntime::m_dataContext
protected

Data context connected to.

bool kanzi::DataSourceBindingSourceRuntime::m_dataSourceChangeListenerRequested
protected

Boolean flag set to true if data source changes need a listener.

DataSource::ModifiedSubscriptionToken kanzi::DataSourceBindingSourceRuntime::m_sourceSubscription
protected

Token for data object subscription.

DataObject::ModifiedSubscriptionToken kanzi::DataSourceBindingSourceRuntime::m_objectSubscription
protected

Token for data object subscription.

const DataSourceBindingSource& kanzi::DataSourceBindingSourceRuntime::m_source
protected

Host binding source.


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