Runtime for binding. More...

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

Inheritance diagram for kanzi::ManualBindingRuntime:

Public Member Functions
Variant	getCachedValue () const
	Gets the result of last operation.

bool	read ()
	Performs a read and stores the read value in the binding's internal cache.

bool	write ()
	Performs a write for last read value that was stored in the binding's internal cache.

Public Member Functions inherited from kanzi::AbstractBindingRuntime
void	attach ()
	Attach the binding.

void	detach ()
	Detaches the binding.

void	detachIfAttachedOrAttaching ()
	Detaches the binding if it is attaching or attached.

AbstractBindingSharedPtr	getBinding () const
	Returns the binding associated with this binding runtime.

BindingLookupContext &	getLookupContext () const
	Gets the lookup context.

shared_ptr< void >	getOwner () const
	Gets the owner.

BindingSourceRuntime *	getSourceRuntime () const
	Gets the source runtime.

BindingTargetRuntime *	getTargetRuntime () const
	Gets the target runtime.

bool	isAttached () const
	Indicates whether this binding runtime has been attached.

bool	isAttaching () const
	Indicates whether this binding runtime is being attached.

bool	isConnected ()
	Indicates whether this binding runtime is connected.

bool	isDetached () const
	Indicates whether this binding runtime is detached.

bool	isDetaching () const
	Indicates whether this binding runtime is being detached.

bool	isRemoved () const
	Gets whether the binding runtime has been removed from the binding host.

void	notifySourceChanged ()
	Called when binding source has changed.

void	notifyTargetChanged ()
	Called when binding target has changed.

void	onRemoved ()
	Called when binding is being removed from where it has been installed.

void	removeFromHost ()
	Removes the binding runtime from the binding host.

void	setHost (BindingHostConceptSharedPtr hostObject)
	Sets the binding host object in which the binding runtime is hosted.

void	setOwner (shared_ptr< void > owner)
	Set the owner.

bool	update ()
	Execute the binding.

virtual	~AbstractBindingRuntime ()
	Destructor.

Static Public Member Functions
static ManualBindingRuntimeSharedPtr	create (ManualBindingSharedPtr manualBinding, BindingLookupContextPtr lookupContext, BindingSourceRuntimePtr sourceRuntime, BindingTargetRuntimePtr targetRuntime)
	Creates a binding runtime.

Protected Member Functions
void	attachOverride () override
	AbstractBindingRuntime::attachOverride() implementation.

	ManualBindingRuntime (ManualBindingSharedPtr manualBinding, BindingLookupContextPtr lookupContext, BindingSourceRuntimePtr sourceRuntime, BindingTargetRuntimePtr targetRuntime)
	Constructor.

void	notifySourceChangedOverride () override
	AbstractBindingRuntime::notifySourceChangedOverride() implementation.

bool	updateOverride () override
	AbstractBindingRuntime::updateOverride() implementation.

Protected Member Functions inherited from kanzi::BindingBaseRuntime
	BindingBaseRuntime (AbstractBindingSharedPtr binding, BindingLookupContextPtr lookupContext, BindingSourceRuntimePtr sourceRuntime, BindingTargetRuntimePtr targetRuntime)
	Constructor.

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

Protected Member Functions inherited from kanzi::AbstractBindingRuntime
	AbstractBindingRuntime (AbstractBindingSharedPtr binding, BindingLookupContextPtr lookupContext, BindingSourceRuntimePtr sourceRuntime, BindingTargetRuntimePtr targetRuntime)
	Constructor.

virtual bool	isConnectedOverride ()
	Binding-dependent attached indication.

virtual void	notifyTargetChangedOverride ()
	Binding-dependent target change.

bool	readFromSource (Variant &value)
	Read from source and execute forward validators.

bool	readFromTarget (Variant &value)
	Reads from target and executes reverse validators.

bool	writeToSource (const Variant &value) const
	Writes to source.

bool	writeToTarget (const Variant &value)
	Write to target.

Protected Attributes
Variant	m_value
	Last value acquired in binding read.

Protected Attributes inherited from kanzi::BindingBaseRuntime
bool	m_updateInProgress
	Flag for update being in progress.

Protected Attributes inherited from kanzi::AbstractBindingRuntime
AttachmentState	m_attachmentState
	Current binding runtime state.

AbstractBindingSharedPtr	m_binding
	Associated binding.

BindingHostConceptWeakPtr	m_bindingHost
	The binding host object in which the binding runtime is hosted.

BindingLookupContextPtr	m_lookupContext

weak_ptr< void >	m_owner
	Owner for tagging the runtime.

BindingSourceRuntimePtr	m_sourceRuntime
	Runtime for source.

BindingTargetRuntimePtr	m_targetRuntime
	Runtime for target.

Additional Inherited Members
Public Types inherited from kanzi::AbstractBindingRuntime
enum	AttachmentState { Detached , Detaching , Attaching , Attached , Removed }
	Attachment state for keeping track current status. More...

Detailed Description

Runtime for binding.

Since: Kanzi 3.7.0

Constructor & Destructor Documentation

◆ ManualBindingRuntime()

kanzi::ManualBindingRuntime::ManualBindingRuntime	(	ManualBindingSharedPtr	manualBinding,
		BindingLookupContextPtr	lookupContext,
		BindingSourceRuntimePtr	sourceRuntime,
		BindingTargetRuntimePtr	targetRuntime )

explicitprotected

Constructor.

Parameters

manualBinding	Manual binding that created this runtime.
lookupContext	Binding lookup context.
sourceRuntime	Binding source runtime.
targetRuntime	Binding target runtime.

Since: Kanzi 3.9.6 Added BindingLookupContextPtr.

Member Function Documentation

◆ create()

static ManualBindingRuntimeSharedPtr kanzi::ManualBindingRuntime::create	(	ManualBindingSharedPtr	manualBinding,
		BindingLookupContextPtr	lookupContext,
		BindingSourceRuntimePtr	sourceRuntime,
		BindingTargetRuntimePtr	targetRuntime )

static

Creates a binding runtime.

Parameters

manualBinding	Manual binding that created this runtime.
lookupContext	Binding lookup context.
sourceRuntime	Binding source runtime.
targetRuntime	Binding target runtime.

Since: Kanzi 3.9.6 Added BindingLookupContextPtr.

◆ read()

bool kanzi::ManualBindingRuntime::read ( )

Performs a read and stores the read value in the binding's internal cache.

Returns: True if a read was successfully performed.

◆ write()

bool kanzi::ManualBindingRuntime::write ( )

Performs a write for last read value that was stored in the binding's internal cache.

Returns: True if a write was successfully performed.

◆ getCachedValue()

Variant kanzi::ManualBindingRuntime::getCachedValue ( ) const

inline

Gets the result of last operation.

This function returns the result of last read and validation operation. If the binding does not store last read value, this function returns an empty variant.