Runtime for object property binding source. More...

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

Inheritance diagram for kanzi::DataSourceBindingSourceRuntime:

Public Member Functions
string	getPath () const
	Gets path to data object.

	~DataSourceBindingSourceRuntime () override
	Destructor.

Public Member Functions inherited from kanzi::BindingSourceRuntime
void	attachForRead ()
	Attaches the binding source runtime for reading.

void	attachForWrite ()
	Attaches the binding source runtime for writing.

BindingProcessorRuntimeConstIterator	beginProcessorRuntimes () const
	Gets an iterator to the beginning of binding processors.

void	createBindingProcessorRuntimes (const AbstractBinding &binding)
	Creates a processor runtime for each BindingProcessor held by the binding parameter.

void	detach ()
	Detaches the binding source runtime.

BindingProcessorRuntimeConstIterator	endProcessorRuntimes () const
	Gets an iterator to the end of binding processors.

AbstractBindingRuntime *	getBindingRuntime () const
	Gets the binding runtime.

BindingLookupContext &	getLookupContext () const
	Gets the lookup context.

bool	isConnected ()
	Indicates whether this source is connected.

bool	read (Variant &value)
	Reads a value from binding source.

void	setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
	Sets the binding runtime.

bool	write (const Variant &value)
	Writes a value to binding source.

virtual	~BindingSourceRuntime ()=default
	Destructor.

Static Public Member Functions
static BindingSourceRuntimePtr	create (const DataSourceBindingSource &source)
	Create a new object property binding target runtime.

Protected Member Functions
void	attachForReadOverride () override
	BindingSourceRuntime::attachForReadOverride() implementation.

void	attachForWriteOverride () override
	BindingSourceRuntime::attachForWriteOverride() implementation.

	DataSourceBindingSourceRuntime (const DataSourceBindingSource &source)
	Constructor.

void	detachOverride () override
	BindingSourceRuntime::detachOverride() implementation.

bool	isConnectedOverride () override
	BindingSourceRuntime::isConnectedOverride() implementation.

void	localPropertyChange () override
	ObjectPropertyListenerImpl::localPropertyChange() implementation.

void	onDataChanged ()
	Called when data source changes.

void	onDataObjectChanged ()
	Called when data object within data source changes.

bool	readOverride (Variant &) override
	BindingSourceRuntime::readOverride() implementation.

bool	writeOverride (const Variant &value) override
	BindingSourceRuntime::writeOverride() implementation.

Protected Member Functions inherited from kanzi::BindingSourceRuntime
	BindingSourceRuntime ()=default
	Constructor.

Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< ResourceSharedPtr, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
void	attachLocalPropertyListener (PropertyObjectSharedPtr object, AbstractPropertyType propertyType)
	Installs local property listener.

void	clearLocalPropertyListener ()
	Clears the property listener object.

void	detachLocalPropertyListener (AbstractPropertyType propertyType)
	Uninstalls local property listener.

PropertyObjectSharedPtr	getLocalPropertyListenerObject () const
	Gets the property object with a local property listener installed.

bool	isLocalPropertyListenerInstalled () const
	Tells whether a local property listener has been installed.

	ObjectPropertyListenerImpl ()=default
	Constructor.

	~ObjectPropertyListenerImpl ()
	Destructor.

Protected Attributes
weak_ptr< DataContext >	m_dataContext
	Data context connected to.

weak_ptr< DataObject >	m_dataObject
	Data object connected to.

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

DataObject::ModifiedSubscriptionToken	m_objectSubscription
	Token for data object subscription.

const DataSourceBindingSource &	m_source
	Host binding source.

DataSource::ModifiedSubscriptionToken	m_sourceSubscription
	Token for data object subscription.

Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntime *	m_bindingRuntime
	Abstract binding runtime for this source.

BindingProcessorRuntimeContainer	m_processorRuntimes
	Binding processors (for the source, forward direction).

Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< ResourceSharedPtr, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
PropertyObjectWeakPtr	m_localPropertyListenerObject
	The object to which the local property listener has been installed.

Additional Inherited Members
Public Types inherited from kanzi::BindingSourceRuntime
using	BindingProcessorRuntimeConstIterator
	Binding processor runtime constant iterator type.

using	BindingProcessorRuntimeContainer
	Binding processor runtime container type.

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.

Detailed Description

Runtime for object property binding source.

Since: Kanzi 3.7.0

Constructor & Destructor Documentation

◆ ~DataSourceBindingSourceRuntime()

kanzi::DataSourceBindingSourceRuntime::~DataSourceBindingSourceRuntime ( )

override

Destructor.

◆ DataSourceBindingSourceRuntime()

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

inlineexplicitprotected

Constructor.

Parameters

source Host object property binding source.

Since: Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

◆ create()

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

static

Create a new object property binding target runtime.

Parameters

source Host object property binding target.

Since: Kanzi 3.9.6 Removed BindingLookupContextPtr.

◆ getPath()

string kanzi::DataSourceBindingSourceRuntime::getPath ( ) const

Gets path to data object.

Returns: Path to data object.

◆ onDataChanged()

void kanzi::DataSourceBindingSourceRuntime::onDataChanged ( )

protected

Called when data source changes.

◆ onDataObjectChanged()

void kanzi::DataSourceBindingSourceRuntime::onDataObjectChanged ( )

protected

Called when data object within data source changes.

◆ attachForReadOverride()

void kanzi::DataSourceBindingSourceRuntime::attachForReadOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::attachForReadOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ attachForWriteOverride()

void kanzi::DataSourceBindingSourceRuntime::attachForWriteOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::attachForWriteOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ detachOverride()

void kanzi::DataSourceBindingSourceRuntime::detachOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::detachOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ readOverride()

bool kanzi::DataSourceBindingSourceRuntime::readOverride ( Variant & )

overrideprotectedvirtual

BindingSourceRuntime::readOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ writeOverride()

bool kanzi::DataSourceBindingSourceRuntime::writeOverride ( const Variant & value )

overrideprotectedvirtual

BindingSourceRuntime::writeOverride() implementation.

Reimplemented from kanzi::BindingSourceRuntime.

◆ isConnectedOverride()

bool kanzi::DataSourceBindingSourceRuntime::isConnectedOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::isConnectedOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ localPropertyChange()

void kanzi::DataSourceBindingSourceRuntime::localPropertyChange ( )

overrideprotectedvirtual

ObjectPropertyListenerImpl::localPropertyChange() implementation.

Implements kanzi::ObjectPropertyListenerImpl< ResourceSharedPtr, PropertyObjectWeakPtr, PropertyObjectSharedPtr >.

Member Data Documentation

◆ m_dataObject

weak_ptr<DataObject> kanzi::DataSourceBindingSourceRuntime::m_dataObject

protected

Data object connected to.

◆ m_dataContext

weak_ptr<DataContext> kanzi::DataSourceBindingSourceRuntime::m_dataContext

protected

Data context connected to.

◆ m_dataSourceChangeListenerRequested

bool kanzi::DataSourceBindingSourceRuntime::m_dataSourceChangeListenerRequested

protected

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

◆ m_sourceSubscription

DataSource::ModifiedSubscriptionToken kanzi::DataSourceBindingSourceRuntime::m_sourceSubscription

protected

Token for data object subscription.

◆ m_objectSubscription

DataObject::ModifiedSubscriptionToken kanzi::DataSourceBindingSourceRuntime::m_objectSubscription

protected

Token for data object subscription.

◆ m_source

const DataSourceBindingSource& kanzi::DataSourceBindingSourceRuntime::m_source

protected

Host binding source.

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

kanzi/core.ui/binding/data_source_binding_source_runtime.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~DataSourceBindingSourceRuntime()

◆ DataSourceBindingSourceRuntime()

Member Function Documentation

◆ create()

◆ getPath()

◆ onDataChanged()

◆ onDataObjectChanged()

◆ attachForReadOverride()

◆ attachForWriteOverride()

◆ detachOverride()

◆ readOverride()

◆ writeOverride()

◆ isConnectedOverride()

◆ localPropertyChange()

Member Data Documentation

◆ m_dataObject

◆ m_dataContext

◆ m_dataSourceChangeListenerRequested

◆ m_sourceSubscription

◆ m_objectSubscription

◆ m_source