kanzi::ManualBindingTargetRuntime Class Reference

Runtime for manual binding target. More...

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

Inheritance diagram for kanzi::ManualBindingTargetRuntime:

Public Member Functions
string	getPath () const
	Gets path to object.
PropertyField	getPropertyField () const
	Gets property type.
AbstractPropertyType	getPropertyType () const
	Gets property type.
Public Member Functions inherited from kanzi::BindingTargetRuntime
void	attachForRead ()
	Attaches the binding target runtime for reading.
void	attachForWrite ()
	Attaches the binding target runtime for writing.
BindingProcessorRuntimeConstIterator	beginProcessorRuntimes () const
	Gets an iterator to the beginning of binding processor runtimes.
void	createBindingProcessorsRuntimes (const AbstractBinding &binding)
	Creates a processor runtime for each BindingProcessor held by the binding parameter.
void	detach ()
	Detaches binding target runtime.
BindingProcessorRuntimeConstIterator	endProcessorRuntimes () const
	Gets an iterator to the end of binding processor runtimes.
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 the binding target.
void	setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
	Sets the binding runtime.
bool	write (const Variant &value)
	Writes a value to the binding target.
virtual	~BindingTargetRuntime ()=default
	Destructor.

Static Public Member Functions
static BindingTargetRuntimePtr	create (string_view path, AbstractPropertyType propertyType, PropertyField field)
	Creates a manual binding target runtime.

Protected Member Functions
void	attachForReadOverride () override
	BindingTargetRuntime::attachForReadOverride() implementation.
void	attachForWriteOverride () override
	BindingTargetRuntime::attachForWriteOverride() implementation.
void	detachOverride () override
	BindingTargetRuntime::detachOverride() implementation.
bool	isConnectedOverride () override
	BindingTargetRuntime::isConnectedOverride() implementation.
	ManualBindingTargetRuntime (string_view path, AbstractPropertyType propertyType, PropertyField field)
	Constructor.
Protected Member Functions inherited from kanzi::BindingTargetRuntime
	BindingTargetRuntime ()=default
	Constructor.
virtual bool	readOverride (Variant &value)
	Implementation-dependent read.
virtual bool	writeOverride (const Variant &value)=0
	Implementation-dependent write.

Protected Attributes
PropertyField	m_field
	Property field written.
string	m_path
	Path to target object.
AbstractPropertyType	m_propertyType
	Property type written.
Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntime *	m_bindingRuntime
	Abstract binding runtime for this target.
BindingProcessorRuntimeContainer	m_processorRuntimes
	Binding processors runtimes (for the target, backward direction).

Additional Inherited Members
Public Types inherited from kanzi::BindingTargetRuntime
using	BindingProcessorRuntimeConstIterator
	Binding processor iterator type.
using	BindingProcessorRuntimeContainer
	Binding processor container type.

Detailed Description

Runtime for manual binding target.

Kanzi uses ManualBindingTargetRuntime internally for actions and triggers which require writing properties to other Node and RenderPass objects.

ManualBindingTargetRuntime is always considered to be connected. If the target object cannot be found, the binding is not executed.

Since

Kanzi 3.7.0

Constructor & Destructor Documentation

ManualBindingTargetRuntime()

kanzi::ManualBindingTargetRuntime::ManualBindingTargetRuntime ( string_view path, AbstractPropertyType propertyType, PropertyField field )

explicitprotected

Constructor.

Parameters

path	Target object path.
propertyType	Target property type.
field	Target property field.

Since

Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

create()

static BindingTargetRuntimePtr kanzi::ManualBindingTargetRuntime::create ( string_view path, AbstractPropertyType propertyType, PropertyField field )

static

Creates a manual binding target runtime.

Parameters

path	Target object path.
propertyType	Target property type.
field	Target property field.

Returns

The created manual binding target runtime.

Since

Kanzi 3.9.6 Removed BindingLookupContextPtr.

getPath()

string kanzi::ManualBindingTargetRuntime::getPath ( ) const

inline

Gets path to object.

Required by inheriting classes.

Returns

Path to object.

getPropertyType()

AbstractPropertyType kanzi::ManualBindingTargetRuntime::getPropertyType ( ) const

inline

Gets property type.

Required by inheriting classes.

Returns

Property type listened to.

getPropertyField()

PropertyField kanzi::ManualBindingTargetRuntime::getPropertyField ( ) const

inline

Gets property type.

Required by inheriting classes.

Returns

Property type listened to.

attachForReadOverride()

void kanzi::ManualBindingTargetRuntime::attachForReadOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::attachForReadOverride() implementation.

Reimplemented from kanzi::BindingTargetRuntime.

attachForWriteOverride()

void kanzi::ManualBindingTargetRuntime::attachForWriteOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::attachForWriteOverride() implementation.

Implements kanzi::BindingTargetRuntime.

detachOverride()

void kanzi::ManualBindingTargetRuntime::detachOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::detachOverride() implementation.

Implements kanzi::BindingTargetRuntime.

isConnectedOverride()

bool kanzi::ManualBindingTargetRuntime::isConnectedOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::isConnectedOverride() implementation.

Implements kanzi::BindingTargetRuntime.

Member Data Documentation

m_path

string kanzi::ManualBindingTargetRuntime::m_path

protected

Path to target object.

m_propertyType

AbstractPropertyType kanzi::ManualBindingTargetRuntime::m_propertyType

protected

Property type written.

m_field

PropertyField kanzi::ManualBindingTargetRuntime::m_field

protected

Property field written.

---

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

• kanzi/core.ui/binding/manual_binding_target_runtime.hpp