Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::BindingProcessorRuntime Class Referenceabstract

Holds the runtime state of a binding processor. More...

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

Inheritance diagram for kanzi::BindingProcessorRuntime:
[legend]

Public Member Functions

void attach (AbstractBindingRuntime &bindingRuntime)
 Called when the binding source or target runtime containing the processor runtime is being attached. More...
 
void detach ()
 Called when the binding source or target runtime containing the processor runtime is being detached. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Gets the binding runtime. More...
 
BindingProcessorgetProcessor () const
 Gets the binding processor. More...
 
bool validate (Variant &value)
 Returns true if the BindingProcessorRuntime has a valid state. More...
 
virtual ~BindingProcessorRuntime ()=default
 Destructor. More...
 

Protected Member Functions

virtual void attachOverride (AbstractBindingRuntime &bindingRuntime)
 Implementation-specific attach of the binding processor runtime. More...
 
 BindingProcessorRuntime (BindingProcessor &processor)
 Constructor. More...
 
virtual void detachOverride ()
 Implementation-specific detach of the binding processor runtime. More...
 
virtual bool validateOverride (Variant &value)=0
 Called when validate is called. More...
 

Protected Attributes

AbstractBindingRuntimem_bindingRuntime
 The binding runtime containing the BindingProcessorRuntime. More...
 
BindingProcessorm_processor
 The processor whose runtime state is held by the BindingProcessorRuntime. More...
 

Detailed Description

Holds the runtime state of a binding processor.

Since
Kanzi 3.9.3

Constructor & Destructor Documentation

virtual kanzi::BindingProcessorRuntime::~BindingProcessorRuntime ( )
virtualdefault

Destructor.

kanzi::BindingProcessorRuntime::BindingProcessorRuntime ( BindingProcessor processor)
explicitprotected

Constructor.

Parameters
processorThe processor whose runtime state is held by the BindingProcessorRuntime.

Member Function Documentation

void kanzi::BindingProcessorRuntime::attach ( AbstractBindingRuntime bindingRuntime)

Called when the binding source or target runtime containing the processor runtime is being attached.

Parameters
bindingRuntimeBinding runtime being attached to.
Since
Kanzi 3.9.7 removed the lookupContext parameter. Use getBindingRuntime().getLookupContext() instead.
void kanzi::BindingProcessorRuntime::detach ( )

Called when the binding source or target runtime containing the processor runtime is being detached.

bool kanzi::BindingProcessorRuntime::validate ( Variant value)

Returns true if the BindingProcessorRuntime has a valid state.

Returns
True if the BindingProcessorRuntime has a valid state.
AbstractBindingRuntime* kanzi::BindingProcessorRuntime::getBindingRuntime ( ) const
inline

Gets the binding runtime.

Returns
Pointer to binding runtime. or nullptr if the processor runtime is not attached.
BindingProcessor& kanzi::BindingProcessorRuntime::getProcessor ( ) const
inline

Gets the binding processor.

Returns
reference to BindingProcessor.
virtual void kanzi::BindingProcessorRuntime::attachOverride ( AbstractBindingRuntime bindingRuntime)
protectedvirtual

Implementation-specific attach of the binding processor runtime.

Called when the binding source or target runtime containing the processor runtime is being attached. Child classes should first call the parent class attachOverride().

Parameters
bindingRuntimeBinding runtime being attached to.
Since
Kanzi 3.9.7 removed the lookupContext parameter. Use getBindingRuntime().getLookupContext() instead.

Reimplemented in kanzi::ResourceBindingProcessorRuntime, kanzi::ConstraintBindingProcessorRuntime< T >, kanzi::AnimationBindingProcessorRuntime, and kanzi::InstructionBindingProcessorRuntime.

virtual void kanzi::BindingProcessorRuntime::detachOverride ( )
protectedvirtual

Implementation-specific detach of the binding processor runtime.

Called when the binding source or target runtime containing the processor runtime is being detached. Child classes should call the parent class detachOverride() as last part of their execution.

Reimplemented in kanzi::ConstraintBindingProcessorRuntime< T >, kanzi::ResourceBindingProcessorRuntime, kanzi::AnimationBindingProcessorRuntime, kanzi::InstructionBindingProcessorRuntime, and kanzi::RangeBindingProcessorRuntime.

virtual bool kanzi::BindingProcessorRuntime::validateOverride ( Variant value)
protectedpure virtual

Member Data Documentation

AbstractBindingRuntime* kanzi::BindingProcessorRuntime::m_bindingRuntime
protected

The binding runtime containing the BindingProcessorRuntime.

BindingProcessor& kanzi::BindingProcessorRuntime::m_processor
protected

The processor whose runtime state is held by the BindingProcessorRuntime.


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