PureMVC::INotifier Class Reference

The interface definition for a PureMVC Notifier. More...

#include <pmvcpp.h>

Inheritance diagram for PureMVC::INotifier:

[legend]

List of all members.

Public Member Functions
virtual void	sendNotification (int notificationName, void *body, int notificationType)=0
	Send a INotification.
virtual void	sendNotification (int notificationName, int notificationType)=0
	Send a INotification.
virtual void	sendNotification (int notificationName, void *body)=0
	Send a INotification.
virtual void	sendNotification (int notificationName)=0
	Send a INotification.
virtual void	initializeNotifier (std::string key)=0
	Initialize this INotifier instance.

---

Detailed Description

The interface definition for a PureMVC Notifier.

MacroCommand, Command, Mediator and Proxy all have a need to send Notifications.

The INotifier interface provides a common method called sendNotification that relieves implementation code of the necessity to actually construct Notifications.

The Notifier class, which all of the above mentioned classes extend, also provides an initialized reference to the Facade Singleton, which is required for the convienience method for sending Notifications, but also eases implementation as these classes have frequent Facade interactions and usually require access to the facade anyway.

See also:

IFacade IFacade

INotification

---

Member Function Documentation

virtual void PureMVC::INotifier::initializeNotifier

(

std::string

key

)

[pure virtual]

Initialize this INotifier instance.

This is how a Notifier gets its multitonKey. Calls to sendNotification or to access the facade will fail until after this method has been called.

Parameters:

key

the multitonKey for this INotifier to use

Implemented in PureMVC::Notifier, and PureMVC::Facade.

virtual void PureMVC::INotifier::sendNotification

(

int

notificationName

)

[pure virtual]

Send a INotification.

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

notificationName

the name of the notification to send

Implemented in PureMVC::Notifier, and PureMVC::Facade.

virtual void PureMVC::INotifier::sendNotification	(	int	notificationName,
		void *	body
	)			[pure virtual]

Send a INotification.

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

	notificationName	the name of the notification to send
	body	the body of the notification (optional)

Implemented in PureMVC::Notifier, and PureMVC::Facade.

virtual void PureMVC::INotifier::sendNotification	(	int	notificationName,
		int	notificationType
	)			[pure virtual]

Send a INotification.

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

	notificationName	the name of the notification to send
	type	the type of the notification (optional)

Implemented in PureMVC::Notifier, and PureMVC::Facade.

virtual void PureMVC::INotifier::sendNotification	(	int	notificationName,
		void *	body,
		int	notificationType
	)			[pure virtual]

Send a INotification.

Convenience method to prevent having to construct new notification instances in our implementation code.

Parameters:

	notificationName	the name of the notification to send
	body	the body of the notification (optional)
	type	the type of the notification (optional)

Implemented in PureMVC::Notifier, and PureMVC::Facade.

---

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

• /Users/schell/Code/PureMVC-Plus-Plus/src/pmvcpp.h