IlvManagerEventHook Class Reference

Manager hook class. More...

#include <ilviews/manager/event.h>

List of all members.

Public Member Functions
	IlvManagerEventHook ()
	Constructor.
virtual	~IlvManagerEventHook ()
	Destructor.
IlvManager *	getManager () const
	Returns the manager.
virtual IlBoolean	handleEvent (IlvEvent &event, IlvView *view)=0
	Processes an event.
virtual void	setManager (IlvManager *manager)
	Sets the manager.
Friends
class	IlvManager

---

Detailed Description

Manager hook class.

Library: ilvmgr

This class is used to monitor events that occur within views associated with a manager. Instances of this class are called event hooks. They are used to notify the user of any event that occurs within a manager view, before the event is sent to view interactors, object interactors, or accelerators.

Event hooks are installed on managers using IlvManager::installEventHook and removed using IlvManager::removeEventHook.

Deleting a manager will delete the event hooks installed on it.

See also:

IlvManager.

---

Constructor & Destructor Documentation

IlvManagerEventHook::IlvManagerEventHook

(

)

Constructor.

Initializes a new event hook, ready to be installed on any manager.

virtual IlvManagerEventHook::~IlvManagerEventHook

(

)

[virtual]

Destructor.

Releases the memory used by the instance.

---

Member Function Documentation

IlvManager* IlvManagerEventHook::getManager

(

)

const

Returns the manager.

Returns:

The manager to which the hook is connected.

virtual IlBoolean IlvManagerEventHook::handleEvent	(	IlvEvent &	event,
		IlvView *	view
	)			[pure virtual]

Processes an event.

Called by the manager where this hook is installed when an event occurs in a view connected to this manager.

Returns:

IlTrue when the event is considered completely consumed; no other event hook will be considered, and the manager will not trigger any interactor or accelerator. Otherwise, the method returns IlFalse; the other event hooks will be called and further event management will be performed by the manager.

Parameters:

	event	The event.
	view	The manager view in which the event occurred.

virtual void IlvManagerEventHook::setManager

(

IlvManager *

manager

)

[virtual]

Sets the manager.

Connects the hook to a manager. This is equivalent to calling IlvManager::removeEventHook on the manager where this hook was installed, followed by IlvManager::installEventHook on manager.

Parameters:

manager

The manager to connect the hook to.