Runtime for message binding target. More...

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

Inheritance diagram for kanzi::MessageBindingTargetRuntime:

Public Member Functions
PropertyField	getPropertyField () const
	Gets property field. More...

AbstractPropertyType	getPropertyType () const
	Gets property type. More...

void	setMessage (MessageArguments *args)
	Sets the message to use for acquiring arguments on update. More...

Public Member Functions inherited from kanzi::BindingTargetRuntime
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...

Static Public Member Functions
static BindingTargetRuntimePtr	create (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType, PropertyField field)
	Creates a message binding target runtime. More...

Protected Member Functions
void	attachForReadOverride () override
	BindingTargetRuntime::attachForReadOverride() implementation. More...

void	attachForWriteOverride () override
	BindingTargetRuntime::attachForWriteOverride() implementation. More...

void	detachOverride () override
	BindingTargetRuntime::detachOverride() implementation. More...

bool	isConnectedOverride () override
	BindingTargetRuntime::isConnectedOverride() implementation. More...

	MessageBindingTargetRuntime (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType, PropertyField field)
	Constructor. More...

Protected Member Functions inherited from kanzi::BindingTargetRuntime
	BindingTargetRuntime (BindingLookupContextPtr lookupContext)
	Constructor. More...

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

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

Protected Attributes
PropertyField	m_field
	Property field to use. More...

MessageArguments *	m_messageArguments
	Message set manually to this message binding source. More...

AbstractPropertyType	m_propertyType
	Property type to write. More...

Protected Attributes inherited from kanzi::BindingTargetRuntime
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...

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

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

Detailed Description

Runtime for message binding target.

Since: Kanzi 3.7.0

Constructor & Destructor Documentation

◆ MessageBindingTargetRuntime()

kanzi::MessageBindingTargetRuntime::MessageBindingTargetRuntime	(	BindingLookupContextPtr	lookupContext,
		AbstractPropertyType	propertyType,
		PropertyField	field
	)

explicitprotected

Constructor.

Parameters

lookupContext	Lookup context for this binding source runtime.
propertyType	Property type to use.
field	Property field to use.

Member Function Documentation

◆ create()

static BindingTargetRuntimePtr kanzi::MessageBindingTargetRuntime::create	(	BindingLookupContextPtr	lookupContext,
		AbstractPropertyType	propertyType,
		PropertyField	field
	)

static

Creates a message binding target runtime.

Parameters

lookupContext	Lookup context for this binding source runtime.
propertyType	Property type to use.
field	Property field to use.

◆ getPropertyType()

AbstractPropertyType kanzi::MessageBindingTargetRuntime::getPropertyType ( ) const

inline

Gets property type.

Returns: Property type for this source runtime.

◆ getPropertyField()

PropertyField kanzi::MessageBindingTargetRuntime::getPropertyField ( ) const

inline

Gets property field.

Returns: Property field for this source runtime.

◆ setMessage()

void kanzi::MessageBindingTargetRuntime::setMessage ( MessageArguments * args )

inline

Sets the message to use for acquiring arguments on update.

Parameters

args	Message arguments to use.

◆ attachForReadOverride()

void kanzi::MessageBindingTargetRuntime::attachForReadOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::attachForReadOverride() implementation.

Reimplemented from kanzi::BindingTargetRuntime.

◆ attachForWriteOverride()

void kanzi::MessageBindingTargetRuntime::attachForWriteOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::attachForWriteOverride() implementation.

Implements kanzi::BindingTargetRuntime.

◆ detachOverride()

void kanzi::MessageBindingTargetRuntime::detachOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::detachOverride() implementation.

Implements kanzi::BindingTargetRuntime.

◆ isConnectedOverride()

bool kanzi::MessageBindingTargetRuntime::isConnectedOverride ( )

overrideprotectedvirtual

BindingTargetRuntime::isConnectedOverride() implementation.

Implements kanzi::BindingTargetRuntime.

Member Data Documentation

◆ m_messageArguments

MessageArguments* kanzi::MessageBindingTargetRuntime::m_messageArguments

protected

Message set manually to this message binding source.

◆ m_propertyType

AbstractPropertyType kanzi::MessageBindingTargetRuntime::m_propertyType

protected

Property type to write.

◆ m_field

PropertyField kanzi::MessageBindingTargetRuntime::m_field

protected

Property field to use.

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

kanzi/core.ui/binding/message_binding_target_runtime.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MessageBindingTargetRuntime()

Member Function Documentation

◆ create()

◆ getPropertyType()

◆ getPropertyField()

◆ setMessage()

◆ attachForReadOverride()

◆ attachForWriteOverride()

◆ detachOverride()

◆ isConnectedOverride()

Member Data Documentation

◆ m_messageArguments

◆ m_propertyType

◆ m_field