KTextEditor
movingapi.cpp
A Cursor which is bound to a specific Document.
Definition documentcursor.h:56
bool move(int chars, WrapBehavior wrapBehavior=Wrap)
Moves the cursor chars character forward or backwards.
Definition documentcursor.cpp:126
virtual bool isValidTextPosition(KTextEditor::Cursor cursor) const =0
Get whether cursor is a valid text position.
virtual int lineLength(int line) const =0
Get the length of a given line in characters.
virtual Cursor documentEnd() const =0
End position of the document.
A Cursor which is bound to a specific Document, and maintains its position.
Definition movingcursor.h:55
bool atStartOfDocument() const
Determine if this cursor is located at line 0 and column 0.
Definition movingapi.cpp:109
bool move(int chars, WrapBehavior wrapBehavior=Wrap)
Moves the cursor chars character forward or backwards.
Definition movingapi.cpp:138
const Cursor toCursor() const
Convert this clever cursor into a dumb one.
Definition movingcursor.h:266
bool isValid() const
Returns whether the current position of this cursor is a valid position, i.e.
Definition movingcursor.h:159
bool gotoNextLine()
Moves the cursor to the next line and sets the column to 0.
Definition movingapi.cpp:114
virtual Document * document() const =0
Gets the document to which this cursor is bound.
bool gotoPreviousLine()
Moves the cursor to the previous line and sets the column to 0.
Definition movingapi.cpp:126
bool atEndOfLine() const
Determine if this cursor is located at the end of the current line.
Definition movingapi.cpp:99
virtual int column() const =0
Retrieve the column on which this cursor is situated.
bool atEndOfDocument() const
Determine if this cursor is located at the end of the last line in the document.
Definition movingapi.cpp:104
bool isValidTextPosition() const
Check whether this MovingCursor is located at a valid text position.
Definition movingapi.cpp:151
virtual int line() const =0
Retrieve the line on which this cursor is situated.
bool atStartOfLine() const
Determine if this cursor is located at column 0 of a valid text line.
Definition movingapi.cpp:94
virtual void setPosition(KTextEditor::Cursor position)=0
Set the current cursor position to position.
virtual void caretExitedRange(MovingRange *range, View *view)
The caret on view exited range.
Definition movingapi.cpp:197
virtual void mouseEnteredRange(MovingRange *range, View *view)
The mouse cursor on view entered range.
Definition movingapi.cpp:185
virtual void rangeInvalid(MovingRange *range)
The range is now invalid (ie.
Definition movingapi.cpp:181
virtual ~MovingRangeFeedback()
Virtual destructor.
virtual void caretEnteredRange(MovingRange *range, View *view)
The caret on view entered range.
Definition movingapi.cpp:193
virtual void mouseExitedRange(MovingRange *range, View *view)
The mouse cursor on view exited range.
Definition movingapi.cpp:189
A range that is bound to a specific Document, and maintains its position.
Definition movingrange.h:131
virtual const MovingCursor & start() const =0
Retrieve start cursor of this range, read-only.
virtual const MovingCursor & end() const =0
Retrieve end cursor of this range, read-only.
bool contains(const Range &range) const
Check whether the this range wholly encompasses range.
Definition movingrange.h:422
virtual void setRange(KTextEditor::Range range)=0
Set the range of this range.
bool overlaps(const Range &range) const
Check whether the this range overlaps with range.
Definition movingapi.cpp:29
An object representing a section of text, from one Cursor to another.
Definition include/ktexteditor/range.h:49
constexpr Cursor end() const noexcept
Get the end position of this range.
Definition include/ktexteditor/range.h:163
constexpr Cursor start() const noexcept
Get the start position of this range.
Definition include/ktexteditor/range.h:153
Q_SCRIPTABLE Q_NOREPLY void start()
The KTextEditor namespace contains all the public API that is required to use the KTextEditor compone...
Definition katetextblock.h:18
KTEXTEDITOR_EXPORT QDebug operator<<(QDebug s, const MovingCursor *cursor)
qDebug() stream operator.
Definition movingapi.cpp:156
QDebug & nospace()
QDebug & space()
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:05:18 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:05:18 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.