rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Manager Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvManagerObservable Class Reference

Observable class dedicated to the IlvManager. More...

#include <ilviews/manager/observer.h>

Inheritance diagram for IlvManagerObservable:
IlvObservable IlvSmartData

Public Member Functions

void disable (IlUInt mask)
 Disables additional message categories for notification. More...
 
void enable (IlUInt mask)
 Enables message categories for notification. More...
 
IlUInt getDisabledMask () const
 Returns the message categories that are disabled. More...
 
IlvManagergetManager () const
 Returns the manager. More...
 
IlBoolean mustNotify (IlUInt mask)
 Indicates if the observable can propagate a given message category. More...
 
void notify (IlvManagerMessage &msg)
 Notifies all the observers. More...
 
void setDisabledMask (IlUInt mask)
 Resets the combination of disabled message categories. More...
 

Detailed Description

Observable class dedicated to the IlvManager.

Library: ilvmgr

IlvManagerObservable is used by the IlvManager class to propagate notifications to manager observers.
For the notification, the manager provides an instance of IlvManagerMessage containing the information needed by observers to identify the notification and react to it. The notification is done by the member function IlvManagerObservable::notify which calls IlvManagerObserver::update with the manager message as parameter.
The propagation of certain manager messages can be temporarily disabled to avoid unnecessary notifications. This is done by setting a bitwise OR combination of message categories called the disabled mask.

See Also
IlvManager, IlvManagerObserver, IlvManagerMessage.

Member Function Documentation

void IlvManagerObservable::disable ( IlUInt  mask)

Disables additional message categories for notification.

Adds the specified message categories to the existing disabled mask.

Parameters
maskBitwise OR combination of message categories to disable.
void IlvManagerObservable::enable ( IlUInt  mask)

Enables message categories for notification.

Removes the specified message categories to the existing disabled mask.

Parameters
maskBitwise OR combination of message categories to add.
IlUInt IlvManagerObservable::getDisabledMask ( ) const

Returns the message categories that are disabled.

Returns
The bitwise OR combination representing the message categories that are currently disabled for notification.
IlvManager* IlvManagerObservable::getManager ( ) const

Returns the manager.

Returns
The manager associated with the observable.
IlBoolean IlvManagerObservable::mustNotify ( IlUInt  mask)

Indicates if the observable can propagate a given message category.

Returns
IlFalse if the given message category is disabled or if no observer has requested this category for notification. Otherwise, the function returns IlTrue.
Parameters
maskSpecifies the message category. Must not be an OR combination but a single category.
void IlvManagerObservable::notify ( IlvManagerMessage msg)

Notifies all the observers.

Propagates a notification to all the observers attached to the observable.

Parameters
msgManager message containing the information on the notification. msg is passed as argument to IlvManagerObserver::update.
void IlvManagerObservable::setDisabledMask ( IlUInt  mask)

Resets the combination of disabled message categories.

Parameters
maskBitwise OR combination representing the message categories that are disabled for notification.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.