KTextEditor::SmartCursorWatcher Class Reference

A class which provides notifications of state changes to a SmartCursor via virtual inheritance. More...

#include <smartcursorwatcher.h>

List of all members.

Public Member Functions
	SmartCursorWatcher ()
virtual	~SmartCursorWatcher ()
virtual void	characterDeleted (SmartCursor *cursor, bool deletedBefore)
virtual void	characterInserted (SmartCursor *cursor, bool insertedBefore)
virtual void	deleted (SmartCursor *cursor)
virtual void	positionChanged (SmartCursor *cursor)
virtual void	positionDeleted (SmartCursor *cursor)
void	setWantsDirectChanges (bool wantsDirectChanges)
bool	wantsDirectChanges () const

---

Detailed Description

A class which provides notifications of state changes to a SmartCursor via virtual inheritance.

This class provides notifications of changes to a SmartCursor such as the position in the document, and deletion or insertion of text immediately before or after the cursor.

If you prefer to receive notifications via QObject signals, see SmartCursorNotifier.

See also:

SmartCursor, SmartCursorNotifier

Author:

Hamish Rodda <rodda@kde.org>

Definition at line 47 of file smartcursorwatcher.h.

---

Constructor & Destructor Documentation

SmartCursorWatcher::SmartCursorWatcher

(

)

Default constructor.

Definition at line 25 of file cursorfeedback.cpp.

SmartCursorWatcher::~SmartCursorWatcher

(

)

[virtual]

Virtual destructor.

Definition at line 30 of file cursorfeedback.cpp.

---

Member Function Documentation

void SmartCursorWatcher::characterDeleted	(	SmartCursor *	cursor,
		bool	deletedBefore
	)		[virtual]

The character immediately surrounding the cursor was deleted.

If both characters are simultaneously deleted, positionDeleted() is called instead.

Parameters:

cursor	pointer to the cursor which generated the notification.
deletedBefore	true if the character immediately before was deleted, false if the character immediately after was deleted.

Definition at line 42 of file cursorfeedback.cpp.

void SmartCursorWatcher::characterInserted	(	SmartCursor *	cursor,
		bool	insertedBefore
	)		[virtual]

A character was inserted immediately before or after the cursor, as given by insertedBefore.

Parameters:

cursor	pointer to the cursor which generated the notification.
insertedBefore	true if a character was inserted before cursor, false if a character was inserted after

Definition at line 46 of file cursorfeedback.cpp.

void SmartCursorWatcher::deleted

(

SmartCursor *

cursor

)

[virtual]

The SmartCursor instance specified by cursor is being deleted.

Parameters:

cursor

pointer to the cursor which is about to be deleted. It is still safe to access information at this point.

Definition at line 75 of file cursorfeedback.cpp.

void SmartCursorWatcher::positionChanged

(

SmartCursor *

cursor

)

[virtual]

The cursor's position was changed.

Parameters:

cursor

pointer to the cursor which generated the notification.

Definition at line 34 of file cursorfeedback.cpp.

void SmartCursorWatcher::positionDeleted

(

SmartCursor *

cursor

)

[virtual]

The cursor's surrounding characters were both deleted simultaneously.

The cursor is automatically placed at the start of the deleted region.

Parameters:

cursor

pointer to the cursor which generated the notification.

Definition at line 38 of file cursorfeedback.cpp.

void SmartCursorWatcher::setWantsDirectChanges

(

bool

wantsDirectChanges

)

Set whether this watcher should be notified of changes that happen directly to the cursor, e.g.

by calls to SmartCursor::setPosition(), rather than just when surrounding text changes.

Parameters:

wantsDirectChanges

whether this watcher should receive notifications for direct changes.

Definition at line 55 of file cursorfeedback.cpp.

bool SmartCursorWatcher::wantsDirectChanges

(

)

const

Returns whether this watcher wants to be notified of changes that happen directly to the cursor, e.g.

by calls to SmartCursor::setPosition(), rather than just when surrounding text changes.

Definition at line 50 of file cursorfeedback.cpp.

---

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

• smartcursorwatcher.h
• cursorfeedback.cpp