• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KTextEditor

KTextEditor::SmartRangeWatcher

KTextEditor::SmartRangeWatcher Class Reference
[Smart Cursors and Ranges]

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

#include <rangefeedback.h>

List of all members.


Public Member Functions

virtual void caretEnteredRange (SmartRange *range, View *view)
virtual void caretExitedRange (SmartRange *range, View *view)
virtual void childRangeInserted (SmartRange *range, SmartRange *child)
virtual void childRangeRemoved (SmartRange *range, SmartRange *child)
virtual void mouseEnteredRange (SmartRange *range, View *view)
virtual void mouseExitedRange (SmartRange *range, View *view)
virtual void parentRangeChanged (SmartRange *range, SmartRange *newParent, SmartRange *oldParent)
virtual void rangeAttributeChanged (SmartRange *range, Attribute::Ptr currentAttribute, Attribute::Ptr previousAttribute)
virtual void rangeContentsChanged (SmartRange *range, SmartRange *mostSpecificChild)
virtual void rangeContentsChanged (SmartRange *range)
virtual void rangeDeleted (SmartRange *range)
virtual void rangeEliminated (SmartRange *range)
virtual void rangePositionChanged (SmartRange *range)
void setWantsDirectChanges (bool wantsDirectChanges)
 SmartRangeWatcher ()
bool wantsDirectChanges () const
virtual ~SmartRangeWatcher ()

Detailed Description

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

This class provides notifications of changes to the position or contents of a SmartRange via virtual inheritance.

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

Before destruction, you must unregister the watcher from any ranges it is watching.

See also:
SmartRange, SmartRangeNotifier
Author:
Hamish Rodda <rodda@kde.org>

Definition at line 223 of file rangefeedback.h.


Constructor & Destructor Documentation

SmartRangeWatcher::SmartRangeWatcher (  ) 

Default constructor.

Definition at line 42 of file rangefeedback.cpp.

SmartRangeWatcher::~SmartRangeWatcher (  )  [virtual]

Virtual destructor.

Definition at line 23 of file rangefeedback.cpp.


Member Function Documentation

void SmartRangeWatcher::caretEnteredRange ( SmartRange *  range,
View *  view 
) [virtual]

The caret on view entered range.

Todo:
For now, to receive this notification, the range heirachy must be registered with the SmartInterface as for arbitrary highlighting with dynamic highlighting. Need to add another (and probably simplify existing) method.
Parameters:
range pointer to the range which generated the notification.
view view over which the mouse moved to generate the notification

Definition at line 77 of file rangefeedback.cpp.

void SmartRangeWatcher::caretExitedRange ( SmartRange *  range,
View *  view 
) [virtual]

The caret on view exited range.

Todo:
For now, to receive this notification, the range heirachy must be registered with the SmartInterface as for arbitrary highlighting with dynamic highlighting. Need to add another (and probably simplify existing) method.
Parameters:
range pointer to the range which generated the notification.
view view over which the mouse moved to generate the notification

Definition at line 81 of file rangefeedback.cpp.

void SmartRangeWatcher::childRangeInserted ( SmartRange *  range,
SmartRange *  child 
) [virtual]

The range child was inserted as a child range into the current range.

Parameters:
range pointer to the range which generated the notification.
child pointer to the range which was inserted as a child range.

Definition at line 93 of file rangefeedback.cpp.

void SmartRangeWatcher::childRangeRemoved ( SmartRange *  range,
SmartRange *  child 
) [virtual]

The child range child was removed from the current range.

Parameters:
range pointer to the range which generated the notification.
child pointer to the child range which was removed.

Definition at line 97 of file rangefeedback.cpp.

void SmartRangeWatcher::mouseEnteredRange ( SmartRange *  range,
View *  view 
) [virtual]

The mouse cursor on view entered range.

Todo:
For now, to receive this notification, the range heirachy must be registered with the SmartInterface as for arbitrary highlighting with dynamic highlighting. Need to add another (and probably simplify existing) method.
Parameters:
range pointer to the range which generated the notification.
view view over which the mouse moved to generate the notification

Definition at line 69 of file rangefeedback.cpp.

void SmartRangeWatcher::mouseExitedRange ( SmartRange *  range,
View *  view 
) [virtual]

The mouse cursor on view exited range.

Todo:
For now, to receive this notification, the range heirachy must be registered with the SmartInterface as for arbitrary highlighting with dynamic highlighting. Need to add another (and probably simplify existing) method.
Parameters:
range pointer to the range which generated the notification.
view view over which the mouse moved to generate the notification

Definition at line 73 of file rangefeedback.cpp.

void SmartRangeWatcher::parentRangeChanged ( SmartRange *  range,
SmartRange *  newParent,
SmartRange *  oldParent 
) [virtual]

The range's parent was changed.

Parameters:
range pointer to the range which generated the notification.
newParent pointer to the range which was is now the parent range.
oldParent pointer to the range which used to be the parent range.

Definition at line 105 of file rangefeedback.cpp.

void SmartRangeWatcher::rangeAttributeChanged ( SmartRange *  range,
Attribute::Ptr  currentAttribute,
Attribute::Ptr  previousAttribute 
) [virtual]

The highlighting attribute of range was changed from previousAttribute to currentAttribute.

Parameters:
range pointer to the range which generated the notification.
currentAttribute the attribute newly assigned to this range
previousAttribute the attribute previously assigned to this range

Definition at line 101 of file rangefeedback.cpp.

void SmartRangeWatcher::rangeContentsChanged ( SmartRange *  range,
SmartRange *  mostSpecificChild 
) [virtual]

The contents of the range changed.

This notification is special in that it is only emitted by the top range of a heirachy, and also gives the furthest descendant child range which still encompasses the whole change (see contents).

Parameters:
range the range which has changed
mostSpecificChild the child range which both contains the entire change and is the furthest descendant of this range.

Definition at line 65 of file rangefeedback.cpp.

void SmartRangeWatcher::rangeContentsChanged ( SmartRange *  range  )  [virtual]

The contents of the range changed.

Parameters:
range pointer to the range which generated the notification.

Definition at line 61 of file rangefeedback.cpp.

void SmartRangeWatcher::rangeDeleted ( SmartRange *  range  )  [virtual]

The SmartRange instance specified by range is being deleted.

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

Definition at line 89 of file rangefeedback.cpp.

void SmartRangeWatcher::rangeEliminated ( SmartRange *  range  )  [virtual]

The range now contains no characters (ie.

the start and end cursors are the same).

Parameters:
range pointer to the range which generated the notification.

Definition at line 85 of file rangefeedback.cpp.

void SmartRangeWatcher::rangePositionChanged ( SmartRange *  range  )  [virtual]

The range's position changed.

Parameters:
range pointer to the range which generated the notification.

Definition at line 57 of file rangefeedback.cpp.

void SmartRangeWatcher::setWantsDirectChanges ( bool  wantsDirectChanges  ) 

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

by calls to SmartCursor::setRange(), or by direct assignment to either of the start() or end() cursors, rather than just when surrounding text changes.

Parameters:
wantsDirectChanges whether this watcher should receive notifications for direct changes.

Definition at line 52 of file rangefeedback.cpp.

bool SmartRangeWatcher::wantsDirectChanges (  )  const

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

by calls to SmartCursor::setRange(), or by direct assignment to either of the start() or end() cursors, rather than just when surrounding text changes.

Definition at line 47 of file rangefeedback.cpp.


The documentation for this class was generated from the following files:
  • rangefeedback.h
  • rangefeedback.cpp

KTextEditor

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal