IlvToggleInteractor Class Reference

Interactor to add toggle behavior to graphic objects. More...

#include <ilviews/graphics/inter.h>

Inheritance diagram for IlvToggleInteractor:

List of all members.

Public Member Functions
	IlvToggleInteractor (IlUShort button=((IlUShort) 0x0001), IlvApplyObject action=0, IlAny userarg=0)
	Constructor.
virtual IlBoolean	handleEvent (IlvGraphic *obj, IlvEvent &event, const IlvTransformer *t)
	Handles events received by the interactor.

---

Detailed Description

Interactor to add toggle behavior to graphic objects.

Library: views

Use this class to give an object the behavior of a toggle button. The object with which this interactor is associated is inverted when the user presses and then releases the mouse button over it. This is done by calling the object member function IlvGraphic::invert.

The registered name of this interactor is "Toggle".

See also:

IlvToggle.

---

Constructor & Destructor Documentation

IlvToggleInteractor::IlvToggleInteractor	(	IlUShort	button = ((IlUShort) 0x0001),
		IlvApplyObject	action = 0,
		IlAny	userarg = 0
	)

Constructor.

Initializes a new instance of the IlvToggleInteractor class and sets the function to be called when the object is clicked.

Parameters:

	button	The mouse button that is used for the interaction.
	action	The user function to be called on a click.
	arg	The user argument.

---

Member Function Documentation

virtual IlBoolean IlvToggleInteractor::handleEvent	(	IlvGraphic *	g,
		IlvEvent &	event,
		const IlvTransformer *	t
	)			[virtual]

Handles events received by the interactor.

This method is the entry point of all events dispatched to this interactor.

Parameters:

	g	The graphic object that receives the event.
	event	The received event.
	t	The transformer applied to the view in which the event occurred.

Returns:

IlTrue if the event was successfully handled and IlFalse otherwise.

Reimplemented from IlvButtonInteractor.