IlvATZone Class Reference

Annotated text gadget class. More...

#include <ilviews/annotext/zone.h>

List of all members.

Public Member Functions
	IlvATZone (IlvATCursor *start, IlvATCursor *end)
	Constructor.
IlvAnnoText *	getAnnoText () const
	Returns the annotated text object associated with the text zone.
IlvATInteractor *	getInteractor () const
	Returns the interactor of the text zone.
IlvATZone *	getParent () const
	Returns the text zone immediately containing this zone.
IlvATPalette *	getTextPalette () const
	Returns the IlvATPalette of the text zone.
IlAny	getUserData () const
	Returns the user data of the text zone.
void	setInteractor (IlvATInteractor *inter)
	Sets the interactor of the text zone.
void	setUserData (IlAny val)
	Set the user data.

---

Detailed Description

Annotated text gadget class.

Library: ilvatext

An instance of this class represents a contiguous zone of the text flow. IlvATZone instances can be nested but always in a hierarchical way, which may be ensured by checking whether the two boundaries of an IlvATZone belong to the same upper IlvATZone (or to no IlvATZone at all). The IlvAnnoText::insertZone member function checks this. An IlvATZone is linked to an IlvATPalette which carries graphical information such as margins, font, foreground and background colors. It may have a specific IlvATInteractor or use the one assigned to its IlvATPalette. A user data field enables the storage of additional information specific to an instance of the IlvATZone class. This is useful, for example, when writing an IlvATInteractor assigned to an IlvATPalette instance. In this case, when an IlvATPalette instance is applied to any IlvATZone belonging to this IlvATPalette, it uses the user data information of the particular instance that triggers it (such as a hypertext interactor using information stored in the user data field of the IlvATZone to know what new file must be loaded).

See also:

IlvAnnoText, IlvATCursor, IlvATInsertionCursor, IlvATInteractor, IlvATPalette.

---

Constructor & Destructor Documentation

IlvATZone::IlvATZone	(	IlvATCursor *	start,
		IlvATCursor *	end
	)

Constructor.

Initializes a new instance of the IlvATZone class. The text zone begins just after the start cursor and ends just before the end cursor.

Parameters:

	start	Specifies the beginning of the text zone.
	end	Specifies the end of the text zone.

---

Member Function Documentation

IlvAnnoText* IlvATZone::getAnnoText

(

)

const

Returns the annotated text object associated with the text zone.

Returns:

The IlvAnnoText holding the IlvATZone.

IlvATInteractor* IlvATZone::getInteractor

(

)

const

Returns the interactor of the text zone.

Returns:

The IlvATInteractor associated with the text zone, or, if no IlvATInteractor has been associated to it, a pointer to the IlvATInteractor associated with the IlvATPalette to which the current IlvATZone belongs; if the current IlvATZone doesn't belong to any IlvATPalette, or if its IlvATPalette doesn't have an IlvATInteractor attached, the function returns 0.

IlvATZone* IlvATZone::getParent

(

)

const

Returns the text zone immediately containing this zone.

Returns:

The IlvATZone immediately containing the current IlvATZone or 0 is there are none.

IlvATPalette* IlvATZone::getTextPalette

(

)

const

Returns the IlvATPalette of the text zone.

Returns:

The IlvATPalette associated with the text zone, or 0 if it has not yet been affected to an IlvATPalette.

IlAny IlvATZone::getUserData

(

)

const

Returns the user data of the text zone.

Returns:

The user data (of type IlAny) associated with the IlvATZone.

void IlvATZone::setInteractor

(

IlvATInteractor *

inter

)

Sets the interactor of the text zone.

Parameters:

inter

The interactor.

void IlvATZone::setUserData

(

IlAny

val

)

Set the user data.

Parameters:

userdata

The user data.