IlvManagerMessage Class Reference

Manager message class. More...

#include <ilviews/manager/observer.h>

Inheritance diagram for IlvManagerMessage:

Public Member Functions
	IlvManagerMessage (IlUInt reason, IlUInt mask, IlAny data=0)
	Constructor. More...

Public Attributes
IlAny	_data
	Additional message information. More...
IlUInt	_mask
	Message mask (or message category). More...
IlUInt	_reason
	Message type. More...

Detailed Description

Manager message class.

Library: ilvmgr

This class provides information and data used in the notification mechanism in the IlvManager class. When a notification needs to be made, the manager creates an instance of an IlvManagerMessage subclass and calls IlvManagerObservable::notify, which propagates the notification to the list of observers attached to the manager. The propagation is done by calling IlvManagerObserver::update with the manager message as argument. The message contains the notification category and type. The category is also called message mask and the notification type is also called reason. The manager message also contains an anonymous data field that points to additional information. This field has a different use and logic depending on the type of notification.
For instance, in a call to IlvManager::addView, the manager creates an IlvManagerAddViewMessage as follows

• reason: IlvMgrMsgAddView
• mask: IlvMgrMsgViewMask
• data: pointer to the view being added.

See also

IlvManagerObservable, IlvManagerObserver.

Constructor & Destructor Documentation

IlvManagerMessage()

IlvManagerMessage::IlvManagerMessage	(	IlUInt	reason,
		IlUInt	mask,
		IlAny	data = 0
	)

Constructor.

Parameters

reason	The notification type.
mask	The notification category.
data	Additional data. The use of this field depends on the notification type.

Member Data Documentation

_data

IlAny IlvManagerMessage::_data

Additional message information.

This field is meant for subclasses to store any specific information needed for the given type of notification message.

_mask

IlUInt IlvManagerMessage::_mask

Message mask (or message category).

Contains a bitmask value identifying the message category. Each message type value can only belong to one message category.

_reason

IlUInt IlvManagerMessage::_reason

Message type.

Contains a value identifying the type of notification.