PureMVC::IController Class Reference

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

#include <pmvcpp.h>

Inheritance diagram for PureMVC::IController:

Collaboration diagram for PureMVC::IController:

Public Member Functions
virtual void	removeCommand (int notificationName)=0
	Register a particular `ICommand` class as the handler for a particular `INotification`.
virtual bool	hasCommand (int notificationName)=0
	Check if a Command is registered for a given Notification.
virtual void	setMultitonKey (std::string key)=0
	Set multiton key.
virtual std::string	getMultitonKey ()=0
	Get multiton key.

Detailed Description

The interface definition for a PureMVC Controller.

In PureMVC, an IController implementor follows the 'Command and Controller' strategy, and assumes these responsibilities:

Remembering which ICommands are intended to handle which INotifications.
Registering itself as an IObserver with the View for each INotification that it has an ICommand mapping for.
Creating a new instance of the proper ICommand to handle a given INotification when notified by the View.
Calling the ICommand's execute method, passing in the INotification.

virtual std::string PureMVC::IMultitonKeyHeir::getMultitonKey ( ) [pure virtual, inherited]

Get multiton key.

Returns the multiton key.

virtual bool PureMVC::IController::hasCommand ( int notificationName ) [pure virtual]

Check if a Command is registered for a given Notification.

Parameters:

notificationName

Returns:: whether a Command is currently registered for the given notificationName.

virtual void PureMVC::IController::removeCommand ( int notificationName ) [pure virtual]

Register a particular ICommand class as the handler for a particular INotification.

Parameters:

	notificationName	the name of the `INotification`
	commandClassRef	the Class of the `ICommand` Execute the `ICommand` previously registered as the handler for `INotification`s with the given notification name.
	notification	the `INotification` to execute the associated `ICommand` for Remove a previously registered `ICommand` to `INotification` mapping.
	notificationName	the name of the `INotification` to remove the `ICommand` mapping for

virtual void PureMVC::IMultitonKeyHeir::setMultitonKey ( std::string key ) [pure virtual, inherited]

Set multiton key.

Sets the multiton key.

Parameters:

key

The name of the key

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