• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KTextEditor

  • KTextEditor
  • SmartCursorWatcher
Public Member Functions
KTextEditor::SmartCursorWatcher Class Reference
Smart Cursors and Ranges

#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.nosp@m.@kde.nosp@m..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:
cursorpointer to the cursor which generated the notification.
deletedBeforetrue 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:
cursorpointer to the cursor which generated the notification.
insertedBeforetrue 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:
cursorpointer 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:
cursorpointer 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:
cursorpointer 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:
wantsDirectChangeswhether 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 23 2013 20:49:25 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal