Specialized binding target for property modifiers installed to objects. More...

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

Inheritance diagram for kanzi::TypedPropertyModifierBindingTargetRuntime< T >:

Public Member Functions
	~TypedPropertyModifierBindingTargetRuntime () override
	Destructor.

Public Member Functions inherited from kanzi::PropertyModifierBindingTargetRuntime
PropertyField	getPropertyField () const
	Gets a property field.

AbstractPropertyType	getPropertyType () const
	Gets a 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 (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
	Create a typed property modifier binding target runtime.

Static Public Member Functions inherited from kanzi::PropertyModifierBindingTargetRuntime
static BindingTargetRuntimePtr	create (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
	Creates a property modifier binding target runtime without a binding target.

Protected Types
using	ObjectPropertyListenerType
	Type name for object property listener.

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

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

void	attachModifier ()
	Detaches value source.

void	detachModifier ()
	Detaches value source.

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

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

void	localPropertyChange () override
	ObjectPropertyListenerImpl::localPropertyChange() implementation.

bool	readOverride (Variant &value) override
	BindingTargetRuntime::readOverride() implementation.

	TypedPropertyModifierBindingTargetRuntime (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
	Constructor.

void	updateModifier (typename PropertyDataTypeTraits< T >::StorageType &storage)
	Updates the modifier.

bool	writeOverride (const Variant &value) override
	BindingTargetRuntime::writeOverride() implementation.

Protected Member Functions inherited from kanzi::PropertyModifierBindingTargetRuntime
	PropertyModifierBindingTargetRuntime (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
	Constructor.

Protected Member Functions inherited from kanzi::BindingTargetRuntime
	BindingTargetRuntime ()=default
	Constructor.

Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject & >
void	attachLocalPropertyListener (PropertyObject & object, AbstractPropertyType propertyType)
	Installs local property listener.

void	clearLocalPropertyListener ()
	Clears the property listener object.

void	detachLocalPropertyListener (AbstractPropertyType propertyType)
	Uninstalls local property listener.

PropertyObject &	getLocalPropertyListenerObject () const
	Gets the property object with a local property listener installed.

bool	isLocalPropertyListenerInstalled () const
	Tells whether a local property listener has been installed.

	ObjectPropertyListenerImpl ()=default
	Constructor.

	~ObjectPropertyListenerImpl ()
	Destructor.

Static Protected Member Functions
static void	modifierCallback (PropertyObject &, typename PropertyDataTypeTraits< T >::StorageType &storage, PropertyNotificationReason, void *owner)
	Modifier callback to be installed.

Static Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject & >
static void	localPropertyChangeCallback (PropertyObject &, const T &, PropertyNotificationReason reason, void *userData)
	Property change callback for object property.

Protected Attributes
bool	m_modifierCallbackInstalled
	Indicates whether the modifier callback is installed.

Variant	m_value
	Last value written to the variant.

Protected Attributes inherited from kanzi::PropertyModifierBindingTargetRuntime
PropertyField	m_field
	Property field to use.

bool	m_localReadListenerRequested
	Is local read listener requested?

PropertyObject &	m_object
	Object the property modifier is installed to.

AbstractPropertyType	m_propertyType
	Property type to use.

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).

Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject & >
PropertyObject *	m_localPropertyListenerObject
	The object to which the local property listener has been installed.

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

using	BindingProcessorRuntimeContainer
	Binding processor container type.

Detailed Description

template<typename T>
class kanzi::TypedPropertyModifierBindingTargetRuntime< T >

Specialized binding target for property modifiers installed to objects.

Since: Kanzi 3.7.0

Member Typedef Documentation

◆ ObjectPropertyListenerType

template<typename T >

using kanzi::TypedPropertyModifierBindingTargetRuntime< T >::ObjectPropertyListenerType

protected

Type name for object property listener.

Constructor & Destructor Documentation

◆ ~TypedPropertyModifierBindingTargetRuntime()

template<typename T >

kanzi::TypedPropertyModifierBindingTargetRuntime< T >::~TypedPropertyModifierBindingTargetRuntime ( )

inlineoverride

Destructor.

◆ TypedPropertyModifierBindingTargetRuntime()

template<typename T >

kanzi::TypedPropertyModifierBindingTargetRuntime< T >::TypedPropertyModifierBindingTargetRuntime	(	AbstractPropertyType	propertyType,
		PropertyField	field,
		PropertyObject &	object )

inlineexplicitprotected

Constructor.

Parameters

propertyType	Property type to use.
field	Property field to use.
object	The PropertyObject install path.

Since: Kanzi 3.9.6 Removed BindingLookupContextPtr, added PropertyObject.

Member Function Documentation

◆ create()

template<typename T >

static BindingTargetRuntimePtr kanzi::TypedPropertyModifierBindingTargetRuntime< T >::create	(	AbstractPropertyType	propertyType,
		PropertyField	field,
		PropertyObject &	object )

inlinestatic

Create a typed property modifier binding target runtime.

Parameters

propertyType	Property type to use.
field	Property field to use.
object	The PropertyObject install path.

Returns: The created property modifier binding target runtime.

Since: Kanzi 3.9.6 Changed lookupContext to PropertyObject install path.