Kanzi  3.9.8
Kanzi Engine C++ API
kanzi::NodePropertyNotificationHandler Class Reference

Node property notification handler. More...

#include <kanzi/core.ui/node/node_property_notification_handler.hpp>

Inheritance diagram for kanzi::NodePropertyNotificationHandler:
[legend]

Public Member Functions

Node * getNode () const
 Access the node. More...
 
void invalidate ()
 Invalidates the state of the notification handler. More...
 
bool isValid () const
 Tell if this notification handler is valid. More...
 
- Public Member Functions inherited from kanzi::AbstractPropertyNotificationHandler
AbstractPropertyType getPropertyType () const
 Get the property type this handler is listening. More...
 
virtual void onPropertyChanged (PropertyNotificationReason reason)=0
 Method to be executed when property is changed. More...
 

Protected Member Functions

 NodePropertyNotificationHandler ()
 Empty constructor. More...
 
 NodePropertyNotificationHandler (const NodePropertyNotificationHandler &rhs)
 Copy constructor. More...
 
 NodePropertyNotificationHandler (AbstractPropertyType propertyType, Node *node)
 Constructor. More...
 
NodePropertyNotificationHandler & operator= (const NodePropertyNotificationHandler &rhs)
 Assignment operator. More...
 
 ~NodePropertyNotificationHandler () override
 Destructor. More...
 
- Protected Member Functions inherited from kanzi::AbstractPropertyNotificationHandler
 AbstractPropertyNotificationHandler ()
 Empty constructor. More...
 
 AbstractPropertyNotificationHandler (AbstractPropertyType propertyType)
 Constructor. More...
 
virtual ~AbstractPropertyNotificationHandler ()
 

Detailed Description

Node property notification handler.

Constructor & Destructor Documentation

◆ NodePropertyNotificationHandler() [1/3]

kanzi::NodePropertyNotificationHandler::NodePropertyNotificationHandler ( )
inlineexplicitprotected

Empty constructor.

◆ NodePropertyNotificationHandler() [2/3]

kanzi::NodePropertyNotificationHandler::NodePropertyNotificationHandler ( const NodePropertyNotificationHandler &  rhs)
explicitprotected

Copy constructor.

Parameters
rhsHandler to copy from.

◆ NodePropertyNotificationHandler() [3/3]

kanzi::NodePropertyNotificationHandler::NodePropertyNotificationHandler ( AbstractPropertyType  propertyType,
Node *  node 
)
explicitprotected

Constructor.

Implicitly attaches to the node it's constructed on.

◆ ~NodePropertyNotificationHandler()

kanzi::NodePropertyNotificationHandler::~NodePropertyNotificationHandler ( )
overrideprotected

Destructor.

Implicitly detaches from the node it was constructed on.

Member Function Documentation

◆ getNode()

Node* kanzi::NodePropertyNotificationHandler::getNode ( ) const
inline

Access the node.

Returns
Pointer to node.

◆ invalidate()

void kanzi::NodePropertyNotificationHandler::invalidate ( )
inline

Invalidates the state of the notification handler.

Use this function to invalidate a node that you destroyed before destroying the NodePropertyNotificationHandler.

◆ isValid()

bool kanzi::NodePropertyNotificationHandler::isValid ( ) const
inline

Tell if this notification handler is valid.

Returns
True if yes, false if no.

◆ operator=()

NodePropertyNotificationHandler& kanzi::NodePropertyNotificationHandler::operator= ( const NodePropertyNotificationHandler &  rhs)
protected

Assignment operator.

Parameters
rhsHandler to copy from.
Returns
Reference to assignee.

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