kanzi::BindingProcessorRuntime Class Reference

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

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

Inheritance diagram for kanzi::BindingProcessorRuntime:

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

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

Protected Attributes
AbstractBindingRuntime *	m_bindingRuntime
	The binding runtime containing the BindingProcessorRuntime.
BindingProcessor &	m_processor
	The processor whose runtime state is held by the BindingProcessorRuntime.

Detailed Description

Holds the runtime state of a binding processor.

Since

Kanzi 3.9.3

Constructor & Destructor Documentation

~BindingProcessorRuntime()

virtual kanzi::BindingProcessorRuntime::~BindingProcessorRuntime ( )

virtualdefault

Destructor.

BindingProcessorRuntime()

kanzi::BindingProcessorRuntime::BindingProcessorRuntime ( BindingProcessor & processor )

explicitprotected

Constructor.

Parameters

processor

The processor whose runtime state is held by the BindingProcessorRuntime.

Member Function Documentation

attach()

void kanzi::BindingProcessorRuntime::attach

(

AbstractBindingRuntime &

bindingRuntime

)

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

Parameters

bindingRuntime

Binding runtime being attached to.

Since

Kanzi 3.9.7 removed the lookupContext parameter. Use getBindingRuntime().getLookupContext() instead.

detach()

void kanzi::BindingProcessorRuntime::detach

(

)

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

validate()

bool kanzi::BindingProcessorRuntime::validate

(

Variant &

value

)

Returns true if the BindingProcessorRuntime has a valid state.

Returns

True if the BindingProcessorRuntime has a valid state.

getBindingRuntime()

AbstractBindingRuntime * kanzi::BindingProcessorRuntime::getBindingRuntime ( ) const

inline

Gets the binding runtime.

Returns

Pointer to binding runtime. or nullptr if the processor runtime is not attached.

getProcessor()

BindingProcessor & kanzi::BindingProcessorRuntime::getProcessor ( ) const

inline

Gets the binding processor.

Returns

reference to BindingProcessor.

attachOverride()

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

bindingRuntime

Binding runtime being attached to.

Since

Kanzi 3.9.7 removed the lookupContext parameter. Use getBindingRuntime().getLookupContext() instead.

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

detachOverride()

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::ResourceBindingProcessorRuntime, kanzi::AnimationBindingProcessorRuntime, kanzi::ConstraintBindingProcessorRuntime< T >, kanzi::InstructionBindingProcessorRuntime, and kanzi::RangeBindingProcessorRuntime.

validateOverride()

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

protectedpure virtual

Called when validate is called.

Classes inheriting from BindingProcessorRuntime should implement this method.

Returns

True if the BindingProcessorRuntime has a valid state.

Implemented in kanzi::ResourceBindingProcessorRuntime, kanzi::AnimationBindingProcessorRuntime, kanzi::CallbackProcessorRuntime, kanzi::ConstraintBindingProcessorRuntime< T >, kanzi::InstructionBindingProcessorRuntime, kanzi::RangeAccumulateBindingProcessorRuntime, and kanzi::RangeBindingProcessorRuntime.

Member Data Documentation

m_bindingRuntime

AbstractBindingRuntime* kanzi::BindingProcessorRuntime::m_bindingRuntime

protected

The binding runtime containing the BindingProcessorRuntime.

m_processor

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:

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