KTextEditor::SmartCursorNotifier Class Reference

A class which provides notifications of state changes to a SmartCursor via QObject signals. More...

#include <smartcursornotifier.h>

Inheritance diagram for KTextEditor::SmartCursorNotifier:

List of all members.

Signals
void	characterDeleted (KTextEditor::SmartCursor *cursor, bool deletedBefore)
void	characterInserted (KTextEditor::SmartCursor *cursor, bool insertedBefore)
void	deleted (KTextEditor::SmartCursor *cursor)
void	positionChanged (KTextEditor::SmartCursor *cursor)
void	positionDeleted (KTextEditor::SmartCursor *cursor)
Public Member Functions
	SmartCursorNotifier ()
void	setWantsDirectChanges (bool wantsDirectChanges)
bool	wantsDirectChanges () const

---

Detailed Description

A class which provides notifications of state changes to a SmartCursor via QObject signals.

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 virtual inheritance, see SmartCursorWatcher.

See also:

SmartCursor, SmartCursorNotifier

Author:

Hamish Rodda <rodda@kde.org>

Definition at line 46 of file smartcursornotifier.h.

---

Constructor & Destructor Documentation

SmartCursorNotifier::SmartCursorNotifier

(

)

Default constructor.

Definition at line 60 of file cursorfeedback.cpp.

---

Member Function Documentation

void KTextEditor::SmartCursorNotifier::characterDeleted	(	KTextEditor::SmartCursor *	cursor,
		bool	deletedBefore
	)		[signal]

One 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.

void KTextEditor::SmartCursorNotifier::characterInserted	(	KTextEditor::SmartCursor *	cursor,
		bool	insertedBefore
	)		[signal]

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

void KTextEditor::SmartCursorNotifier::deleted

(

KTextEditor::SmartCursor *

cursor

)

[signal]

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.

void KTextEditor::SmartCursorNotifier::positionChanged

(

KTextEditor::SmartCursor *

cursor

)

[signal]

The cursor's position was changed.

Parameters:

cursor

pointer to the cursor which generated the notification.

void KTextEditor::SmartCursorNotifier::positionDeleted

(

KTextEditor::SmartCursor *

cursor

)

[signal]

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.

void SmartCursorNotifier::setWantsDirectChanges

(

bool

wantsDirectChanges

)

Set whether this notifier should notify 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 notifier should provide notifications for direct changes.

Definition at line 70 of file cursorfeedback.cpp.

bool SmartCursorNotifier::wantsDirectChanges

(

)

const

Returns whether this notifier will notify 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 65 of file cursorfeedback.cpp.

---

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

• smartcursornotifier.h
• cursorfeedback.cpp