// Retrieve the MovingInterface
KTextEditor::MovingInterface* moving =
    qobject_cast<KTextEditor::MovingInterface*>( yourDocument );

if ( moving ) {
    KTextEditor::MovingCursor* cursor = moving->newMovingCursor();
}

Member Function Documentation

[protected] MovingCursor::MovingCursor()

For inherited class only.

MovingCursor::MovingCursor(const KTextEditor::MovingCursor &)

no copy constructor, don't allow this to be copied.

[virtual noexcept] MovingCursor::~MovingCursor()

Destruct the moving cursor.

bool MovingCursor::atEndOfDocument() const

Determine if this cursor is located at the end of the last line in the document.

Returns true if the cursor is at the end of the document, otherwise false.

bool MovingCursor::atEndOfLine() const

Determine if this cursor is located at the end of the current line.

Returns true if the cursor is situated at the end of the line, otherwise false.

bool MovingCursor::atStartOfDocument() const

Determine if this cursor is located at line 0 and column 0.

Returns true if the cursor is at start of the document, otherwise false.

bool MovingCursor::atStartOfLine() const

Determine if this cursor is located at column 0 of a valid text line.

Returns true if cursor is a valid text position and column()=0, otherwise false.

[pure virtual] int MovingCursor::column() const

Retrieve the column on which this cursor is situated.

Returns column number, where 0 is the first column.

See also setColumn().

[pure virtual] KTextEditor::Document *MovingCursor::document() const

Gets the document to which this cursor is bound.

Returns a pointer to the document

bool MovingCursor::gotoNextLine()

Moves the cursor to the next line and sets the column to 0. If the cursor position is already in the last line of the document, the cursor position remains unchanged and the return value is false.

Returns true on success, otherwise false

bool MovingCursor::gotoPreviousLine()

Moves the cursor to the previous line and sets the column to 0. If the cursor position is already in line 0, the cursor position remains unchanged and the return value is false.

Returns true on success, otherwise false

[pure virtual] KTextEditor::MovingCursor::InsertBehavior MovingCursor::insertBehavior() const

Get current insert behavior. Returns current insert behavior

See also setInsertBehavior().

bool MovingCursor::isValid() const

Returns whether the current position of this cursor is a valid position, i.e. whether line() >= 0 and column() >= 0.

Returns true , if the cursor position is valid, otherwise false

bool MovingCursor::isValidTextPosition() const

Check whether this MovingCursor is located at a valid text position.

A cursor position at (line, column) is valid, if:

• line >= 0 and line < document()->lines() holds, and
• column >= 0 and column <= lineLength(column).

Further, the text position is also invalid if it is inside a Unicode surrogate (utf-32 character).

Returns true, if the cursor is a valid text position, otherwise false

See also Document::isValidTextPosition().

[pure virtual] int MovingCursor::line() const

Retrieve the line on which this cursor is situated.

Returns line number, where 0 is the first line.

See also setLine().

bool MovingCursor::move(int chars, KTextEditor::MovingCursor::WrapBehavior wrapBehavior = Wrap)

Moves the cursor chars character forward or backwards. If wrapBehavior equals WrapBehavior::Wrap, the cursor is automatically wrapped to the next line at the end of a line.

When moving backwards, the WrapBehavior does not have any effect.

Returns true on success, otherwise false

[pure virtual] KTextEditor::MovingRange *MovingCursor::range() const

Get range this cursor belongs to, if any Returns range this pointer is part of, else 0

void MovingCursor::setColumn(int column)

Set the cursor column to column.

column is the new cursor column

See also column().

[pure virtual] void MovingCursor::setInsertBehavior(KTextEditor::MovingCursor::InsertBehavior insertBehavior)

Set insert behavior.

insertBehavior is the new insert behavior

See also insertBehavior().

void MovingCursor::setLine(int line)

Set the cursor line to line.

line is the new cursor line

See also line().

[pure virtual] void MovingCursor::setPosition(KTextEditor::Cursor position)

Set the current cursor position to position.

position is the new cursor position

void MovingCursor::setPosition(int line, int column)

This is an overloaded function.

Set the cursor position to line and column.

line is the new cursor line

column is the new cursor column

const KTextEditor::Cursor MovingCursor::toCursor() const

Convert this clever cursor into a dumb one. Even if this cursor belongs to a range, the created one not. Returns normal cursor

KTextEditor::Cursor MovingCursor::operator KTextEditor::Cursor() const

Convert this clever cursor into a dumb one. Equal to toCursor, allowing to use implicit conversion. Even if this cursor belongs to a range, the created one not. Returns normal cursor

KTextEditor::MovingCursor &MovingCursor::operator=(const KTextEditor::MovingCursor &)

no assignment operator, no copying around clever cursors.