Kanzi  3.9.6
Kanzi Engine API
kanzi::ToSourceBindingRuntime Class Reference

Runtime for ToSourceBinding. More...

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

Inheritance diagram for kanzi::ToSourceBindingRuntime:
[legend]

Public Member Functions

BindingSourceRuntimegetPushSourceRuntime () const
 Gets the runtime for the push source. More...
 
- Public Member Functions inherited from kanzi::AbstractBindingRuntime
void attach ()
 Attach the binding. More...
 
void detach ()
 Detaches the binding. More...
 
void detachIfAttachedOrAttaching ()
 Detaches the binding if it is attaching or attached. More...
 
AbstractBindingSharedPtr getBinding () const
 Returns the binding associated with this binding runtime. More...
 
shared_ptr< void > getOwner () const
 Gets the owner. More...
 
BindingSourceRuntimegetSourceRuntime () const
 Gets the source runtime. More...
 
BindingTargetRuntimegetTargetRuntime () const
 Gets the target runtime. More...
 
bool isAttached () const
 Indicates whether this binding runtime has been attached. More...
 
bool isAttaching () const
 Indicates whether this binding runtime is being attached. More...
 
bool isConnected ()
 Indicates whether this binding runtime is connected. More...
 
bool isDetached () const
 Indicates whether this binding runtime is detached. More...
 
bool isDetaching () const
 Indicates whether this binding runtime is being detached. More...
 
bool isRemoved () const
 Gets whether the binding runtime has been removed from the binding host. More...
 
void notifySourceChanged ()
 Called when binding source has changed. More...
 
void notifyTargetChanged ()
 Called when binding target has changed. More...
 
void onRemoved ()
 Called when binding is being removed from where it has been installed. More...
 
void removeFromHost ()
 Removes the binding runtime from the binding host. More...
 
void setHost (BindingHostConceptSharedPtr hostObject)
 Sets the binding host object in which the binding runtime is hosted. More...
 
void setOwner (shared_ptr< void > owner)
 Set the owner. More...
 
bool update ()
 Execute the binding. More...
 
virtual ~AbstractBindingRuntime ()
 Destructor. More...
 

Static Public Member Functions

static ToSourceBindingRuntimeSharedPtr create (ToSourceBindingSharedPtr toSourceBinding, BindingSourceRuntimePtr sourceRuntime, BindingSourceRuntimePtr pushSourceRuntime, BindingTargetRuntimePtr targetRuntime)
 Creates a To Source binding runtime. More...
 

Protected Member Functions

void attachOverride () override
 AbstractBindingRuntime::attachOverride() implementation. More...
 
void detachOverride () override
 AbstractBindingRuntime::detahOverride() implementation. More...
 
bool isConnectedOverride () override
 AbstractBindingRuntime::isConnectedOverride() implementation. More...
 
void notifySourceChangedOverride () override
 AbstractBindingRuntime::notifySourceChangedOverride() implementation. More...
 
void notifyTargetChangedOverride () override
 AbstractBindingRuntime::notifyTargetChangedOverride() implementation. More...
 
 ToSourceBindingRuntime (ToSourceBindingSharedPtr toSourceBinding, BindingSourceRuntimePtr sourceRuntime, BindingSourceRuntimePtr pushSourceRuntime, BindingTargetRuntimePtr targetRuntime)
 Constructor. More...
 
bool updateOverride () override
 AbstractBindingRuntime::updateOverride() implementation. More...
 
bool writeToSource (const Variant &value) const
 Writes to push source. More...
 
- Protected Member Functions inherited from kanzi::BindingBaseRuntime
 BindingBaseRuntime (AbstractBindingSharedPtr binding, BindingSourceRuntimePtr sourceRuntime, BindingTargetRuntimePtr targetRuntime)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractBindingRuntime
 AbstractBindingRuntime (AbstractBindingSharedPtr binding, BindingSourceRuntimePtr sourceRuntime, BindingTargetRuntimePtr targetRuntime)
 Constructor. More...
 
bool readFromSource (Variant &value)
 Read from source and execute forward validators. More...
 
bool readFromTarget (Variant &value)
 Reads from target and executes reverse validators. More...
 
bool writeToSource (const Variant &value) const
 Writes to source. More...
 
bool writeToTarget (const Variant &value)
 Write to target. More...
 

Protected Attributes

BindingSourceRuntimePtr m_pushSourceRuntime
 Runtime for push source. More...
 
- Protected Attributes inherited from kanzi::BindingBaseRuntime
bool m_updateInProgress
 Flag for update being in progress. More...
 
- Protected Attributes inherited from kanzi::AbstractBindingRuntime
AttachmentState m_attachmentState
 Current binding runtime state. More...
 
AbstractBindingSharedPtr m_binding
 Associated binding. More...
 
BindingHostConceptWeakPtr m_bindingHost
 The binding host object in which the binding runtime is hosted. More...
 
weak_ptr< void > m_owner
 Owner for tagging the runtime. More...
 
BindingSourceRuntimePtr m_sourceRuntime
 Runtime for source. More...
 
BindingTargetRuntimePtr m_targetRuntime
 Runtime for target. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::AbstractBindingRuntime
enum  AttachmentState {
  Detached, Detaching, Attaching, Attached,
  Removed
}
 Attachment state for keeping track current status. More...
 

Detailed Description

Runtime for ToSourceBinding.

See also
AbstractBinding
Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ ToSourceBindingRuntime()

kanzi::ToSourceBindingRuntime::ToSourceBindingRuntime ( ToSourceBindingSharedPtr  toSourceBinding,
BindingSourceRuntimePtr  sourceRuntime,
BindingSourceRuntimePtr  pushSourceRuntime,
BindingTargetRuntimePtr  targetRuntime 
)
explicitprotected

Constructor.

Parameters
toSourceBindingThe To Source binding that created this runtime.
sourceRuntimeRuntime created for binding source.
pushSourceRuntimeRuntime for push source.
targetRuntimeRuntime created for binding target.

Member Function Documentation

◆ create()

static ToSourceBindingRuntimeSharedPtr kanzi::ToSourceBindingRuntime::create ( ToSourceBindingSharedPtr  toSourceBinding,
BindingSourceRuntimePtr  sourceRuntime,
BindingSourceRuntimePtr  pushSourceRuntime,
BindingTargetRuntimePtr  targetRuntime 
)
static

Creates a To Source binding runtime.

Parameters
toSourceBindingHost binding.
sourceRuntimeBinding source runtime.
pushSourceRuntimeRuntime for push source.
targetRuntimeBinding target runtime.
Returns
The created runtime for a To Source binding.

◆ getPushSourceRuntime()

BindingSourceRuntime* kanzi::ToSourceBindingRuntime::getPushSourceRuntime ( ) const
inline

Gets the runtime for the push source.

Returns
Pointer to push source runtime.

◆ writeToSource()

bool kanzi::ToSourceBindingRuntime::writeToSource ( const Variant value) const
protected

Writes to push source.

Parameters
valueThe value to write.
Returns
If the write succeeds, true, otherwise false.

◆ attachOverride()

void kanzi::ToSourceBindingRuntime::attachOverride ( )
overrideprotectedvirtual

◆ detachOverride()

void kanzi::ToSourceBindingRuntime::detachOverride ( )
overrideprotectedvirtual

AbstractBindingRuntime::detahOverride() implementation.

Reimplemented from kanzi::BindingBaseRuntime.

◆ updateOverride()

bool kanzi::ToSourceBindingRuntime::updateOverride ( )
overrideprotectedvirtual

◆ notifySourceChangedOverride()

void kanzi::ToSourceBindingRuntime::notifySourceChangedOverride ( )
overrideprotectedvirtual

◆ notifyTargetChangedOverride()

void kanzi::ToSourceBindingRuntime::notifyTargetChangedOverride ( )
overrideprotectedvirtual

◆ isConnectedOverride()

bool kanzi::ToSourceBindingRuntime::isConnectedOverride ( )
overrideprotectedvirtual

Member Data Documentation

◆ m_pushSourceRuntime

BindingSourceRuntimePtr kanzi::ToSourceBindingRuntime::m_pushSourceRuntime
protected

Runtime for push source.


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