IlvManagerAccelerator Class Reference

Manager class. More...

#include <ilviews/manager/event.h>

Inheritance diagram for IlvManagerAccelerator:

Public Member Functions
	IlvManagerAccelerator (IlvManagerAcceleratorAction mgrAction, IlvEventType eventType, IlUShort eventData=0, IlUShort modifiers=0, IlAny userArg=0, IlUShort optModifiers=0)
	Constructor. More...
IlvManagerAcceleratorAction	action () const
	Returns the accelerator action. More...
virtual void	activate (IlvManager *manager, IlvView *view, IlvEvent &event)
	Calls the accelerator action. More...
void	setAction (IlvManagerAcceleratorAction mgrAction, IlAny userArg)
	Sets the accelerator action. More...

Detailed Description

Manager class.

Library: ilvmgr

This subclass of IlvAccelerator is defined for use of accelerators in an IlvManager. It defines a function type for the accelerator action and provides storage for this action. Generally, applications do not need to use this class. Instead, they use IlvManager::addAccelerator, IlvManager::getAccelerator, and IlvManager::removeAccelerator.

See also

IlvManager (Managing Accelerators Member Functions).

Constructor & Destructor Documentation

IlvManagerAccelerator::IlvManagerAccelerator	(	IlvManagerAcceleratorAction	mgrAction,
		IlvEventType	eventType,
		IlUShort	eventData = 0,
		IlUShort	modifiers = 0,
		IlAny	userArg = 0,
		IlUShort	optModifiers = 0
	)

Constructor.

Calls the constructor of the superclass with the event description and sets the accelerator action with its user argument.

Parameters

mgrAction	The accelerator action.
eventType	Specifies the type of event that triggers the action.
eventData	Specifies the event data.
modifiers	The mandatory event modifiers.
userArg	The user argument for the accelerator action.
optModifiers	The optional event modifiers.

Member Function Documentation

IlvManagerAcceleratorAction IlvManagerAccelerator::action

(

)

const

Returns the accelerator action.

Returns

The action associated with the accelerator.

virtual void IlvManagerAccelerator::activate ( IlvManager *  manager, IlvView *  view, IlvEvent &  event  )

virtual

Calls the accelerator action.

Virtual member function called when a view associated with a manager has received an event fulfilling the conditions required to trigger the accelerator. (See method IlvAccelerator::trigger.) The default implementation is to call the action (if any) associated with the accelerator:

action()(manager, view, event, userArg());

Parameters

manager	The manager.
view	The manager view.
event	The event.

void IlvManagerAccelerator::setAction	(	IlvManagerAcceleratorAction	mgrAction,
		IlAny	userArg
	)

Sets the accelerator action.

Sets both the accelerator action and the user argument.

Parameters

mgrAction	The accelerator action.
userArg	The user argument for the accelerator action.