Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::BindingHostConcept Class Reference

BindingHostConcept specifies an interface for adding and removing bindings to the binding host. More...

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

Inheritance diagram for kanzi::BindingHostConcept:
[legend]

Public Types

using BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
 Binding host concept shared pointer type. More...
 
using BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
 Const iterator for binding runtimes. More...
 
using BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
 Container for binding runtimes. More...
 
using BindingRuntimeIterator = BindingRuntimeContainer::iterator
 Iterator for binding runtimes. More...
 

Public Member Functions

BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes. More...
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes. More...
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index. More...
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node. More...
 
void removeAllBindings ()
 Removes all binding runtimes. More...
 
void removeBinding (BindingRuntimeHandle &bindingRuntime)
 Removes a binding runtime added earlier. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner. More...
 

Protected Member Functions

void attachBindings ()
 Attach all bindings stored in this object. More...
 
void detachBindings ()
 Detach bindings. More...
 

Protected Attributes

BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object. More...
 

Detailed Description

BindingHostConcept specifies an interface for adding and removing bindings to the binding host.

Besides providing the interface, BindingHostConcept contains the binding runtimes.

Since
Kanzi.3.7.0

Member Typedef Documentation

using kanzi::BindingHostConcept::BindingRuntimeIterator = BindingRuntimeContainer::iterator

Iterator for binding runtimes.

using kanzi::BindingHostConcept::BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator

Const iterator for binding runtimes.

Binding host concept shared pointer type.

Member Function Documentation

void kanzi::BindingHostConcept::removeBinding ( BindingRuntimeHandle bindingRuntime)

Removes a binding runtime added earlier.

Parameters
bindingRuntimeBinding runtime to remove.
Since
Kanzi 3.9.7 changed AbstractBindingRuntime to BindingRuntimeHandle.
void kanzi::BindingHostConcept::removeBindingsWithOwner ( shared_ptr< void >  owner)

Removes all binding runtimes with the specified owner.

Parameters
ownerOwner of the binding runtime.
void kanzi::BindingHostConcept::removeAllBindings ( )

Removes all binding runtimes.

BindingRuntimeConstIterator kanzi::BindingHostConcept::beginBindingRuntimes ( ) const

Returns an iterator to the beginning of binding runtimes.

Returns
Const iterator to the beginning of binding runtimes.
BindingRuntimeConstIterator kanzi::BindingHostConcept::endBindingRuntimes ( ) const

Returns an iterator to the end of binding runtimes.

Returns
Const iterator to the end of binding runtimes.
AbstractBindingRuntimeSharedPtr kanzi::BindingHostConcept::getBindingRuntime ( size_t  idx)

Gets binding by index.

Parameters
idxIndex of binding to retrieve.
Returns
Binding runtime at index.
size_t kanzi::BindingHostConcept::getBindingRuntimeCount ( ) const

Gets the number of binding runtimes added to this node.

Returns
Number of bindings currently in the binding host.
void kanzi::BindingHostConcept::attachBindings ( )
protected

Attach all bindings stored in this object.

void kanzi::BindingHostConcept::detachBindings ( )
protected

Detach bindings.

Member Data Documentation

BindingRuntimeContainer kanzi::BindingHostConcept::m_bindingRuntimes
protected

Bindings in this object.


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