kanzi::ManualBinding Class Reference

Manual binding is a one-to-one binding that caches the value that was written to the target. More...

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

Inheritance diagram for kanzi::ManualBinding:

Static Public Member Functions
static ManualBindingSharedPtr	create (BindingSourcePtr source)
	Creates a manual binding.
static ManualBindingSharedPtr	create (string_view sourcePath, AbstractPropertyType sourcePropertyType, PropertyField sourceField)
	Creates a manual binding.

Protected Member Functions
AbstractBindingRuntimeSharedPtr	createRuntimeOverride (AbstractBindingSharedPtr binding, BindingLookupContextPtr sourceLookupContext, BindingTargetRuntimePtr targetRuntime) override
	AbstractBinding::createRuntime() implementation.
	ManualBinding (BindingSourcePtr source)
	Constructor.
Protected Member Functions inherited from kanzi::AbstractBinding
	AbstractBinding (BindingSourcePtr source)
	Constructor.
virtual void	addReverseProcessorOverride (BindingProcessorSharedPtr processor)
	Implementation-dependent binding processor add (reverse direction).
virtual BindingProcessorConstIterator	beginReverseProcessorsOverride () const
	Implementation-dependent access to reverse direction binding processors.
virtual BindingProcessorConstIterator	endReverseProcessorsOverride () const
	Implementation-dependent access to reverse direction binding processors.
virtual void	removeReverseProcessorOverride (BindingProcessor &processor)
	Implementation-dependent binding processor remove (reverse direction).

Additional Inherited Members
Public Types inherited from kanzi::AbstractBinding
using	BindingProcessorConstIterator
	Binding processor iterator type.
using	BindingProcessorContainer
	Binding processor container type.
Public Member Functions inherited from kanzi::AbstractBinding
void	addProcessor (BindingProcessorSharedPtr processor)
	Add a binding processor.
void	addReverseProcessor (BindingProcessorSharedPtr processor)
	Add a binding processor (reverse direction).
BindingProcessorConstIterator	beginProcessors () const
	Gets an iterator to the beginning of binding processors.
BindingProcessorConstIterator	beginReverseProcessors () const
	Gets an iterator to the beginning of reverse direction binding processors.
AbstractBindingRuntimeSharedPtr	createRuntime (AbstractBindingSharedPtr binding, BindingLookupContextPtr sourceLookupContext, BindingTargetRuntimePtr targetRuntime)
	Creates a binding runtime for this binding.
BindingProcessorConstIterator	endProcessors () const
	Gets an iterator to the end of binding processors.
BindingProcessorConstIterator	endReverseProcessors () const
	Gets an iterator to the end of reverse direction binding processors.
BindingSource *	getSource ()
	Gets the binding source for this binding.
bool	isCreatedFromKZB () const
	Indicates whether the binding is sourced from a KZB? Used to check whether or not to remove the binding during patching.
void	removeProcessor (BindingProcessor &processor)
	Remove a binding processor.
void	removeReverseProcessor (BindingProcessor &processor)
	Remove a binding processor (reverse direction).
void	setCreatedFromKZB (bool flag)
	Sets the created from KZB flag.
virtual	~AbstractBinding ()=default
	Destructor.
Protected Attributes inherited from kanzi::AbstractBinding
bool	m_createdFromKZB
	Is the binding sourced from a KZB? This field is used to determine if the binding should be removed during patching.
BindingProcessorContainer	m_processors
	Binding processor (forward direction).
BindingSourcePtr	m_source
	Binding source.

Detailed Description

Manual binding is a one-to-one binding that caches the value that was written to the target.

Kanzi Engine uses manual bindings internally in triggers and actions.

In a manual binding you can either:

• Call update to read from source and then write to target
• Call read and write separately

Creating a manual binding

To create a manual binding, first create a manual binding source:

        // Create a manual binding source.
        BindingSourcePtr manualSource = ManualBindingSource::create("../siblingNode", Node2D::OpacityProperty, PropertyFieldWhole);

Then create a manual binding:

        // Create a manual binding.
        ManualBindingSharedPtr manualBinding = ManualBinding::create(kanzi::move(manualSource));
 
        // Set the binding to a node, cast the runtime.
        ManualBindingRuntimeSharedPtr manualRuntime = dynamic_pointer_cast<ManualBindingRuntime>(node->setBinding(manualBinding, Node2D::OpacityProperty).getBinding());

You can also use manual bindings with a regular ObjectPropertyBindingSource or DataSourceBindingSource. In that case the only difference to a regular Binding is that manual bindings cache the value within the binding. This is not always desired, because it can alter the lifetime of resources in the case of resource bindings.

Executing bindings manually

You can explicitly run update() on any binding, but it makes most sense when using manual bindings and sources that otherwise do not update automatically.

To execute a binding:

        // Run binding update manually.
        manualRuntime->update();

With manual bindings, you can split the update into read and write parts. To first read, then write:

        // Run read phase of manual runtime.
        manualRuntime->read();
 
        // readValue will contain the value read during binding read phase.
        Variant readValue = manualRuntime->getCachedValue();
 
        // Run write phase of manual runtime.
        manualRuntime->write();

Delayed actions internally first call read and then write.

Since

Kanzi 3.7.0

Constructor & Destructor Documentation

ManualBinding()

kanzi::ManualBinding::ManualBinding ( BindingSourcePtr source )

inlineexplicitprotected

Constructor.

Parameters

source

Binding source.

Member Function Documentation

create() [1/2]

static ManualBindingSharedPtr kanzi::ManualBinding::create ( BindingSourcePtr source )

static

Creates a manual binding.

Parameters

source

Binding source.

Returns

The manual binding.

create() [2/2]

static ManualBindingSharedPtr kanzi::ManualBinding::create ( string_view sourcePath, AbstractPropertyType sourcePropertyType, PropertyField sourceField )

static

Creates a manual binding.

Parameters

sourcePath	Path to source object.
sourcePropertyType	Source property type from which to bind.
sourceField	Field of the source property type from which to bind. PropertyFieldWhole for the whole property.

Returns

The manual binding.

createRuntimeOverride()

AbstractBindingRuntimeSharedPtr kanzi::ManualBinding::createRuntimeOverride ( AbstractBindingSharedPtr binding, BindingLookupContextPtr sourceLookupContext, BindingTargetRuntimePtr targetRuntime )

overrideprotectedvirtual

AbstractBinding::createRuntime() implementation.

Implements kanzi::AbstractBinding.

---

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

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