IlvATInteractor Class Reference

Annotated text gadget class. More...

#include <ilviews/annotext/zone.h>

Inherited by IlvATHtmlCommandInteractor, and IlvATHtmlLinkInteractor.

Public Member Functions
	IlvATInteractor ()
	Constructor. More...
IlBoolean	areGadgetsActive () const
	Indicates whether events occurring in a gadget are dispatched to the gadget. More...
virtual IlBoolean	handleEvent (IlvATZone *zone, IlvEvent &event)=0
	Handles user events that occur over a text zone. More...
void	setGadgetsActive (IlBoolean active)
	Specifies whether events occurring in a gadget must be dispatched to the gadget. More...

Detailed Description

Annotated text gadget class.

Library: ilvatext

The abstract class IlvATInteractor is a base class which may be derived to define interactors for IlvATZone and IlvATPalette instances.

See also

IlvAnnoText, IlvATCursor, IlvATInsertionCursor, IlvATZone, IlvATPalette.

Constructor & Destructor Documentation

IlvATInteractor::IlvATInteractor

(

)

Constructor.

Creates a new instance of the IlvATInteractor class.

Member Function Documentation

IlBoolean IlvATInteractor::areGadgetsActive

(

)

const

Indicates whether events occurring in a gadget are dispatched to the gadget.

This method affects the way an event occurring in a gadget contained in the annotated text is dispatched. If the method returns IlFalse, the event is not sent to the gadget and IlvATInteractor::handleEvent() is called. Otherwise, the event is dispatched to the gadget by means of a call to IlvGadget::handleEvent(); if this call returns IlFalse, IlvATInteractor::handleEvent() is called.

Returns

IlTrue if the event must be dispatched to the gadget.

virtual IlBoolean IlvATInteractor::handleEvent ( IlvATZone *  zone, IlvEvent &  event  )

pure virtual

Handles user events that occur over a text zone.

Called by the annotated text when an event occurs on an IlvATZone. The interactor is attached to either zone or, if zone does not have interactor attached to it, to the IlvATPalette of the annotated text.

Parameters

zone	The text zone where the event occurred.
event	The event.

Returns

IlTrue if the event is consumed by the interactor.

void IlvATInteractor::setGadgetsActive

(

IlBoolean

active

)

Specifies whether events occurring in a gadget must be dispatched to the gadget.

Defines what is done with an event if this event is located on an IlvGadget.

Parameters

active

If set to IlTrue, events occurring in a gadget will be dispatched to the gadget.

See also

IlvATInteractor::areGadgetsActive().