KTextEditor::MovingRangeFeedback

Search for usage in LXR

#include <KTextEditor/MovingRangeFeedback>

Inheritance diagram for KTextEditor::MovingRangeFeedback:

Public Member Functions

 MovingRangeFeedback ()
 
virtual ~MovingRangeFeedback ()
 
virtual void caretEnteredRange (MovingRange *range, View *view)
 
virtual void caretExitedRange (MovingRange *range, View *view)
 
virtual void mouseEnteredRange (MovingRange *range, View *view)
 
virtual void mouseExitedRange (MovingRange *range, View *view)
 
virtual void rangeEmpty (MovingRange *range)
 
virtual void rangeInvalid (MovingRange *range)
 

Detailed Description

A class which provides notifications of state changes to a MovingRange.

This class provides notifications of changes to the position or contents of a MovingRange.

Before destruction, you must unregister the feedback class from any range using it.

Author
Christoph Cullmann <cullm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>
Since
4.5

Definition at line 35 of file movingrangefeedback.h.

Constructor & Destructor Documentation

◆ MovingRangeFeedback()

MovingRangeFeedback::MovingRangeFeedback ( )
default

Default constructor.

◆ ~MovingRangeFeedback()

MovingRangeFeedback::~MovingRangeFeedback ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ caretEnteredRange()

void MovingRangeFeedback::caretEnteredRange ( MovingRange * range,
View * view )
virtual

The caret on view entered range.

Parameters
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

Definition at line 193 of file movingapi.cpp.

◆ caretExitedRange()

void MovingRangeFeedback::caretExitedRange ( MovingRange * range,
View * view )
virtual

The caret on view exited range.

Parameters
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

Definition at line 197 of file movingapi.cpp.

◆ mouseEnteredRange()

void MovingRangeFeedback::mouseEnteredRange ( MovingRange * range,
View * view )
virtual

The mouse cursor on view entered range.

Parameters
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

Definition at line 185 of file movingapi.cpp.

◆ mouseExitedRange()

void MovingRangeFeedback::mouseExitedRange ( MovingRange * range,
View * view )
virtual

The mouse cursor on view exited range.

Parameters
rangepointer to the range which generated the notification.
viewview over which the mouse moved to generate the notification

Definition at line 189 of file movingapi.cpp.

◆ rangeEmpty()

void MovingRangeFeedback::rangeEmpty ( MovingRange * range)
virtual

The range is now empty (ie.

the start and end cursors are the same). If the range has invalidateIfEmpty set, this will never be emitted, but instead rangeInvalid is triggered. You may delete the range inside this method, but don't alter the range here (for example by using setRange).

Parameters
rangepointer to the range which generated the notification.

Reimplemented in KTextEditor::DocumentPrivate.

Definition at line 177 of file movingapi.cpp.

◆ rangeInvalid()

void MovingRangeFeedback::rangeInvalid ( MovingRange * range)
virtual

The range is now invalid (ie.

the start and end cursors are invalid). You may delete the range inside this method, but don't alter the range here (for example by using setRange).

Parameters
rangepointer to the range which generated the notification.

Reimplemented in KTextEditor::DocumentPrivate.

Definition at line 181 of file movingapi.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:01:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.