PureMVC::IMediatorTemplated< T > Class Template Reference

The templated portion of IMediator. More...

#include <pmvcpp.h>

Inheritance diagram for PureMVC::IMediatorTemplated< T >:

[legend]

Collaboration diagram for PureMVC::IMediatorTemplated< T >:

[legend]

List of all members.

Public Member Functions
virtual T	getViewComponent ()=0
	Get the IMediator's view component.
virtual void	setViewComponent (T viewComponent)=0
	Set the IMediator's view component.
virtual std::string	getMediatorName ()=0
	Get the IMediator instance name.
virtual std::vector< int >	listNotificationInterests ()=0
	List INotification interests.
virtual void	onRegister ()=0
	Called by the View when the Mediator is registered.
virtual void	onRemove ()=0
	Called by the View when the Mediator is removed.
virtual void	sendNotification (int notificationName, Object *body, int notificationType)=0
	Send a INotification.
virtual void	sendNotification (int notificationName, int notificationType)=0
virtual void	sendNotification (int notificationName, Object *body)=0
virtual void	sendNotification (int notificationName)=0
virtual void	initializeNotifier (std::string key)=0
	Initialize this INotifier instance.
virtual void	handleNotification (INotification *notification)=0
	Handle an INotification.

---

Detailed Description

template<class T>
class PureMVC::IMediatorTemplated< T >

The templated portion of IMediator.

IMediatorTemplated inherits from IMediatorRestricted and adds some required template functions.

---

Member Function Documentation

virtual std::string PureMVC::IMediatorRestricted::getMediatorName

(

)

[pure virtual, inherited]

Get the IMediator instance name.

Returns:

the IMediator instance name

Implemented in PureMVC::Mediator< T >.

template<class T >

virtual T PureMVC::IMediatorTemplated< T >::getViewComponent

(

)

[pure virtual]

Get the IMediator's view component.

Returns:

Object the view component

Implemented in PureMVC::Mediator< T >.

virtual void PureMVC::INotificationHandler::handleNotification

(

INotification *

notification

)

[pure virtual, inherited]

Handle an INotification.

Parameters:

notification

the INotification to be handled

Implemented in PureMVC::Mediator< T >.

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 std::vector<int> PureMVC::IMediatorRestricted::listNotificationInterests

(

)

[pure virtual, inherited]

List INotification interests.

Returns:

an Array of the INotification names this IMediator has an interest in.

Implemented in PureMVC::Mediator< T >.

virtual void PureMVC::IMediatorRestricted::onRegister

(

)

[pure virtual, inherited]

Called by the View when the Mediator is registered.

Implemented in PureMVC::Mediator< T >.

virtual void PureMVC::IMediatorRestricted::onRemove

(

)

[pure virtual, inherited]

Called by the View when the Mediator is removed.

Implemented in PureMVC::Mediator< T >.

virtual void PureMVC::INotifier::sendNotification	(	int	notificationName,
		Object *	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.

template<class T >

virtual void PureMVC::IMediatorTemplated< T >::setViewComponent

(

T

viewComponent

)

[pure virtual]

Set the IMediator's view component.

Parameters:

Object

the view component

Implemented in PureMVC::Mediator< T >.

---

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

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