rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Friends
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
lineThe index of the line.
columnThe 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
locationThe 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
locationThe 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
lineThe new line index.
columnThe new column index.
See Also
getLine, getColumn
void IlvTextLocation::setColumn ( IlUShort  column)

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

Parameters
columnThe new column index.
See Also
getColumn
void IlvTextLocation::setLine ( IlUShort  line)

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

Parameters
lineThe new line index.
See Also
getLine

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.