Runtime for object property binding source. More...

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

Inheritance diagram for kanzi::TypedObjectPropertyBindingSourceRuntime< T >:

Public Member Functions
	~TypedObjectPropertyBindingSourceRuntime () override
	Destructor.

Public Member Functions inherited from kanzi::ObjectPropertyBindingSourceRuntime
string	getPath () const
	Gets path to object.

PropertyField	getPropertyField () const
	Gets property field.

AbstractPropertyType	getPropertyType () const
	Gets property type.

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.

Public Member Functions inherited from kanzi::BindingLookupNotificationBase
void	clearLocalNotificationFlag ()
	Clears local notification flag.

bool	isGlobalNotificationInstalled () const
	Tells if this a global notification has been registered.

bool	isLocalNotificationInstalled () const
	Tells if this a local notification has been registered.

void	registerGlobalNotification (BindingLookupContext &lookupContext, string_view path)
	Installs a global notification listener.

void	registerLocalNotification (BindingLookupContext &lookupContext, PropertyObject &object, string_view path)
	Installs a local notification listener.

void	registerLocalNotification (BindingLookupContext &lookupContext, PropertyObject *object, string_view path)
	Installs a local notification listener.

void	unregisterGlobalNotification (BindingLookupContext &lookupContext, string_view path)
	Uninstalls a global notification listener.

void	unregisterLocalNotification (BindingLookupContext &lookupContext, PropertyObject &object, string_view path)
	Removes a local notification listener.

void	unregisterLocalNotification (BindingLookupContext &lookupContext, PropertyObject *object, string_view path)
	Removes a local notification listener.

	~BindingLookupNotificationBase ()
	Destructor.

Static Public Member Functions
static BindingSourceRuntimePtr	create (const ObjectPropertyBindingSource &source)
	Creates a typed object property binding source runtime.

Protected Types
using	ObjectPropertyListenerType
	Type name for object property listener.

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

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

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

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

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

void	onGlobalLookupNotification () override
	BindingLookupNotificationImpl::onGlobalLookupNotification() implementation.

void	onLocalLookupNotification () override
	BindingLookupNotificationImpl::onLocalLookupNotification() implementation.

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

	TypedObjectPropertyBindingSourceRuntime (const ObjectPropertyBindingSource &source)
	Constructor.

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

Protected Member Functions inherited from kanzi::ObjectPropertyBindingSourceRuntime
	ObjectPropertyBindingSourceRuntime (const ObjectPropertyBindingSource &source)
	Constructor.

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

Protected Member Functions inherited from kanzi::BindingLookupNotificationBase
	BindingLookupNotificationBase ()
	Constructor.

Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject & >
void	attachLocalPropertyListener (PropertyObject & object, AbstractPropertyType propertyType)
	Installs local property listener.

void	clearLocalPropertyListener ()
	Clears the property listener object.

void	detachLocalPropertyListener (AbstractPropertyType propertyType)
	Uninstalls local property listener.

PropertyObject &	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
bool	m_localPropertyListenerRequested
	Is the local property listener requested?

PropertyObjectWeakPtr	m_object
	Property object attached to.

Protected Attributes inherited from kanzi::ObjectPropertyBindingSourceRuntime
const ObjectPropertyBindingSource &	m_source
	Host binding source.

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::BindingLookupNotificationBase
bool	m_globalNotificationInstalled
	Is the global notification listener installed?

bool	m_localNotificationInstalled
	Is the local notification listener installed?

Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject & >
PropertyObject *	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< T, PropertyObject *, PropertyObject & >
static void	localPropertyChangeCallback (PropertyObject &, const T &, PropertyNotificationReason reason, void *userData)
	Property change callback for object property.

Detailed Description

template<typename T>
class kanzi::TypedObjectPropertyBindingSourceRuntime< T >

Runtime for object property binding source.

Since: Kanzi 3.7.0

Member Typedef Documentation

◆ ObjectPropertyListenerType

template<typename T >

using kanzi::TypedObjectPropertyBindingSourceRuntime< T >::ObjectPropertyListenerType

protected

Type name for object property listener.

Constructor & Destructor Documentation

◆ ~TypedObjectPropertyBindingSourceRuntime()

template<typename T >

kanzi::TypedObjectPropertyBindingSourceRuntime< T >::~TypedObjectPropertyBindingSourceRuntime ( )

inlineoverride

Destructor.

◆ TypedObjectPropertyBindingSourceRuntime()

template<typename T >

kanzi::TypedObjectPropertyBindingSourceRuntime< T >::TypedObjectPropertyBindingSourceRuntime ( const ObjectPropertyBindingSource & source )

inlineexplicitprotected

Constructor.

Parameters

source Host object property binding source.

Since: Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

◆ create()

template<typename T >

static BindingSourceRuntimePtr kanzi::TypedObjectPropertyBindingSourceRuntime< T >::create ( const ObjectPropertyBindingSource & source )

inlinestatic

Creates a typed object property binding source runtime.

Parameters

source Host object property binding source.

Returns: The created typed object property binding source runtime.

Since: Kanzi 3.9.6 Removed BindingLookupContextPtr.