IVCollection
This class provides support for notifications.
IVCollection - Member Functions and Data by Group
Constructors & Destructor
Use these members to construct or destruct objects of the class.
- ~IVCollection
public:
~IVCollection()
- Destructs an IVCollection object.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- IVCollection
protected:
IVCollection()
- Constructs an IVCollection object.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Notification Members
Use these members as notification-enabled variants.
- disableNotification
public:
INotifier& disableNotification()
- Stops the notifier from sending notifications to its observers.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- enableNotification
public:
INotifier& enableNotification(bool = true)
- Starts the notifier sending notifications to its observers. This function can be overridden by derived
classes to perform customized notification that your application might need. For instance, one of your
function methods may require that a database be accessible before processing a retrieve function.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- isEnabledForNotification
public:
bool isEnabledForNotification() const
- Returns true if a notifier can send notifications to its observers.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- notifyObservers
- Notifies all observers in a notifier's list of observers. Each observer receives a notification event containing
the identity of the notifier, the notification ID, and any optional data provided by the specific notifier object.
Overload 1
public:
INotifier& notifyObservers(INotificationEvent const&)
Requires the caller to construct an INotificationEvent to call it.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Overload 2
protected:
INotifier& notifyObservers()
Does not require the caller to construct an INotificationEvent to call it.
The construction of the INotificationEvent occurs in the code of the
function.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Notifier Access
Provides access to the notifier object
- notifier
- Returns a reference to the notifier object.
Overload 1
public:
INotifier const& notifier() const
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Overload 2
public:
INotifier& notifier()
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
Private Members
These members are not accessible.
- addId
public:
static INotificationId const addId
- This member is not accessible.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- modifyId
public:
static INotificationId const modifyId
- This member is not accessible.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- removeId
public:
static INotificationId const removeId
- This member is not accessible.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
- replaceId
public:
static INotificationId const replaceId
- This member is not accessible.
- Supported Platforms
| Windows |
OS/2 |
AIX |
| Yes |
Yes |
Yes |
IVCollection - Inherited Member Functions and Data
Inherited Public Functions
- INotifier
-
virtual ~INotifier()
virtual INotifier& disableNotification() = 0
virtual INotifier&
enableNotification( bool enable = true ) = 0
INotifier()
virtual bool isEnabledForNotification() const = 0
virtual INotifier&
notifyObservers( const INotificationEvent& event ) = 0
virtual INotifier&
notifyObserversAsync( const INotificationEvent& event )
const IThreadId& threadId() const
- IStandardNotifier
-
virtual ~IStandardNotifier()
virtual IStandardNotifier& disableNotification()
virtual IStandardNotifier&
enableNotification( bool enable = true )
virtual bool isEnabledForNotification() const
IStandardNotifier()
IStandardNotifier(const IStandardNotifier& copy)
virtual INotifierAddress notifierAddress() const
virtual IStandardNotifier&
notifyObservers( const INotificationEvent& anEvent )
virtual IStandardNotifier&
notifyObserversAsync( const INotificationEvent& anEvent )
IStandardNotifier&
operator =( const IStandardNotifier& aStandardNotifier )
Inherited Public Data
- INotifier
-
Inherited Protected Functions
- IStandardNotifier
-
- INotifier
-
Inherited Protected Data