Kanzi  3.9.6
Kanzi Engine API
kanzi::PropertyObserver Class Reference

Helper class for observing certain property in nodes. More...

#include <kanzi/ui/node/concept/activity/property_observer.hpp>

Public Member Functions

 PropertyObserver (AbstractPropertyType propertyType)
 Constructor. More...
 
void removeAllBindings ()
 Removes all bindings for the observed nodes. More...
 
void startObserving (NodeSharedPtr hostNode, NodeSharedPtr observedNode, CallbackBindingProcessorSharedPtr callbackBindingProcessor)
 Creates a binding for a property type in observed node with the given callbackBindingProcessor. More...
 
void stopObserving (NodeSharedPtr observedNode)
 Removes from the observedNode the binding to the observed property type. More...
 
virtual ~PropertyObserver ()=default
 Destructor. More...
 

Detailed Description

Helper class for observing certain property in nodes.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ PropertyObserver()

kanzi::PropertyObserver::PropertyObserver ( AbstractPropertyType  propertyType)
explicit

Constructor.

Parameters
propertyTypeThe property type that Kanzi observes in nodes.

◆ ~PropertyObserver()

virtual kanzi::PropertyObserver::~PropertyObserver ( )
virtualdefault

Destructor.

Member Function Documentation

◆ startObserving()

void kanzi::PropertyObserver::startObserving ( NodeSharedPtr  hostNode,
NodeSharedPtr  observedNode,
CallbackBindingProcessorSharedPtr  callbackBindingProcessor 
)

Creates a binding for a property type in observed node with the given callbackBindingProcessor.

Parameters
hostNodeNode that owns the property type.
observedNodeNode where Kanzi observes the property type.
callbackBindingProcessorA callback when the value of the observed property type changes.

◆ stopObserving()

void kanzi::PropertyObserver::stopObserving ( NodeSharedPtr  observedNode)

Removes from the observedNode the binding to the observed property type.

Parameters
observedNodeNode where Kanzi observes the property type.

◆ removeAllBindings()

void kanzi::PropertyObserver::removeAllBindings ( )

Removes all bindings for the observed nodes.


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