Kanzi  3.9.7
Kanzi Engine API
kanzi::ValueSourceBindingTargetRuntime Class Reference

Base class for value source binding target runtimes. More...

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

Inheritance diagram for kanzi::ValueSourceBindingTargetRuntime:
[legend]

Public Member Functions

void clearValueSourceOwner ()
 Clears the value source owner. More...
 
PropertyValuePrecedence getPrecedence () const
 Gets value source precedence. More...
 
PropertyField getPropertyField () const
 Gets a property field. More...
 
AbstractPropertyType getPropertyType () const
 Gets a property type. More...
 
bool hasValueSourceOwner () const
 Indicates whether this target runtime still has a value source owner. 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...
 
AbstractBindingRuntimegetBindingRuntime () const
 Gets the binding runtime. More...
 
BindingLookupContextgetLookupContext () const
 Gets the 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 (AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, bool reuseAllowed, BindingLookupContext &lookupContext)
 Creates a value source binding target runtime without an actual binding target. More...
 

Protected Member Functions

 ValueSourceBindingTargetRuntime (AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, PropertyObject *object)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
virtual void attachForReadOverride ()
 Implementation-dependent attach. More...
 
virtual void attachForWriteOverride ()=0
 Implementation-dependent attach. More...
 
 BindingTargetRuntime ()=default
 Constructor. More...
 
virtual void detachOverride ()=0
 Implementation-dependent detach. More...
 
virtual bool isConnectedOverride ()=0
 Implementation-dependent connected check. 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...
 
bool m_localReadListenerRequested
 Indicates whether the local read listener is requested. More...
 
PropertyObjectm_object
 Object the value source is installed to. More...
 
PropertyValuePrecedence m_precedence
 Precedence to use. More...
 
AbstractPropertyType m_propertyType
 Property type to use. More...
 
AbstractPropertyTypeDescriptor::ValueSourceOwnerm_valueSourceOwner
 Owner for the binding value source this runtime installs. More...
 
- Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this target. 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

Base class for value source binding target runtimes.

Inherited by type-specialized version.

Kanzi creates a value source binding target runtime when you add a binding to a Node or RenderPass using the setBinding() function.

To create a ValueSourceBindingTargetRuntime for a binding runtime when adding the binding to a Node or RenderPass:

// Calling setBinding() will install the binding runtime as a property value source.
BindingRuntimeHandle runtime = node->setBinding(binding, Node2D::OpacityProperty);

ValueSourceBindingTargetRuntime creates a property value source, that owns the binding runtime that was created. If the property value source in Node or RenderPass is removed, the binding runtime is removed as well. As bindings are usually set with local precedence, setting a local value with setProperty() removes the binding.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

kanzi::ValueSourceBindingTargetRuntime::ValueSourceBindingTargetRuntime ( AbstractPropertyType  propertyType,
PropertyField  field,
PropertyValuePrecedence  precedence,
PropertyObject object 
)
explicitprotected

Constructor.

Parameters
propertyTypeProperty type to use.
fieldProperty field to use.
precedenceProperty value precedence.
objectThe PropertyObject to install to.
Since
Kanzi 3.9.6 Removed BindingLookupContext, added PropertyObject.

Member Function Documentation

static BindingTargetRuntimePtr kanzi::ValueSourceBindingTargetRuntime::create ( AbstractPropertyType  propertyType,
PropertyField  field,
PropertyValuePrecedence  precedence,
bool  reuseAllowed,
BindingLookupContext lookupContext 
)
static

Creates a value source binding target runtime without an actual binding target.

Parameters
propertyTypeProperty type to use.
fieldProperty field to use.
precedenceProperty value precedence.
reuseAllowedWhether reuse of the installed value source is allowed by other functionality, such as setProperty.
lookupContextThe lookup context to use for getting the target object.
Returns
The value source binding target runtime.
Since
Kanzi 3.9.6 Changed BindingLookupContextPtr, to BindingLookupContext&.
AbstractPropertyType kanzi::ValueSourceBindingTargetRuntime::getPropertyType ( ) const
inline

Gets a property type.

Required by the inheriting classes.

Returns
Property type for this target.
PropertyField kanzi::ValueSourceBindingTargetRuntime::getPropertyField ( ) const
inline

Gets a property field.

Returns
Property field.
PropertyValuePrecedence kanzi::ValueSourceBindingTargetRuntime::getPrecedence ( ) const
inline

Gets value source precedence.

Required by the inheriting classes.

Returns
Precedence for this target.
bool kanzi::ValueSourceBindingTargetRuntime::hasValueSourceOwner ( ) const
inline

Indicates whether this target runtime still has a value source owner.

Returns
If the value source owner exists, true, otherwise false.
void kanzi::ValueSourceBindingTargetRuntime::clearValueSourceOwner ( )
inline

Clears the value source owner.

To be called by the owner upon destruction to prevent recursive destruction.

Member Data Documentation

AbstractPropertyType kanzi::ValueSourceBindingTargetRuntime::m_propertyType
protected

Property type to use.

PropertyField kanzi::ValueSourceBindingTargetRuntime::m_field
protected

Property field to use.

PropertyValuePrecedence kanzi::ValueSourceBindingTargetRuntime::m_precedence
protected

Precedence to use.

PropertyObject& kanzi::ValueSourceBindingTargetRuntime::m_object
protected

Object the value source is installed to.

bool kanzi::ValueSourceBindingTargetRuntime::m_localReadListenerRequested
protected

Indicates whether the local read listener is requested.

AbstractPropertyTypeDescriptor::ValueSourceOwner* kanzi::ValueSourceBindingTargetRuntime::m_valueSourceOwner
protected

Owner for the binding value source this runtime installs.

Not created before the binding has been executed once.


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