PureMVC::ICommand Class Reference

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

#include <pmvcpp.h>

Inheritance diagram for PureMVC::ICommand:

[legend]

Collaboration diagram for PureMVC::ICommand:

[legend]

List of all members.

Public Member Functions
virtual void	execute (INotification *notification)=0
	Execute the ICommand's logic to handle a given INotification.
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 Command.

See also:

INotification

---

Member Function Documentation

virtual void PureMVC::ICommand::execute

(

INotification *

notification

)

[pure virtual]

Execute the ICommand's logic to handle a given INotification.

Parameters:

note

an INotification to handle.

Implemented in PureMVC::SimpleCommand, and PureMVC::MacroCommand.

virtual void PureMVC::INotifier::initializeNotifier

(

std::string

key

)

[pure virtual, inherited]

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, inherited]

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, inherited]

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, inherited]

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, inherited]

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