Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::TypedPropertyModifierBindingTargetRuntime< T > Class Template Reference

Specialized binding target for property modifiers installed to objects. More...

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

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

Public Member Functions

 ~TypedPropertyModifierBindingTargetRuntime () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::PropertyModifierBindingTargetRuntime
PropertyField getPropertyField () const
 Gets a property field. More...
 
AbstractPropertyType getPropertyType () const
 Gets a property type. 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...
 
BindingProcessorConstIterator beginProcessors () const
 Gets an iterator to the beginning of binding processors. More...
 
void copyBindingProcessors (const AbstractBinding &binding)
 Copies backward direction processors from a binding. More...
 
void detach ()
 Detaches binding target runtime. More...
 
BindingProcessorConstIterator endProcessors () const
 Gets an iterator to the end of binding processors. 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 ()
 Destructor. More...
 

Static Public Member Functions

static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType, PropertyField field)
 Create a typed property modifier binding target runtime. More...
 
- Static Public Member Functions inherited from kanzi::PropertyModifierBindingTargetRuntime
static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType, PropertyField field)
 Creates a property modifier binding target runtime without a binding target. More...
 

Protected Types

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

Protected Member Functions

void attachForReadOverride () override
 BindingTargetRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingTargetRuntime::attachForWriteOverride() implementation. More...
 
void attachModifier ()
 Detaches value source. More...
 
void detachModifier ()
 Detaches value source. More...
 
void detachOverride () override
 BindingTargetRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingTargetRuntime::isConnectedOverride() implementation. More...
 
void localPropertyChange () override
 ObjectPropertyListenerImpl::localPropertyChange() implementation. More...
 
bool readOverride (Variant &value) override
 BindingTargetRuntime::readOverride() implementation. More...
 
 TypedPropertyModifierBindingTargetRuntime (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
void updateModifier (typename PropertyDataTypeTraits< T >::StorageType &storage)
 Updates the modifier. More...
 
bool writeOverride (const Variant &value) override
 BindingTargetRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::PropertyModifierBindingTargetRuntime
 PropertyModifierBindingTargetRuntime (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType, PropertyField field)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
 BindingTargetRuntime (BindingLookupContextPtr lookupContext)
 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...
 

Static Protected Member Functions

static void modifierCallback (PropertyObject &, typename PropertyDataTypeTraits< T >::StorageType &storage, PropertyNotificationReason, void *owner)
 Modifier callback to be installed. 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...
 

Protected Attributes

bool m_modifierCallbackInstalled
 Indicates whether the modifier callback is installed. More...
 
Variant m_value
 Last value written to the variant. More...
 
- Protected Attributes inherited from kanzi::PropertyModifierBindingTargetRuntime
PropertyField m_field
 Property field to use. More...
 
bool m_localReadListenerRequested
 Is local read listener requested? More...
 
PropertyObjectm_object
 Object the property modifier is installed to. More...
 
AbstractPropertyType m_propertyType
 Property type to use. 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...
 
BindingProcessorContainer m_processors
 Binding processors (for the target, backward direction). 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::BindingTargetRuntime
typedef BindingProcessorContainer::const_iterator BindingProcessorConstIterator
 Binding processor iterator type. More...
 
typedef vector< BindingProcessorSharedPtrBindingProcessorContainer
 Binding processor container type. More...
 

Detailed Description

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

Specialized binding target for property modifiers installed to objects.

Since
Kanzi 3.7.0

Member Typedef Documentation

◆ ObjectPropertyListenerType

Type name for object property listener.

Constructor & Destructor Documentation

◆ ~TypedPropertyModifierBindingTargetRuntime()

Destructor.

◆ TypedPropertyModifierBindingTargetRuntime()

Constructor.

Parameters
lookupContextBinding lookup context to use.
propertyTypeProperty type to use.
fieldProperty field to use.

Member Function Documentation

◆ create()

template<typename T >
static BindingTargetRuntimePtr kanzi::TypedPropertyModifierBindingTargetRuntime< T >::create ( BindingLookupContextPtr  lookupContext,
AbstractPropertyType  propertyType,
PropertyField  field 
)
inlinestatic

Create a typed property modifier binding target runtime.

Parameters
lookupContextBinding lookup context to use.
propertyTypeProperty type to use.
fieldProperty field to use.
Returns
The created property modifier binding target runtime.

◆ attachForReadOverride()

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

◆ attachForWriteOverride()

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

◆ detachOverride()

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

◆ isConnectedOverride()

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

◆ readOverride()

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

◆ writeOverride()

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

◆ localPropertyChange()

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

◆ attachModifier()

template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::attachModifier ( )
inlineprotected

Detaches value source.

◆ detachModifier()

template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::detachModifier ( )
inlineprotected

Detaches value source.

◆ updateModifier()

template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::updateModifier ( typename PropertyDataTypeTraits< T >::StorageType &  storage)
inlineprotected

Updates the modifier.

Parameters
storageStorage being modified.

◆ modifierCallback()

template<typename T >
static void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::modifierCallback ( PropertyObject ,
typename PropertyDataTypeTraits< T >::StorageType &  storage,
PropertyNotificationReason  ,
void *  owner 
)
inlinestaticprotected

Modifier callback to be installed.

Member Data Documentation

◆ m_value

template<typename T >
Variant kanzi::TypedPropertyModifierBindingTargetRuntime< T >::m_value
protected

Last value written to the variant.

◆ m_modifierCallbackInstalled

template<typename T >
bool kanzi::TypedPropertyModifierBindingTargetRuntime< T >::m_modifierCallbackInstalled
protected

Indicates whether the modifier callback is installed.


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