Kanzi  3.9.4
Kanzi Engine API
kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T > Class Template Reference

Typed runtime for render property expression value source. More...

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

Inheritance diagram for kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >:
[legend]

Public Member Functions

 ~TypedRenderPropertyExpressionValueSourceRuntime ()
 Destructor. More...
 
- Public Member Functions inherited from kanzi::RenderPropertyExpressionValueSourceRuntime
string getPath () const
 Gets source path. More...
 
AbstractPropertyType getPropertyType () const
 Gets property type. More...
 
- Public Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
void attach ()
 Attaches this source. More...
 
void detach ()
 Detaches this source. More...
 
VariantgetRegister ()
 Gets the variant from this value source. More...
 
const VariantgetRegister () const
 Gets the variant from this value source. More...
 
virtual ~AbstractExpressionValueSourceRuntime ()
 Destructor. More...
 

Static Public Member Functions

static AbstractExpressionValueSourceRuntimePtr create (RenderPropertyExpressionValueSource &valueSource, ExpressionBindingSourceRuntime &sourceRuntime)
 Create a typed object property expression value source runtime. More...
 

Protected Types

using ObjectPropertyListenerType = ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
 Type name for object property listener. More...
 

Protected Member Functions

void attachMaterialListener ()
 Attach material listener. More...
 
void attachOverride () override
 AbstractExpressionValueSource::attachOverride() implementation. More...
 
void detachMaterialListener ()
 Detach material listener. More...
 
void detachOverride () override
 AbstractExpressionValueSource::detachOverride() implementation. More...
 
void localPropertyChange () override
 ObjectPropertyListenerImpl::localPropertyChange() implementation. More...
 
bool readValue (const PropertyObject &object, Variant &value)
 Performs the value read for this source. More...
 
 TypedRenderPropertyExpressionValueSourceRuntime (RenderPropertyExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::RenderPropertyExpressionValueSourceRuntime
BindingLookupContextgetLookupContext () const
 Gets the binding lookup context. More...
 
MaterialSharedPtr getMaterial () const
 Gets the material attached to. More...
 
 RenderPropertyExpressionValueSourceRuntime (const RenderPropertyExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
 AbstractExpressionValueSourceRuntime (ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
void attachLocalPropertyListener (PropertyObjectSharedPtr object, AbstractPropertyType propertyType)
 Installs local property listener. More...
 
void clearLocalPropertyListener ()
 Clears the property listener object. More...
 
void detachLocalPropertyListener (AbstractPropertyType propertyType)
 Uninstalls local property listener. More...
 
PropertyObjectSharedPtr getLocalPropertyListenerObject () const
 Gets the property object with a local property listener installed. More...
 
bool isLocalPropertyListenerInstalled () const
 Tells whether a local property listener has been installed. More...
 
 ObjectPropertyListenerImpl ()=default
 Constructor. More...
 
 ~ObjectPropertyListenerImpl ()
 Destructor. More...
 

Static Protected Member Functions

static void materialChangeCallback (PropertyObject &, const int &, PropertyNotificationReason reason, void *data)
 Callback for material property changes. More...
 
- Static Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
static void localPropertyChangeCallback (PropertyObject &, const T &, PropertyNotificationReason reason, void *userData)
 Property change callback for object property. More...
 

Protected Attributes

bool m_materialPropertyListenerInstalled
 Is material property listener installed? More...
 
- Protected Attributes inherited from kanzi::RenderPropertyExpressionValueSourceRuntime
const RenderPropertyExpressionValueSourcem_source
 Create info containing settings for this source. More...
 
- Protected Attributes inherited from kanzi::AbstractExpressionValueSourceRuntime
Variant m_cachedValue
 Cached value stored. More...
 
ExpressionBindingSourceRuntimem_host
 Host multi binding source. More...
 
- Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
PropertyObjectWeakPtr m_localPropertyListenerObject
 The object to which the local property listener has been installed. More...
 

Detailed Description

template<typename T>
class kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >

Typed runtime for render property expression value source.

Since
Kanzi 3.9.0

Member Typedef Documentation

◆ ObjectPropertyListenerType

Constructor & Destructor Documentation

◆ ~TypedRenderPropertyExpressionValueSourceRuntime()

◆ TypedRenderPropertyExpressionValueSourceRuntime()

Constructor.

Parameters
sourceSource for this value source runtime.
hostHost expression binding source runtime.

Member Function Documentation

◆ create()

Create a typed object property expression value source runtime.

Parameters
valueSourceSource for this value source runtime.
sourceRuntimeHost expression binding source runtime.
Returns
The created value source runtime.

◆ readValue()

template<typename T >
bool kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::readValue ( const PropertyObject object,
Variant value 
)
inlineprotected

Performs the value read for this source.

Parameters
objectObject to read from.
valueValue to write to.
Returns
True if read was successful, otherwise false.

◆ attachOverride()

template<typename T >
void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::attachOverride ( )
inlineoverrideprotectedvirtual

AbstractExpressionValueSource::attachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

◆ detachOverride()

template<typename T >
void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::detachOverride ( )
inlineoverrideprotectedvirtual

AbstractExpressionValueSource::detachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

◆ localPropertyChange()

◆ attachMaterialListener()

template<typename T >
void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::attachMaterialListener ( )
inlineprotected

Attach material listener.

◆ detachMaterialListener()

template<typename T >
void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::detachMaterialListener ( )
inlineprotected

Detach material listener.

◆ materialChangeCallback()

template<typename T >
static void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::materialChangeCallback ( PropertyObject ,
const int &  ,
PropertyNotificationReason  reason,
void *  data 
)
inlinestaticprotected

Callback for material property changes.

Parameters
reasonReason for the property change.
dataPointer to the listener.

Member Data Documentation

◆ m_materialPropertyListenerInstalled

template<typename T >
bool kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::m_materialPropertyListenerInstalled
protected

Is material property listener installed?


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