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

KTextEditor

  • KTextEditor
  • SmartRangeNotifier
Signals | Public Member Functions | List of all members
KTextEditor::SmartRangeNotifier Class Reference
Document Extension Interfaces » Smart Cursors and Ranges

#include <smartrangenotifier.h>

Inheritance diagram for KTextEditor::SmartRangeNotifier:
QObject

Signals

void caretEnteredRange (KTextEditor::SmartRange *range, KTextEditor::View *view)
 
void caretExitedRange (KTextEditor::SmartRange *range, KTextEditor::View *view)
 
void childRangeInserted (KTextEditor::SmartRange *range, KTextEditor::SmartRange *child)
 
void childRangeRemoved (KTextEditor::SmartRange *range, KTextEditor::SmartRange *child)
 
void mouseEnteredRange (KTextEditor::SmartRange *range, KTextEditor::View *view)
 
void mouseExitedRange (KTextEditor::SmartRange *range, KTextEditor::View *view)
 
void parentRangeChanged (KTextEditor::SmartRange *range, KTextEditor::SmartRange *newParent, KTextEditor::SmartRange *oldParent)
 
void rangeAttributeChanged (KTextEditor::SmartRange *range, KTextEditor::Attribute::Ptr currentAttribute, KTextEditor::Attribute::Ptr previousAttribute)
 
void rangeContentsChanged (KTextEditor::SmartRange *range)
 
void rangeContentsChanged (KTextEditor::SmartRange *range, KTextEditor::SmartRange *mostSpecificChild)
 
void rangeDeleted (KTextEditor::SmartRange *range)
 
void rangeEliminated (KTextEditor::SmartRange *range)
 
void rangePositionChanged (KTextEditor::SmartRange *range)
 

Public Member Functions

 SmartRangeNotifier ()
 
void setWantsDirectChanges (bool wantsDirectChanges)
 
bool wantsDirectChanges () const
 

Detailed Description

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

This class provides notifications of changes to the position or contents of a SmartRange via QObject signals.

If you prefer to receive notifications via virtual inheritance, see SmartRangeWatcher.

See also
SmartRange, SmartRangeWatcher
Author
Hamish Rodda <rodda.nosp@m.@kde.nosp@m..org>

Definition at line 48 of file smartrangenotifier.h.

Constructor & Destructor Documentation

◆ SmartRangeNotifier()

SmartRangeNotifier::SmartRangeNotifier ( )

Default constructor.

Definition at line 28 of file rangefeedback.cpp.

Member Function Documentation

◆ caretEnteredRange

void KTextEditor::SmartRangeNotifier::caretEnteredRange ( KTextEditor::SmartRange *  range,
KTextEditor::View *  view 
)
signal

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
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

◆ caretExitedRange

void KTextEditor::SmartRangeNotifier::caretExitedRange ( KTextEditor::SmartRange *  range,
KTextEditor::View *  view 
)
signal

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
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

◆ childRangeInserted

void KTextEditor::SmartRangeNotifier::childRangeInserted ( KTextEditor::SmartRange *  range,
KTextEditor::SmartRange *  child 
)
signal

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

Parameters
rangepointer to the range which generated the notification.
childpointer to the range which was inserted as a child range.

◆ childRangeRemoved

void KTextEditor::SmartRangeNotifier::childRangeRemoved ( KTextEditor::SmartRange *  range,
KTextEditor::SmartRange *  child 
)
signal

The child range child was removed from the current range.

Parameters
rangepointer to the range which generated the notification.
childpointer to the child range which was removed.

◆ mouseEnteredRange

void KTextEditor::SmartRangeNotifier::mouseEnteredRange ( KTextEditor::SmartRange *  range,
KTextEditor::View *  view 
)
signal

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
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

◆ mouseExitedRange

void KTextEditor::SmartRangeNotifier::mouseExitedRange ( KTextEditor::SmartRange *  range,
KTextEditor::View *  view 
)
signal

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
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

◆ parentRangeChanged

void KTextEditor::SmartRangeNotifier::parentRangeChanged ( KTextEditor::SmartRange *  range,
KTextEditor::SmartRange *  newParent,
KTextEditor::SmartRange *  oldParent 
)
signal

The range's parent was changed.

Parameters
rangepointer to the range which generated the notification.
newParentpointer to the range which was is now the parent range.
oldParentpointer to the range which used to be the parent range.

◆ rangeAttributeChanged

void KTextEditor::SmartRangeNotifier::rangeAttributeChanged ( KTextEditor::SmartRange *  range,
KTextEditor::Attribute::Ptr  currentAttribute,
KTextEditor::Attribute::Ptr  previousAttribute 
)
signal

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

Parameters
rangepointer to the range which generated the notification.
currentAttributethe attribute newly assigned to this range
previousAttributethe attribute previously assigned to this range

◆ rangeContentsChanged [1/2]

void KTextEditor::SmartRangeNotifier::rangeContentsChanged ( KTextEditor::SmartRange *  range)
signal

The contents of the range changed.

Parameters
rangepointer to the range which generated the notification.

◆ rangeContentsChanged [2/2]

void KTextEditor::SmartRangeNotifier::rangeContentsChanged ( KTextEditor::SmartRange *  range,
KTextEditor::SmartRange *  mostSpecificChild 
)
signal

The contents of the range changed.

Warning
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
rangepointer to the range which generated the notification.
mostSpecificChildthe child range which both contains the entire change and is the furthest descendant of this range.

◆ rangeDeleted

void KTextEditor::SmartRangeNotifier::rangeDeleted ( KTextEditor::SmartRange *  range)
signal

The SmartRange instance specified by range is being deleted.

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

◆ rangeEliminated

void KTextEditor::SmartRangeNotifier::rangeEliminated ( KTextEditor::SmartRange *  range)
signal

The range now contains no characters (ie.

the start and end cursors are the same).

Parameters
rangepointer to the range which generated the notification.

◆ rangePositionChanged

void KTextEditor::SmartRangeNotifier::rangePositionChanged ( KTextEditor::SmartRange *  range)
signal

The range's position changed.

Parameters
rangepointer to the range which generated the notification.

◆ setWantsDirectChanges()

void SmartRangeNotifier::setWantsDirectChanges ( bool  wantsDirectChanges)

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

Definition at line 38 of file rangefeedback.cpp.

◆ wantsDirectChanges()

bool SmartRangeNotifier::wantsDirectChanges ( ) const

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


The documentation for this class was generated from the following files:
  • smartrangenotifier.h
  • rangefeedback.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 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.14.38 API Reference

Skip menu "kdelibs-4.14.38 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