KateDocCursor Class Reference

#include <katecursor.h>

Inheritance diagram for KateDocCursor:

Public Member Functions
	KateDocCursor (KateDocument *doc)
	KateDocCursor (int line, int col, KateDocument *doc)
bool	validPosition (uint line, uint col)
bool	validPosition ()
bool	gotoNextLine ()
bool	gotoPreviousLine ()
bool	gotoEndOfNextLine ()
bool	gotoEndOfPreviousLine ()
int	nbCharsOnLineAfter ()
bool	moveForward (uint nbChar)
bool	moveBackward (uint nbChar)
void	position (uint *line, uint *col) const
bool	setPosition (uint line, uint col)
bool	insertText (const TQString &text)
bool	removeText (uint numberOfCharacters)
TQChar	currentChar () const
uchar	currentAttrib () const
bool	nextNonSpaceChar ()
bool	previousNonSpaceChar ()
Public Member Functions inherited from KateTextCursor
	KateTextCursor (int line, int col)
void	pos (int *pline, int *pcol) const
int	line () const
int	col () const
virtual void	setLine (int line)
virtual void	setCol (int col)
virtual void	setPos (const KateTextCursor &pos)
virtual void	setPos (int line, int col)

Protected Attributes
KateDocument *	m_doc
Protected Attributes inherited from KateTextCursor
int	m_line
int	m_col

Detailed Description

Cursor class with a pointer to its document.

Definition at line 92 of file katecursor.h.

Constructor & Destructor Documentation

KateDocCursor() [1/2]

KateDocCursor::KateDocCursor

(

KateDocument *

doc

)

Definition at line 31 of file katecursor.cpp.

KateDocCursor() [2/2]

KateDocCursor::KateDocCursor	(	int	line,
		int	col,
		KateDocument *	doc
	)

Definition at line 35 of file katecursor.cpp.

~KateDocCursor()

virtual KateDocCursor::~KateDocCursor ( )

inlinevirtual

Definition at line 97 of file katecursor.h.

Member Function Documentation

currentAttrib()

uchar KateDocCursor::currentAttrib

(

)

const

Definition at line 160 of file katecursor.cpp.

currentChar()

TQChar KateDocCursor::currentChar

(

)

const

Definition at line 155 of file katecursor.cpp.

gotoEndOfNextLine()

bool KateDocCursor::gotoEndOfNextLine

(

)

Definition at line 93 of file katecursor.cpp.

gotoEndOfPreviousLine()

bool KateDocCursor::gotoEndOfPreviousLine

(

)

Definition at line 102 of file katecursor.cpp.

gotoNextLine()

bool KateDocCursor::gotoNextLine

(

)

Definition at line 69 of file katecursor.cpp.

gotoPreviousLine()

bool KateDocCursor::gotoPreviousLine

(

)

Definition at line 81 of file katecursor.cpp.

insertText()

bool KateDocCursor::insertText

(

const TQString &

text

)

Definition at line 139 of file katecursor.cpp.

moveBackward()

bool KateDocCursor::moveBackward

(

uint

nbChar

)

Definition at line 128 of file katecursor.cpp.

moveForward()

bool KateDocCursor::moveForward

(

uint

nbChar

)

Definition at line 116 of file katecursor.cpp.

nbCharsOnLineAfter()

int KateDocCursor::nbCharsOnLineAfter

(

)

Definition at line 111 of file katecursor.cpp.

nextNonSpaceChar()

bool KateDocCursor::nextNonSpaceChar

(

)

Find the position (line and col) of the next char that is not a space.

If found KateDocCursor points to the found character. Otherwise to a invalid Position such that validPosition() returns false.

Returns

True if the specified or a following character is not a space Otherwise false.

Definition at line 165 of file katecursor.cpp.

position()

void KateDocCursor::position	(	uint *	line,
		uint *	col
	)		const

Definition at line 50 of file katecursor.cpp.

previousNonSpaceChar()

bool KateDocCursor::previousNonSpaceChar

(

)

Find the position (line and col) of the previous char that is not a space.

If found KateDocCursor points to the found character. Otherwise to a invalid Position such that validPosition() returns false.

Returns

True if the specified or a preceding character is not a space Otherwise false.

Definition at line 178 of file katecursor.cpp.

removeText()

bool KateDocCursor::removeText

(

uint

numberOfCharacters

)

Definition at line 144 of file katecursor.cpp.

setPosition()

bool KateDocCursor::setPosition	(	uint	line,
		uint	col
	)

Definition at line 59 of file katecursor.cpp.

validPosition() [1/2]

bool KateDocCursor::validPosition

(

)

Definition at line 45 of file katecursor.cpp.

validPosition() [2/2]

bool KateDocCursor::validPosition	(	uint	line,
		uint	col
	)

Definition at line 40 of file katecursor.cpp.

Member Data Documentation

m_doc

KateDocument* KateDocCursor::m_doc

protected

Definition at line 141 of file katecursor.h.

---

The documentation for this class was generated from the following files:

• katecursor.h
• katecursor.cpp