Binding target runtime interface. More...

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

Inheritance diagram for kanzi::BindingTargetRuntime:

Public Types
using	BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
	Binding processor iterator type. More...

using	BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
	Binding processor container type. More...

Public Member Functions
void	attachForRead ()
	Attaches the binding target runtime for reading. More...

void	attachForWrite ()
	Attaches the binding target runtime for writing. More...

BindingProcessorRuntimeConstIterator	beginProcessorRuntimes () const
	Gets an iterator to the beginning of binding processor runtimes. More...

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

void	detach ()
	Detaches binding target runtime. More...

BindingProcessorRuntimeConstIterator	endProcessorRuntimes () const
	Gets an iterator to the end of binding processor runtimes. More...

AbstractBindingRuntime *	getBindingRuntime () const
	Gets the binding runtime. More...

BindingLookupContext &	getLookupContext () const
	Accesses target lookup context. More...

bool	isConnected ()
	Indicates whether this source is connected. More...

bool	read (Variant &value)
	Reads a value from the binding target. More...

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

bool	write (const Variant &value)
	Writes a value to the binding target. More...

virtual	~BindingTargetRuntime ()=default
	Destructor. More...

Protected Member Functions
virtual void	attachForReadOverride ()
	Implementation-dependent attach. More...

virtual void	attachForWriteOverride ()=0
	Implementation-dependent attach. More...

	BindingTargetRuntime (BindingLookupContextPtr lookupContext)
	Constructor. More...

virtual void	detachOverride ()=0
	Implementation-dependent detach. More...

virtual bool	isConnectedOverride ()=0
	Implementation-dependent connected check. More...

virtual bool	readOverride (Variant &value)
	Implementation-dependent read. More...

virtual bool	writeOverride (const Variant &value)=0
	Implementation-dependent write. More...

Protected Attributes
AbstractBindingRuntime *	m_bindingRuntime
	Abstract binding runtime for this target. More...

BindingLookupContextPtr	m_lookupContext
	Binding lookup context for wherever this binding target runtime is attached to. More...

BindingProcessorRuntimeContainer	m_processorRuntimes
	Binding processors runtimes (for the target, backward direction). More...

Detailed Description

Binding target runtime interface.

Inherited by specialized binding target runtimes.

See also: AbstractBinding

Since: Kanzi 3.7.0

Member Typedef Documentation

◆ BindingProcessorRuntimeContainer

using kanzi::BindingTargetRuntime::BindingProcessorRuntimeContainer = vector<BindingProcessorRuntimePtr>

Binding processor container type.

◆ BindingProcessorRuntimeConstIterator

using kanzi::BindingTargetRuntime::BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator

Binding processor iterator type.

Constructor & Destructor Documentation

◆ ~BindingTargetRuntime()

virtual kanzi::BindingTargetRuntime::~BindingTargetRuntime ( )

virtualdefault

Destructor.

◆ BindingTargetRuntime()

kanzi::BindingTargetRuntime::BindingTargetRuntime ( BindingLookupContextPtr lookupContext )

inlineexplicitprotected

Constructor.

Parameters

lookupContext Lookup context for this binding target runtime.

Member Function Documentation

◆ attachForRead()

void kanzi::BindingTargetRuntime::attachForRead ( )

Attaches the binding target runtime for reading.

After attaching the binding target runtime for reading, the binding target triggers calls to AbstractBindingRuntime::notifyTargetChanged(). Calling this function on binding targets is optional. The binding runtime calls this function if target write notifications are necessary. This is true mostly for two-way bindings. You must call attachForWrite() before calling this function.

◆ attachForWrite()

void kanzi::BindingTargetRuntime::attachForWrite ( )

Attaches the binding target runtime for writing.

After this function is called and the target is connected, you can call the write() function to write values to target. You must call this function before calling attachForRead().

◆ detach()

void kanzi::BindingTargetRuntime::detach ( )

Detaches binding target runtime.

◆ read()

bool kanzi::BindingTargetRuntime::read ( Variant & value )

Reads a value from the binding target.

Parameters

value Output value for the read.

Returns: Read success status.

◆ write()

bool kanzi::BindingTargetRuntime::write ( const Variant & value )

Writes a value to the binding target.

Internal function called by Kanzi to write the output value to the binding target. If multiple values are written, Kanzi calls spill() instead.

Parameters

value Value to write.

Returns: Write success status.

◆ isConnected()

bool kanzi::BindingTargetRuntime::isConnected ( )

Indicates whether this source is connected.

Returns: If the source is connected, true, otherwise false.

◆ createBindingProcessorsRuntimes()

void kanzi::BindingTargetRuntime::createBindingProcessorsRuntimes ( const AbstractBinding & binding )

Creates a processor runtime for each BindingProcessor held by the binding parameter.

Parameters

binding The binding containing a collection of processors.

◆ beginProcessorRuntimes()

BindingProcessorRuntimeConstIterator kanzi::BindingTargetRuntime::beginProcessorRuntimes ( ) const

inline

Gets an iterator to the beginning of binding processor runtimes.

Returns: Iterator to beginning of processor runtimes vector.

◆ endProcessorRuntimes()

BindingProcessorRuntimeConstIterator kanzi::BindingTargetRuntime::endProcessorRuntimes ( ) const

inline

Gets an iterator to the end of binding processor runtimes.

Returns: Iterator to end of processor runtimes vector.

◆ getLookupContext()

BindingLookupContext& kanzi::BindingTargetRuntime::getLookupContext ( ) const

inline

Accesses target lookup context.

◆ getBindingRuntime()

AbstractBindingRuntime* kanzi::BindingTargetRuntime::getBindingRuntime ( ) const

inline

Gets the binding runtime.

Returns: Pointer to owning binding runtime.

◆ setBindingRuntime()

void kanzi::BindingTargetRuntime::setBindingRuntime ( AbstractBindingRuntime & bindingRuntime )

inline

Sets the binding runtime.

Called during construction, after target runtime has been set to binding runtime.

Parameters

bindingRuntime Binding runtime to set.

◆ attachForReadOverride()

virtual void kanzi::BindingTargetRuntime::attachForReadOverride ( )

protectedvirtual

Implementation-dependent attach.

Default implementation throws an error.

Reimplemented in kanzi::TypedValueSourceBindingTargetRuntime< T >, kanzi::VariableBindingTargetRuntime, kanzi::ManualBindingTargetRuntime, kanzi::TypedPropertyModifierBindingTargetRuntime< T >, kanzi::RenderValueBindingTargetRuntime, and kanzi::MessageBindingTargetRuntime.

◆ attachForWriteOverride()

virtual void kanzi::BindingTargetRuntime::attachForWriteOverride ( )

protectedpure virtual

Implementation-dependent attach.

Implemented in kanzi::TypedValueSourceBindingTargetRuntime< T >, kanzi::VariableBindingTargetRuntime, kanzi::ManualBindingTargetRuntime, kanzi::TypedPropertyModifierBindingTargetRuntime< T >, kanzi::RenderValueBindingTargetRuntime, kanzi::MessageBindingTargetRuntime, and kanzi::DummyBindingTargetRuntime.

◆ detachOverride()

virtual void kanzi::BindingTargetRuntime::detachOverride ( )

protectedpure virtual

Implementation-dependent detach.

Implemented in kanzi::TypedValueSourceBindingTargetRuntime< T >, kanzi::VariableBindingTargetRuntime, kanzi::TypedPropertyModifierBindingTargetRuntime< T >, kanzi::ManualBindingTargetRuntime, kanzi::RenderValueBindingTargetRuntime, kanzi::MessageBindingTargetRuntime, and kanzi::DummyBindingTargetRuntime.

◆ readOverride()

virtual bool kanzi::BindingTargetRuntime::readOverride ( Variant & value )

protectedvirtual

Implementation-dependent read.

Default implementation throws an error.

Parameters

value Value to read.

Returns: If the reading succeeds, true, otherwise false.

Reimplemented in kanzi::TypedValueSourceBindingTargetRuntime< T >, kanzi::TypedPropertyModifierBindingTargetRuntime< T >, kanzi::VariableBindingTargetRuntime, kanzi::TypedManualBindingTargetRuntime< T >, and kanzi::TypedMessageBindingTargetRuntime< T >.

◆ writeOverride()

virtual bool kanzi::BindingTargetRuntime::writeOverride ( const Variant & value )

protectedpure virtual

Implementation-dependent write.

Parameters

value Value to write.

Returns: If the writing succeeds, true, otherwise false.

Implemented in kanzi::BlendModeRenderValueBindingTargetRuntime, kanzi::TypedRenderValueBindingTargetRuntime< T >, kanzi::TypedValueSourceBindingTargetRuntime< T >, kanzi::TypedPropertyModifierBindingTargetRuntime< T >, kanzi::TypedVariableBindingTargetRuntime< T >, kanzi::TypedManualBindingTargetRuntime< T >, kanzi::TypedMessageBindingTargetRuntime< T >, and kanzi::DummyBindingTargetRuntime.

◆ isConnectedOverride()

virtual bool kanzi::BindingTargetRuntime::isConnectedOverride ( )

protectedpure virtual

Implementation-dependent connected check.

Returns: If the binding target is connected, true, otherwise false.

Implemented in kanzi::TypedValueSourceBindingTargetRuntime< T >, kanzi::VariableBindingTargetRuntime, kanzi::TypedPropertyModifierBindingTargetRuntime< T >, kanzi::ManualBindingTargetRuntime, kanzi::RenderValueBindingTargetRuntime, kanzi::MessageBindingTargetRuntime, and kanzi::DummyBindingTargetRuntime.

Member Data Documentation

◆ m_processorRuntimes

BindingProcessorRuntimeContainer kanzi::BindingTargetRuntime::m_processorRuntimes

protected

Binding processors runtimes (for the target, backward direction).

◆ m_bindingRuntime

AbstractBindingRuntime* kanzi::BindingTargetRuntime::m_bindingRuntime

protected

Abstract binding runtime for this target.

◆ m_lookupContext

BindingLookupContextPtr kanzi::BindingTargetRuntime::m_lookupContext

protected

Binding lookup context for wherever this binding target runtime is attached to.

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

kanzi/core.ui/binding/binding_target_runtime.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BindingProcessorRuntimeContainer

◆ BindingProcessorRuntimeConstIterator

Constructor & Destructor Documentation

◆ ~BindingTargetRuntime()

◆ BindingTargetRuntime()

Member Function Documentation

◆ attachForRead()

◆ attachForWrite()

◆ detach()

◆ read()

◆ write()

◆ isConnected()

◆ createBindingProcessorsRuntimes()

◆ beginProcessorRuntimes()

◆ endProcessorRuntimes()

◆ getLookupContext()

◆ getBindingRuntime()

◆ setBindingRuntime()

◆ attachForReadOverride()

◆ attachForWriteOverride()

◆ detachOverride()

◆ readOverride()

◆ writeOverride()

◆ isConnectedOverride()

Member Data Documentation

◆ m_processorRuntimes

◆ m_bindingRuntime

◆ m_lookupContext