mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 02:42:48 +00:00
121 lines
3.9 KiB
C++
121 lines
3.9 KiB
C++
/* This file is part of the KDE project
|
|
*
|
|
* Copyright (C) 2010 Christoph Cullmann <cullmann@kde.org>
|
|
*
|
|
* Based on code of the SmartCursor/Range by:
|
|
* Copyright (C) 2003-2005 Hamish Rodda <rodda@kde.org>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public License
|
|
* along with this library; see the file COPYING.LIB. If not, write to
|
|
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef KDELIBS_KTEXTEDITOR_MOVINGRANGEFEEDBACK_H
|
|
#define KDELIBS_KTEXTEDITOR_MOVINGRANGEFEEDBACK_H
|
|
|
|
#include <ktexteditor/ktexteditor_export.h>
|
|
|
|
namespace KTextEditor
|
|
{
|
|
|
|
class View;
|
|
class MovingRange;
|
|
|
|
/**
|
|
* \short A class which provides notifications of state changes to a MovingRange.
|
|
*
|
|
* \ingroup kte_group_moving_classes
|
|
*
|
|
* 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 \<cullmann@kde.org\>
|
|
*
|
|
* \since 4.5
|
|
*/
|
|
class KTEXTEDITOR_EXPORT MovingRangeFeedback
|
|
{
|
|
public:
|
|
/**
|
|
* Default constructor
|
|
*/
|
|
MovingRangeFeedback ();
|
|
|
|
/**
|
|
* Virtual destructor
|
|
*/
|
|
virtual ~MovingRangeFeedback ();
|
|
|
|
/**
|
|
* 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).
|
|
*
|
|
* \param range pointer to the range which generated the notification.
|
|
*/
|
|
virtual void rangeEmpty (MovingRange* range);
|
|
|
|
/**
|
|
* 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).
|
|
*
|
|
* \param range pointer to the range which generated the notification.
|
|
*/
|
|
virtual void rangeInvalid (MovingRange* range);
|
|
|
|
/**
|
|
* The mouse cursor on \a view entered \p range.
|
|
*
|
|
* \param range pointer to the range which generated the notification.
|
|
* \param view view over which the mouse moved to generate the notification
|
|
*/
|
|
virtual void mouseEnteredRange (MovingRange* range, View* view);
|
|
|
|
/**
|
|
* The mouse cursor on \a view exited \p range.
|
|
*
|
|
* \param range pointer to the range which generated the notification.
|
|
* \param view view over which the mouse moved to generate the notification
|
|
*/
|
|
virtual void mouseExitedRange (MovingRange* range, View* view);
|
|
|
|
/**
|
|
* The caret on \a view entered \p range.
|
|
*
|
|
* \param range pointer to the range which generated the notification.
|
|
* \param view view over which the mouse moved to generate the notification
|
|
*/
|
|
virtual void caretEnteredRange (MovingRange* range, View* view);
|
|
|
|
/**
|
|
* The caret on \a view exited \p range.
|
|
*
|
|
* \param range pointer to the range which generated the notification.
|
|
* \param view view over which the mouse moved to generate the notification
|
|
*/
|
|
virtual void caretExitedRange (MovingRange* range, View* view);
|
|
|
|
private:
|
|
/**
|
|
* private d-pointer
|
|
*/
|
|
class MovingRangeFeedbackPrivate * const d;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
// kate: space-indent on; indent-width 2; replace-tabs on;
|