KateSmartCursor Class Reference

Possible additional features:

• Notification when a cursor enters or exits a view
• suggest something :).

More...

#include <katesmartcursor.h>

Inheritance diagram for KateSmartCursor:

[legend]

List of all members.

Public Member Functions
virtual bool	atEndOfLine () const
bool	cursorMoved () const
virtual void	deleteNotifier ()
bool	feedbackEnabled () const
virtual bool	hasNotifier () const
bool	isInternal () const
virtual bool	isValid (const Cursor &position) const
virtual bool	isValid () const
KateDocument *	kateDocument () const
	KateSmartCursor (KTextEditor::Document *doc, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::MoveOnInsert)
	KateSmartCursor (const KTextEditor::Cursor &position, KTextEditor::Document *doc, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::MoveOnInsert)
const KTextEditor::Cursor &	lastPosition () const
virtual int	line () const
void	migrate (KateSmartGroup *newGroup)
virtual KTextEditor::SmartCursorNotifier *	notifier ()
	operator QString ()
KateSmartCursor &	operator= (const KTextEditor::Cursor &rhs)
void	resetLastPosition ()
void	setInternal ()
virtual void	setLine (int line)
virtual void	setPosition (const KTextEditor::Cursor &pos)
virtual void	setWatcher (KTextEditor::SmartCursorWatcher *watcher=0L)
void	shifted ()
KateSmartGroup *	smartGroup () const
bool	translate (const KateEditInfo &edit)
void	translated (const KateEditInfo &edit)
void	unbindFromRange ()
virtual KTextEditor::SmartCursorWatcher *	watcher () const
virtual	~KateSmartCursor ()
Protected Member Functions
virtual void	checkFeedback ()
void	setLineInternal (int newLine, bool internal=true)
void	setPositionInternal (const KTextEditor::Cursor &pos, bool internal=true)

---

Detailed Description

Possible additional features:

• Notification when a cursor enters or exits a view
• suggest something :).

Unresolved issues:

• testing, testing, testing
• api niceness Internal implementation of KTextEditor::SmartCursor

  Author:

  Hamish Rodda

Definition at line 48 of file katesmartcursor.h.

---

Constructor & Destructor Documentation

KateSmartCursor::KateSmartCursor	(	const KTextEditor::Cursor &	position,
		KTextEditor::Document *	doc,
		KTextEditor::SmartCursor::InsertBehavior	insertBehavior = KTextEditor::SmartCursor::MoveOnInsert
	)

Definition at line 30 of file katesmartcursor.cpp.

KateSmartCursor::KateSmartCursor	(	KTextEditor::Document *	doc,
		KTextEditor::SmartCursor::InsertBehavior	insertBehavior = KTextEditor::SmartCursor::MoveOnInsert
	)			[explicit]

Definition at line 57 of file katesmartcursor.cpp.

KateSmartCursor::~KateSmartCursor

(

)

[virtual]

Definition at line 77 of file katesmartcursor.cpp.

---

Member Function Documentation

bool KateSmartCursor::atEndOfLine

(

)

const [virtual]

Definition at line 111 of file katesmartcursor.cpp.

void KateSmartCursor::checkFeedback

(

)

[protected, virtual]

Definition at line 116 of file katesmartcursor.cpp.

bool KateSmartCursor::cursorMoved

(

)

const

This is a function solely for use by KateSuperRange.

Used to see if a change in position has occurred since it was last called.

Definition at line 311 of file katesmartcursor.cpp.

void KateSmartCursor::deleteNotifier

(

)

[virtual]

Definition at line 224 of file katesmartcursor.cpp.

bool KateSmartCursor::feedbackEnabled

(

)

const [inline]

Definition at line 86 of file katesmartcursor.h.

bool KateSmartCursor::hasNotifier

(

)

const [virtual]

Definition at line 422 of file katesmartcursor.cpp.

bool KateSmartCursor::isInternal

(

)

const [inline]

Definition at line 60 of file katesmartcursor.h.

bool KateSmartCursor::isValid

(

const Cursor &

position

)

const [virtual]

Definition at line 106 of file katesmartcursor.cpp.

bool KateSmartCursor::isValid

(

)

const [virtual]

Definition at line 101 of file katesmartcursor.cpp.

KateDocument * KateSmartCursor::kateDocument

(

)

const

Definition at line 96 of file katesmartcursor.cpp.

const KTextEditor::Cursor& KateSmartCursor::lastPosition

(

)

const [inline]

Definition at line 110 of file katesmartcursor.h.

int KateSmartCursor::line

(

)

const [virtual]

Definition at line 128 of file katesmartcursor.cpp.

void KateSmartCursor::migrate

(

KateSmartGroup *

newGroup

)

Definition at line 399 of file katesmartcursor.cpp.

KTextEditor::SmartCursorNotifier * KateSmartCursor::notifier

(

)

[virtual]

Definition at line 215 of file katesmartcursor.cpp.

KateSmartCursor::operator QString

(

)

Debug: output the position.

Definition at line 91 of file katesmartcursor.cpp.

KateSmartCursor& KateSmartCursor::operator=

(

const KTextEditor::Cursor &

rhs

)

[inline]

Definition at line 69 of file katesmartcursor.h.

void KateSmartCursor::resetLastPosition

(

)

Definition at line 417 of file katesmartcursor.cpp.

void KateSmartCursor::setInternal

(

)

Definition at line 437 of file katesmartcursor.cpp.

void KateSmartCursor::setLine

(

int

line

)

[virtual]

Definition at line 133 of file katesmartcursor.cpp.

void KateSmartCursor::setLineInternal	(	int	newLine,
		bool	internal = true
	)			[protected]

Definition at line 318 of file katesmartcursor.cpp.

void KateSmartCursor::setPosition

(

const KTextEditor::Cursor &

pos

)

[virtual]

Definition at line 406 of file katesmartcursor.cpp.

void KateSmartCursor::setPositionInternal	(	const KTextEditor::Cursor &	pos,
		bool	internal = true
	)			[protected]

Definition at line 138 of file katesmartcursor.cpp.

void KateSmartCursor::setWatcher

(

KTextEditor::SmartCursorWatcher *

watcher = 0L

)

[virtual]

Definition at line 231 of file katesmartcursor.cpp.

void KateSmartCursor::shifted

(

)

Definition at line 385 of file katesmartcursor.cpp.

KateSmartGroup* KateSmartCursor::smartGroup

(

)

const [inline]

Definition at line 88 of file katesmartcursor.h.

bool KateSmartCursor::translate

(

const KateEditInfo &

edit

)

Definition at line 237 of file katesmartcursor.cpp.

void KateSmartCursor::translated

(

const KateEditInfo &

edit

)

If the cursor is requesting feedback, this is called whenever the cursor's position moves and it's not needing to be adjusted via translateCursor().

Definition at line 323 of file katesmartcursor.cpp.

void KateSmartCursor::unbindFromRange

(

)

Definition at line 432 of file katesmartcursor.cpp.

KTextEditor::SmartCursorWatcher * KateSmartCursor::watcher

(

)

const [virtual]

Definition at line 427 of file katesmartcursor.cpp.

---

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

• katesmartcursor.h
• katesmartcursor.cpp