kanzi::NodePropertyNotificationHandler Class Reference

Node property notification handler. More...

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

Inheritance diagram for kanzi::NodePropertyNotificationHandler:

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

Protected Member Functions
void	attach ()
	Attach to node.
void	detach ()
	Detach from node.
	NodePropertyNotificationHandler (AbstractPropertyType propertyType, Node *node)
	Constructor.
	NodePropertyNotificationHandler (NodePropertyNotificationHandler &&other) noexcept
	Move constructor.
NodePropertyNotificationHandler &	operator= (NodePropertyNotificationHandler &&other) noexcept
	Move operator.
template<typename T >
void	toggleNotificationHandler (bool add)
	~NodePropertyNotificationHandler () override
	Destructor.
Protected Member Functions inherited from kanzi::AbstractPropertyNotificationHandler
	AbstractPropertyNotificationHandler ()=default
	Default constructor.
	AbstractPropertyNotificationHandler (AbstractPropertyNotificationHandler &&other) noexcept
	Move constructor.
	AbstractPropertyNotificationHandler (AbstractPropertyType propertyType)
	Constructor.
	AbstractPropertyNotificationHandler (const AbstractPropertyNotificationHandler &)=delete
	Deleted copy constructor.
AbstractPropertyNotificationHandler &	operator= (AbstractPropertyNotificationHandler &&other) noexcept
	Move operator.
AbstractPropertyNotificationHandler &	operator= (const AbstractPropertyNotificationHandler &)=delete
	Deleted copy operator.
virtual	~AbstractPropertyNotificationHandler ()
	Destructor.

Static Protected Member Functions
template<typename T >
static void	notificationHandler (PropertyObject &, const typename PropertyType< T >::Traits::StorageType &, PropertyNotificationReason reason, void *data)
	Notification handler function.

Protected Attributes
Node *	m_node
	Node attached to.

Detailed Description

Node property notification handler.

Since

Kanzi 4.0.0 removed copy operations and default constructor.

Constructor & Destructor Documentation

NodePropertyNotificationHandler() [1/2]

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.

NodePropertyNotificationHandler() [2/2]

kanzi::NodePropertyNotificationHandler::NodePropertyNotificationHandler ( NodePropertyNotificationHandler && other )

inlineprotectednoexcept

Move constructor.

Parameters

other

Source object.

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= ( NodePropertyNotificationHandler && other )

inlineprotectednoexcept

Move operator.

Parameters

other

Source object.

Returns

This object.

notificationHandler()

template<typename T >

static void kanzi::NodePropertyNotificationHandler::notificationHandler ( PropertyObject & , const typename PropertyType< T >::Traits::StorageType & , PropertyNotificationReason reason, void * data )

staticprotected

Notification handler function.

toggleNotificationHandler()

template<typename T >

void kanzi::NodePropertyNotificationHandler::toggleNotificationHandler ( bool add )

protected

attach()

void kanzi::NodePropertyNotificationHandler::attach ( )

protected

Attach to node.

detach()

void kanzi::NodePropertyNotificationHandler::detach ( )

protected

Detach from node.

Member Data Documentation

m_node

Node* kanzi::NodePropertyNotificationHandler::m_node

protected

Node attached to.

---

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

• kanzi/core.ui/node/node_property_notification_handler.hpp