Kanzi  3.9.9
Kanzi Engine C++ 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...
 
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
 Gets the 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 (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
 Create a typed property modifier binding target runtime. More...
 
- Static Public Member Functions inherited from kanzi::PropertyModifierBindingTargetRuntime
static BindingTargetRuntimePtr create (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
 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 (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
 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 (AbstractPropertyType propertyType, PropertyField field, PropertyObject &object)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
 BindingTargetRuntime ()=default
 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...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors runtimes (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
using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 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

Type name for object property listener.

Constructor & Destructor Documentation

Destructor.

template<typename T >
kanzi::TypedPropertyModifierBindingTargetRuntime< T >::TypedPropertyModifierBindingTargetRuntime ( AbstractPropertyType  propertyType,
PropertyField  field,
PropertyObject object 
)
inlineexplicitprotected

Constructor.

Parameters
propertyTypeProperty type to use.
fieldProperty field to use.
objectThe PropertyObject install path.
Since
Kanzi 3.9.6 Removed BindingLookupContextPtr, added PropertyObject.

Member Function Documentation

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

Create a typed property modifier binding target runtime.

Parameters
propertyTypeProperty type to use.
fieldProperty field to use.
objectThe PropertyObject install path.
Returns
The created property modifier binding target runtime.
Since
Kanzi 3.9.6 Changed lookupContext to PropertyObject install path.
template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::attachForReadOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::attachForWriteOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::detachOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
bool kanzi::TypedPropertyModifierBindingTargetRuntime< T >::isConnectedOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
bool kanzi::TypedPropertyModifierBindingTargetRuntime< T >::readOverride ( Variant value)
inlineoverrideprotectedvirtual
template<typename T >
bool kanzi::TypedPropertyModifierBindingTargetRuntime< T >::writeOverride ( const Variant value)
inlineoverrideprotectedvirtual
template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::localPropertyChange ( )
inlineoverrideprotectedvirtual
template<typename T >
void kanzi::TypedPropertyModifierBindingTargetRuntime< T >::attachModifier ( )
inlineprotected

Detaches value source.

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

Detaches value source.

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

Updates the modifier.

Parameters
storageStorage being modified.
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

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

Last value written to the variant.

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: