IlvTextLocation Class Reference

Gadget class. More...

#include <ilviews/gadgets/text.h>

Public Member Functions
	IlvTextLocation (IlUShort line=0, IlUShort column=0)
	Constructor. More...
IlUShort	getColumn () const
	Returns the index of the column pointed to by the object. More...
IlUShort	getLine () const
	Returns the index of the line pointed to by the object. More...
IlBoolean	isBefore (const IlvTextLocation &location) const
	Indicates whether a text location is before another one. More...
IlBoolean	isSame (const IlvTextLocation &location) const
	Indicates whether two text locations are the same. More...
void	set (IlUShort line=0, IlUShort column=0)
	Sets the indexes of the column and the line pointed to by the object. More...
void	setColumn (IlUShort column)
	Sets the index of the column pointed to by the object. More...
void	setLine (IlUShort line)
	Sets the index of the line pointed to by the object. More...

Friends
class	IlvText

Detailed Description

Gadget class.

Library: ilvadvgdt

The class IlvTextLocation is used to locate text inside a text gadget.

See also

IlvText.

Constructor & Destructor Documentation

IlvTextLocation::IlvTextLocation	(	IlUShort	line = 0,
		IlUShort	column = 0
	)

Constructor.

Initializes a new instance of the class IlvTextLocation.

Parameters

line	The index of the line.
column	The index of the column.

Member Function Documentation

IlUShort IlvTextLocation::getColumn

(

)

const

Returns the index of the column pointed to by the object.

Returns

The index of the column pointed to by the object.

See also

setColumn().

IlUShort IlvTextLocation::getLine

(

)

const

Returns the index of the line pointed to by the object.

Returns

The index of the line pointed to by the object.

See also

setLine.

IlBoolean IlvTextLocation::isBefore

(

const IlvTextLocation &

location

)

const

Indicates whether a text location is before another one.

Parameters

location

The text location to which this instance is compared.

Returns

IlTrue if the current text location is before location. This occurs when the current line is less than location, or when both lines are the same but the current column is less than or equal to location.

See also

set(), isSame().

IlBoolean IlvTextLocation::isSame

(

const IlvTextLocation &

location

)

const

Indicates whether two text locations are the same.

Parameters

location

The text location to which this instance is compared.

Returns

IlTrue if the current object has the same attributes as location, that is, when they both point to the same line and column. If at least one of the two attributes does not match, this member function returns IlFalse.

See also

set(), isBefore().

void IlvTextLocation::set	(	IlUShort	line = 0,
		IlUShort	column = 0
	)

Sets the indexes of the column and the line pointed to by the object.

Parameters

line	The new line index.
column	The new column index.

See also

getLine(), getColumn().

void IlvTextLocation::setColumn

(

IlUShort

column

)

Sets the index of the column pointed to by the object.

Parameters

column

The new column index.

See also

getColumn().

void IlvTextLocation::setLine

(

IlUShort

line

)

Sets the index of the line pointed to by the object.

Parameters

line	The new line index.

See also

getLine().