Kanzi  3.9.5
Kanzi Engine API
kanzi::RenderValueBindingTargetRuntime Class Reference

Runtime for render value binding target. More...

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

Inheritance diagram for kanzi::RenderValueBindingTargetRuntime:
[legend]

Public Member Functions

GlRenderStategetRenderState () const
 Gets the render state from the associated render value lookup context. More...
 
BindingRenderValueLookupContextgetRenderValueLookupContext () const
 Gets the lookup context as correct type. More...
 
string getRenderValueName () const
 Gets the name of the render value used. 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
 Accesses target 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 (BindingLookupContextPtr lookupContext, PropertyDataType dataType, string_view renderValueName)
 Creates a new object render value binding target runtime. More...
 
static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType)
 Creates a new object render value binding target runtime. More...
 

Protected Member Functions

void attachForReadOverride () override
 BindingTargetRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingTargetRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingTargetRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingTargetRuntime::isConnectedOverride() implementation. More...
 
 RenderValueBindingTargetRuntime (BindingLookupContextPtr lookupContext, string_view renderValueName)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
 BindingTargetRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 
virtual bool readOverride (Variant &value)
 Implementation-dependent read. More...
 
virtual bool writeOverride (const Variant &value)=0
 Implementation-dependent write. More...
 

Protected Attributes

string m_renderValueName
 Target property type. More...
 
- Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this target. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding target runtime is attached to. 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

Runtime for render value binding target.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ RenderValueBindingTargetRuntime()

kanzi::RenderValueBindingTargetRuntime::RenderValueBindingTargetRuntime ( BindingLookupContextPtr  lookupContext,
string_view  renderValueName 
)
explicitprotected

Constructor.

Parameters
lookupContextBinding lookup context to use.
renderValueNameName of the render value to use.

Member Function Documentation

◆ create() [1/2]

static BindingTargetRuntimePtr kanzi::RenderValueBindingTargetRuntime::create ( BindingLookupContextPtr  lookupContext,
PropertyDataType  dataType,
string_view  renderValueName 
)
static

Creates a new object render value binding target runtime.

Parameters
lookupContextBinding lookup context to use.
dataTypeData type for the target.
renderValueNameName of the render value to use.

◆ create() [2/2]

static BindingTargetRuntimePtr kanzi::RenderValueBindingTargetRuntime::create ( BindingLookupContextPtr  lookupContext,
AbstractPropertyType  propertyType 
)
inlinestatic

Creates a new object render value binding target runtime.

Parameters
lookupContextBinding lookup context to use.
propertyTypeTarget property type to get the data type and name from.

◆ getRenderValueName()

string kanzi::RenderValueBindingTargetRuntime::getRenderValueName ( ) const
inline

Gets the name of the render value used.

Returns
Render value name.

◆ getRenderValueLookupContext()

BindingRenderValueLookupContext& kanzi::RenderValueBindingTargetRuntime::getRenderValueLookupContext ( ) const

Gets the lookup context as correct type.

Returns
Render value lookup context.

◆ getRenderState()

GlRenderState& kanzi::RenderValueBindingTargetRuntime::getRenderState ( ) const

Gets the render state from the associated render value lookup context.

Returns
Render state.

◆ attachForReadOverride()

void kanzi::RenderValueBindingTargetRuntime::attachForReadOverride ( )
overrideprotectedvirtual

◆ attachForWriteOverride()

void kanzi::RenderValueBindingTargetRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::RenderValueBindingTargetRuntime::detachOverride ( )
overrideprotectedvirtual

◆ isConnectedOverride()

bool kanzi::RenderValueBindingTargetRuntime::isConnectedOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_renderValueName

string kanzi::RenderValueBindingTargetRuntime::m_renderValueName
protected

Target property type.


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