kanzi::MessageBindingSourceRuntime Class Reference

Runtime for message binding source. More...

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

Inheritance diagram for kanzi::MessageBindingSourceRuntime:

Public Member Functions
PropertyField	getPropertyField () const
	Gets property field.
AbstractPropertyType	getPropertyType () const
	Gets property type.
void	setMessage (MessageArguments *args)
	Sets the message to use for acquiring arguments on update.
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.

Protected Member Functions
void	attachForReadOverride () override
	BindingSourceRuntime::attachForReadOverride() implementation.
void	attachForWriteOverride () override
	BindingSourceRuntime::attachForWriteOverride() implementation.
void	detachOverride () override
	BindingSourceRuntime::detachOverride() implementation.
bool	isConnectedOverride () override
	BindingSourceRuntime::isConnectedOverride() implementation.
	MessageBindingSourceRuntime (const MessageBindingSource &source)
	Constructor.
Protected Member Functions inherited from kanzi::BindingSourceRuntime
	BindingSourceRuntime ()=default
	Constructor.
virtual bool	readOverride (Variant &value)=0
	Implementation-dependent read.
virtual bool	writeOverride (const Variant &value)
	Implementation-dependent write.

Protected Attributes
MessageArguments *	m_messageArguments
	Message set manually to this message binding source.
const MessageBindingSource &	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).

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

Detailed Description

Runtime for message binding source.

Since

Kanzi 3.7.0

Constructor & Destructor Documentation

MessageBindingSourceRuntime()

kanzi::MessageBindingSourceRuntime::MessageBindingSourceRuntime ( const MessageBindingSource & source )

inlineexplicitprotected

Constructor.

Parameters

source

Host message binding source.

Since

Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

getPropertyType()

AbstractPropertyType kanzi::MessageBindingSourceRuntime::getPropertyType

(

)

const

Gets property type.

Returns

Property type for this source runtime.

getPropertyField()

PropertyField kanzi::MessageBindingSourceRuntime::getPropertyField

(

)

const

Gets property field.

Returns

Property field for this source runtime.

setMessage()

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

inline

Sets the message to use for acquiring arguments on update.

Parameters

args	Message arguments to use.

attachForReadOverride()

void kanzi::MessageBindingSourceRuntime::attachForReadOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::attachForReadOverride() implementation.

Implements kanzi::BindingSourceRuntime.

attachForWriteOverride()

void kanzi::MessageBindingSourceRuntime::attachForWriteOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::attachForWriteOverride() implementation.

Implements kanzi::BindingSourceRuntime.

detachOverride()

void kanzi::MessageBindingSourceRuntime::detachOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::detachOverride() implementation.

Implements kanzi::BindingSourceRuntime.

isConnectedOverride()

bool kanzi::MessageBindingSourceRuntime::isConnectedOverride ( )

overrideprotectedvirtual

BindingSourceRuntime::isConnectedOverride() implementation.

Implements kanzi::BindingSourceRuntime.

Member Data Documentation

m_messageArguments

MessageArguments* kanzi::MessageBindingSourceRuntime::m_messageArguments

protected

Message set manually to this message binding source.

m_source

const MessageBindingSource& kanzi::MessageBindingSourceRuntime::m_source

protected

Host binding source.

---

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

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