Kanzi  3.9.8
Kanzi Engine C++ API
kanzi::TypedObjectPropertyExpressionValueSourceRuntime< T > Class Template Reference

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

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

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

Public Member Functions

 ~TypedObjectPropertyExpressionValueSourceRuntime () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::ObjectPropertyExpressionValueSourceRuntime
string getPath () const
 Gets source path. More...
 
PropertyField getPropertyField () const
 Gets property field. 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...
 
Variant & getRegister ()
 Gets the variant from this value source. More...
 
const Variant & getRegister () const
 Gets the variant from this value source. More...
 
virtual ~AbstractExpressionValueSourceRuntime ()
 Destructor. More...
 
- Public Member Functions inherited from kanzi::BindingLookupNotificationBase
void clearLocalNotificationFlag ()
 Clears local notification flag. More...
 
bool isGlobalNotificationInstalled () const
 Tells if this a global notification has been registered. More...
 
bool isLocalNotificationInstalled () const
 Tells if this a local notification has been registered. More...
 
void registerGlobalNotification (BindingLookupContext &lookupContext, string_view path)
 Installs a global notification listener. More...
 
void registerLocalNotification (BindingLookupContext &lookupContext, PropertyObject *object, string_view path)
 Installs a local notification listener. More...
 
void registerLocalNotification (BindingLookupContext &lookupContext, PropertyObject &object, string_view path)
 Installs a local notification listener. More...
 
void unregisterGlobalNotification (BindingLookupContext &lookupContext, string_view path)
 Uninstalls a global notification listener. More...
 
void unregisterLocalNotification (BindingLookupContext &lookupContext, PropertyObject *object, string_view path)
 Removes a local notification listener. More...
 
void unregisterLocalNotification (BindingLookupContext &lookupContext, PropertyObject &object, string_view path)
 Removes a local notification listener. More...
 
 ~BindingLookupNotificationBase ()
 Destructor. More...
 

Static Public Member Functions

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

Protected Types

using ObjectPropertyListenerType = ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject & >
 Type name for object property listener. More...
 

Protected Member Functions

void attachOverride () override
 AbstractExpressionValueSource::attachOverride() implementation. More...
 
void detachOverride () override
 AbstractExpressionValueSource::detachOverride() implementation. More...
 
void localPropertyChange () override
 ObjectPropertyListenerImpl::localPropertyChange() implementation. More...
 
void onGlobalLookupNotification () override
 BindingLookupNotificationImpl::onGlobalLookupNotification() implementation. More...
 
void onLocalLookupNotification () override
 BindingLookupNotificationImpl::onLocalLookupNotification() implementation. More...
 
void readValue (const PropertyObject &object)
 Performs the value read for this source. More...
 
 TypedObjectPropertyExpressionValueSourceRuntime (ObjectPropertyExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::ObjectPropertyExpressionValueSourceRuntime
BindingLookupContext & getLookupContext ()
 Gets the binding lookup context. More...
 
 ObjectPropertyExpressionValueSourceRuntime (const ObjectPropertyExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
 AbstractExpressionValueSourceRuntime (ExpressionBindingSourceRuntime &host)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingLookupNotificationBase
 BindingLookupNotificationBase ()
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject &>
void attachLocalPropertyListener (PropertyObject & 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...
 
PropertyObject & 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...
 

Additional Inherited Members

- Static Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject &>
static void localPropertyChangeCallback (PropertyObject &, const T &, PropertyNotificationReason reason, void *userData)
 Property change callback for object property. More...
 
- Protected Attributes inherited from kanzi::ObjectPropertyExpressionValueSourceRuntime
PropertyObjectWeakPtr m_object
 Property object attached to. More...
 
const ObjectPropertyExpressionValueSource & m_source
 The Object Property expression value source of this runtime. More...
 
- Protected Attributes inherited from kanzi::AbstractExpressionValueSourceRuntime
Variant m_cachedValue
 Cached value stored. More...
 
ExpressionBindingSourceRuntime & m_host
 Host multi binding source. More...
 
- Protected Attributes inherited from kanzi::BindingLookupNotificationBase
bool m_globalNotificationInstalled
 Is the global notification listener installed? More...
 
bool m_localNotificationInstalled
 Is the local notification listener installed? More...
 
- Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObject *, PropertyObject &>
PropertyObject * m_localPropertyListenerObject
 The object to which the local property listener has been installed. More...
 

Detailed Description

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

Typed runtime for object property expression value source.

Since
Kanzi 3.7.0

Member Typedef Documentation

◆ ObjectPropertyListenerType

Type name for object property listener.

Constructor & Destructor Documentation

◆ ~TypedObjectPropertyExpressionValueSourceRuntime()

◆ TypedObjectPropertyExpressionValueSourceRuntime()

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 >
void kanzi::TypedObjectPropertyExpressionValueSourceRuntime< T >::readValue ( const PropertyObject &  object)
inlineprotected

Performs the value read for this source.

Parameters
objectObject to read from.

◆ attachOverride()

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

AbstractExpressionValueSource::attachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

◆ detachOverride()

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

AbstractExpressionValueSource::detachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

◆ onGlobalLookupNotification()

template<typename T >
void kanzi::TypedObjectPropertyExpressionValueSourceRuntime< T >::onGlobalLookupNotification ( )
inlineoverrideprotectedvirtual

BindingLookupNotificationImpl::onGlobalLookupNotification() implementation.

Implements kanzi::BindingLookupNotificationBase.

◆ onLocalLookupNotification()

template<typename T >
void kanzi::TypedObjectPropertyExpressionValueSourceRuntime< T >::onLocalLookupNotification ( )
inlineoverrideprotectedvirtual

BindingLookupNotificationImpl::onLocalLookupNotification() implementation.

Implements kanzi::BindingLookupNotificationBase.

◆ localPropertyChange()


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