Kanzi  3.9.5
Kanzi Engine API
kanzi::TypedObjectPropertyBindingSourceRuntime< T > Class Template Reference

Runtime for object property binding source. More...

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

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

Public Member Functions

 ~TypedObjectPropertyBindingSourceRuntime () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::ObjectPropertyBindingSourceRuntime
string getPath () const
 Gets path to object. More...
 
PropertyField getPropertyField () const
 Gets property field. More...
 
AbstractPropertyType getPropertyType () const
 Gets property type. More...
 
- Public Member Functions inherited from kanzi::BindingSourceRuntime
void attachForRead ()
 Attaches the binding source runtime for reading. More...
 
void attachForWrite ()
 Attaches the binding source runtime for writing. More...
 
BindingProcessorRuntimeConstIterator beginProcessorRuntimes () const
 Gets an iterator to the beginning of binding processors. More...
 
void createBindingProcessorRuntimes (const AbstractBinding &binding)
 Creates a processor runtime for each BindingProcessor held by the binding parameter. More...
 
void detach ()
 Detaches the binding source runtime. More...
 
BindingProcessorRuntimeConstIterator endProcessorRuntimes () const
 Gets an iterator to the end of binding processors. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Returns the source lookup context. More...
 
BindingLookupContextgetLookupContext () const
 Returns the source lookup context. More...
 
bool isConnected ()
 Indicates whether this source is connected. More...
 
bool read (Variant &value)
 Reads a value from binding source. More...
 
void setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
 Sets the binding runtime. More...
 
bool write (const Variant &value)
 Writes a value to binding source. More...
 
virtual ~BindingSourceRuntime ()=default
 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 BindingSourceRuntimePtr create (const ObjectPropertyBindingSource &source, BindingLookupContextPtr lookupContext)
 Creates a typed object property binding source runtime. More...
 

Protected Types

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

Protected Member Functions

void attachForReadOverride () override
 BindingSourceRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingSourceRuntime::attachOverride() implementation. More...
 
void detachOverride () override
 BindingSourceRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingSourceRuntime::isConnectedOverride() implementation. More...
 
void localPropertyChange () override
 ObjectPropertyListenerImpl::localPropertyChange() implementation. More...
 
void onGlobalLookupNotification () override
 BindingLookupNotificationImpl::onGlobalLookupNotification() implementation. More...
 
void onLocalLookupNotification () override
 BindingLookupNotificationImpl::onLocalLookupNotification() implementation. More...
 
bool readOverride (Variant &value) override
 BindingSourceRuntime::readOverride() implementation. More...
 
 TypedObjectPropertyBindingSourceRuntime (const ObjectPropertyBindingSource &source, BindingLookupContextPtr lookupContext)
 Constructor. More...
 
bool writeOverride (const Variant &value) override
 BindingSourceRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::ObjectPropertyBindingSourceRuntime
 ObjectPropertyBindingSourceRuntime (const ObjectPropertyBindingSource &source, BindingLookupContextPtr lookupContext)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
 BindingSourceRuntime (BindingLookupContextPtr lookupContext)
 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...
 
PropertyObjectgetLocalPropertyListenerObject () 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...
 

Protected Attributes

bool m_localPropertyListenerRequested
 Is the local property listener requested? More...
 
PropertyObjectWeakPtr m_object
 Property object attached to. More...
 
- Protected Attributes inherited from kanzi::ObjectPropertyBindingSourceRuntime
const ObjectPropertyBindingSourcem_source
 Host binding source. More...
 
- Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this source. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding source runtime is attached to. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors (for the source, forward direction). 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 &>
PropertyObjectm_localPropertyListenerObject
 The object to which the local property listener has been installed. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BindingSourceRuntime
using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor runtime constant iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 Binding processor runtime container type. More...
 
- 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...
 

Detailed Description

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

Runtime for object property binding source.

Since
Kanzi 3.7.0

Member Typedef Documentation

◆ ObjectPropertyListenerType

Type name for object property listener.

Constructor & Destructor Documentation

◆ ~TypedObjectPropertyBindingSourceRuntime()

Destructor.

◆ TypedObjectPropertyBindingSourceRuntime()

template<typename T >
kanzi::TypedObjectPropertyBindingSourceRuntime< T >::TypedObjectPropertyBindingSourceRuntime ( const ObjectPropertyBindingSource source,
BindingLookupContextPtr  lookupContext 
)
inlineexplicitprotected

Constructor.

Parameters
sourceHost object property binding source.
lookupContextBinding lookup context for this target.

Member Function Documentation

◆ create()

template<typename T >
static BindingSourceRuntimePtr kanzi::TypedObjectPropertyBindingSourceRuntime< T >::create ( const ObjectPropertyBindingSource source,
BindingLookupContextPtr  lookupContext 
)
inlinestatic

Creates a typed object property binding source runtime.

Parameters
sourceHost object property binding source.
lookupContextBinding lookup context for this target.
Returns
The created typed object property binding source runtime.

◆ attachForWriteOverride()

template<typename T >
void kanzi::TypedObjectPropertyBindingSourceRuntime< T >::attachForWriteOverride ( )
inlineoverrideprotectedvirtual

BindingSourceRuntime::attachOverride() implementation.

Implements kanzi::BindingSourceRuntime.

◆ attachForReadOverride()

template<typename T >
void kanzi::TypedObjectPropertyBindingSourceRuntime< T >::attachForReadOverride ( )
inlineoverrideprotectedvirtual

◆ detachOverride()

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

◆ isConnectedOverride()

template<typename T >
bool kanzi::TypedObjectPropertyBindingSourceRuntime< T >::isConnectedOverride ( )
inlineoverrideprotectedvirtual

◆ readOverride()

template<typename T >
bool kanzi::TypedObjectPropertyBindingSourceRuntime< T >::readOverride ( Variant value)
inlineoverrideprotectedvirtual

◆ writeOverride()

template<typename T >
bool kanzi::TypedObjectPropertyBindingSourceRuntime< T >::writeOverride ( const Variant value)
inlineoverrideprotectedvirtual

◆ onGlobalLookupNotification()

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

BindingLookupNotificationImpl::onGlobalLookupNotification() implementation.

Implements kanzi::BindingLookupNotificationBase.

◆ onLocalLookupNotification()

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

BindingLookupNotificationImpl::onLocalLookupNotification() implementation.

Implements kanzi::BindingLookupNotificationBase.

◆ localPropertyChange()

template<typename T >
void kanzi::TypedObjectPropertyBindingSourceRuntime< T >::localPropertyChange ( )
inlineoverrideprotectedvirtual

Member Data Documentation

◆ m_object

template<typename T >
PropertyObjectWeakPtr kanzi::TypedObjectPropertyBindingSourceRuntime< T >::m_object
protected

Property object attached to.

◆ m_localPropertyListenerRequested

template<typename T >
bool kanzi::TypedObjectPropertyBindingSourceRuntime< T >::m_localPropertyListenerRequested
protected

Is the local property listener requested?


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