IlvCodeEditor::Location Class Reference

The position of a logical character in the text managed by an IlvCodeEditor. More...

#include <ilviews/gadgets/codeedit.h>

Public Member Functions
	Location (IlInt line=-1, IlInt column=-1)
	Constructor. More...
void	set (IlInt line, IlInt column)
	Assigns the line and column values. More...
void	set (const Location &source)
	Copies a location. More...

Detailed Description

The position of a logical character in the text managed by an IlvCodeEditor.

Library: ilvadvgagt This class allows locating characters in a text that can contain up to MAX_INT * MAX_INT characters. The line and column values are signed; the negative -1 values are used to note incorrect line, column, or location altogether.

The valid numbering of lines and columns in locations starts from (0, 0).

Constructor & Destructor Documentation

IlvCodeEditor::Location::Location	(	IlInt	line = -1,
		IlInt	column = -1
	)

Constructor.

By default, when no values are given for line and column, the location is invalid. That is a call to isDefault() will return IlTrue.

Member Function Documentation

void IlvCodeEditor::Location::set	(	IlInt	line,
		IlInt	column
	)

Assigns the line and column values.

Parameters

line	The new line number.
column	The new column number.

If line or column is strictly negative, the set value is -1, making the location at least partially invalid.

void IlvCodeEditor::Location::set

(

const Location &

source

)

Copies a location.

Parameters

source

The location to copy.

No checks are made to verify the validity of the argument.