IlvGadgetInteractor Class Reference

The base class for gadget interactors. More...

#include <ilviews/base/gadget.h>

Inheritance diagram for IlvGadgetInteractor:

List of all members.

Public Member Functions
virtual IlBoolean	accept (const IlvGraphic *) const
	Indicates whether the current interactor can be associated with a given object.
virtual void	getCallbackTypes (IlUInt &count, const char *const **names, const IlSymbol *const **types) const
	Gets the number of register callback types for the interactor.
virtual IlBoolean	handleEvent (IlvGraphic *, IlvEvent &, const IlvTransformer *)
	Handles events received by the interactor.

---

Detailed Description

The base class for gadget interactors.

Library: views

The IlvGadgetInteractor class is the base class for gadget interactors. It forwards the events received by the interactor to the gadget it is connected to by calling its IlvGadget::handleEvent method. This interactor is automatically set on a gadget when it's added to a container or a manager.

See also:

IlvGadget

---

Member Function Documentation

virtual IlBoolean IlvGadgetInteractor::accept

(

const IlvGraphic *

obj

)

const [virtual]

Indicates whether the current interactor can be associated with a given object.

Parameters:

obj

The considered graphic object.

Returns:

xxIlTrue if the interactor can safely be attached to obj, and xxIlFalse otherwise.

See also:

IlvGraphic::setInteractor

Reimplemented from IlvInteractor.

virtual void IlvGadgetInteractor::getCallbackTypes	(	IlUInt &	count,
		const char *const **	names,
		const IlSymbol *const **	types
	)			const [virtual]

Gets the number of register callback types for the interactor.

If you provide a non-0 pointer to an array of strings in the parameter names, it is set on return to point to an array of strings that describe each of the callback types. Some of these descriptions may be 0. You must not modify nor delete this array. If you provide a non-0 pointer to an array of symbols in the parameter types, it is set on return to point to an array of symbols that define each of the callback types. You must not modify nor delete this array. If you create a new callback type and want it returned by a call to getCallbackTypes, you can use the static member function IlvGraphic::AddToCallbackTypeList. The default implementation registers one callback with the shared name of the interactor as symbol. For example, the IlvMoveInteractor class has a callback registered on the symbol "Move".

Parameters:

	count	The number of elements in the returned arrays names and types. This parameter must be set to 0 before calling this method.
	names	An array of strings.
	types	An array of symbols.

Returns:

The number of register callback types for this object.

Reimplemented from IlvInteractor.

virtual IlBoolean IlvGadgetInteractor::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.

Implements IlvInteractor.