KateDocCursor Class Reference

Cursor class with a pointer to its document. More...

#include <katecursor.h>

Inheritance diagram for KateDocCursor:

[legend]

List of all members.

Public Member Functions
uchar	currentAttrib () const
QChar	currentChar () const
bool	gotoEndOfNextLine ()
bool	gotoEndOfPreviousLine ()
bool	gotoNextLine ()
bool	gotoPreviousLine ()
bool	insertText (const QString &text)
	KateDocCursor (int line, int col, KateDocument *doc)
	KateDocCursor (KateDocument *doc)
bool	moveBackward (uint nbChar)
bool	moveForward (uint nbChar)
int	nbCharsOnLineAfter ()
bool	nextNonSpaceChar ()
void	position (uint *line, uint *col) const
bool	previousNonSpaceChar ()
bool	removeText (uint numberOfCharacters)
bool	setPosition (uint line, uint col)
bool	validPosition ()
bool	validPosition (uint line, uint col)
virtual	~KateDocCursor ()
Protected Attributes
KateDocument *	m_doc

---

Detailed Description

Cursor class with a pointer to its document.

Definition at line 92 of file katecursor.h.

---

Constructor & Destructor Documentation

KateDocCursor::KateDocCursor

(

KateDocument *

doc

)

Definition at line 31 of file katecursor.cpp.

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

Definition at line 35 of file katecursor.cpp.

virtual KateDocCursor::~KateDocCursor

(

)

[inline, virtual]

Definition at line 97 of file katecursor.h.

---

Member Function Documentation

uchar KateDocCursor::currentAttrib

(

)

const

Definition at line 160 of file katecursor.cpp.

QChar KateDocCursor::currentChar

(

)

const

Reimplemented in KateSuperCursor.

Definition at line 155 of file katecursor.cpp.

bool KateDocCursor::gotoEndOfNextLine

(

)

Definition at line 93 of file katecursor.cpp.

bool KateDocCursor::gotoEndOfPreviousLine

(

)

Definition at line 102 of file katecursor.cpp.

bool KateDocCursor::gotoNextLine

(

)

Definition at line 69 of file katecursor.cpp.

bool KateDocCursor::gotoPreviousLine

(

)

Definition at line 81 of file katecursor.cpp.

bool KateDocCursor::insertText

(

const QString &

text

)

Reimplemented in KateSuperCursor.

Definition at line 139 of file katecursor.cpp.

bool KateDocCursor::moveBackward

(

uint

nbChar

)

Definition at line 128 of file katecursor.cpp.

bool KateDocCursor::moveForward

(

uint

nbChar

)

Definition at line 116 of file katecursor.cpp.

int KateDocCursor::nbCharsOnLineAfter

(

)

Definition at line 111 of file katecursor.cpp.

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.

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

Reimplemented in KateSuperCursor.

Definition at line 50 of file katecursor.cpp.

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.

bool KateDocCursor::removeText

(

uint

numberOfCharacters

)

Reimplemented in KateSuperCursor.

Definition at line 144 of file katecursor.cpp.

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

Reimplemented in KateSuperCursor.

Definition at line 59 of file katecursor.cpp.

bool KateDocCursor::validPosition

(

)

Definition at line 45 of file katecursor.cpp.

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

Definition at line 40 of file katecursor.cpp.

---

Member Data Documentation

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