KTextEditor::MovingRange* range = yourDocument->newMovingRange();

void printText(const std::string & text); // this is line 3

KTextEditor::View * view = ...;
KTextEditor::Document * doc = view->document();

// range is of type KTextEditor::MovingRange*
auto range = doc->newMovingRange(KTextEditor::Range(3, 5, 3, 14));

KTextEditor::Attribute::Ptr attrib = new KTextEditor::Attribute();
attrib->setBackground(Qt::yellow);

range->setAttribute(attrib);

Member Function Documentation

[protected] MovingRange::MovingRange()

For inherited class only.

MovingRange::MovingRange(const KTextEditor::MovingRange &)

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

[virtual noexcept] MovingRange::~MovingRange()

Destruct the moving range.

[pure virtual] const KTextEditor::Attribute::Ptr &MovingRange::attribute() const

Gets the active Attribute for this range.

Returns a pointer to the active attribute

See also setAttribute().

[pure virtual] bool MovingRange::attributeOnlyForViews() const

Is this range's attribute only visible in views, not for example prints? Default is false. Returns range visible only for views

See also setAttributeOnlyForViews().

bool MovingRange::contains(KTextEditor::Cursor cursor) const

Check to see if cursor is contained within this range, ie >= start() and < end().

cursor is the position to test for containment

Returns true if the cursor is contained within this range, otherwise false.

bool MovingRange::contains(const KTextEditor::Range &range) const

Check whether the this range wholly encompasses range.

range is the range to check

Returns true, if this range contains range, otherwise false

bool MovingRange::containsColumn(int column) const

Check whether the range contains column.

column is the column to check

Returns true if the range contains column, otherwise false

bool MovingRange::containsLine(int line) const

Returns true if this range wholly encompasses line.

line is the line to check

Returns true if the line is wholly encompassed by this range, otherwise false.

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

Gets the document to which this range is bound.

Returns a pointer to the document

[pure virtual] KTextEditor::MovingRange::EmptyBehavior MovingRange::emptyBehavior() const

Will this range invalidate itself if it becomes empty? Returns behavior on becoming empty

See also setEmptyBehavior().

[pure virtual] const KTextEditor::MovingCursor &MovingRange::end() const

Retrieve end cursor of this range, read-only. Returns end cursor

[pure virtual] KTextEditor::MovingRangeFeedback *MovingRange::feedback() const

Gets the active MovingRangeFeedback for this range.

Returns a pointer to the active MovingRangeFeedback

See also setFeedback().

[pure virtual] KTextEditor::MovingRange::InsertBehaviors MovingRange::insertBehaviors() const

Get current insert behaviors. Returns current insert behaviors

See also setInsertBehaviors().

bool MovingRange::isEmpty() const

Returns true if this range contains no characters, ie. the start() and end() positions are the same.

Returns true if the range contains no characters, otherwise false

[noexcept] int MovingRange::numberOfLines() const

Returns the number of lines separating the start() and end() positions.

Returns the number of lines separating the start() and end() positions; 0 if the start and end lines are the same.

bool MovingRange::onSingleLine() const

Check whether the start() and end() cursors of this range are on the same line.

Returns true if both the start and end positions are on the same line, otherwise false

bool MovingRange::overlaps(const KTextEditor::Range &range) const

Check whether the this range overlaps with range.

range is the range to check against

Returns true, if this range overlaps with range, otherwise false

bool MovingRange::overlapsColumn(int column) const

Check to see if this range overlaps column; that is, if column is between start().column() and end().column(). This function is most likely to be useful in relation to block text editing.

column is the column to test

Returns true if the column is between the range's starting and ending columns, otherwise false.

bool MovingRange::overlapsLine(int line) const

Check whether the range overlaps at least part of line.

line is the line to check

Returns true, if the range overlaps at least part of line, otherwise false

[pure virtual] void MovingRange::setAttribute(KTextEditor::Attribute::Ptr attribute)

Sets the currently active attribute for this range. This will trigger update of the relevant view parts, if the attribute changed.

attribute is the attribute to assign to this range. If null, simply removes the previous Attribute.

See also attribute().

[pure virtual] void MovingRange::setAttributeOnlyForViews(bool onlyForViews)

Set if this range's attribute is only visible in views, not for example prints.

onlyForViews if true, the attribute is only valid for views

See also attributeOnlyForViews().

[pure virtual] void MovingRange::setEmptyBehavior(KTextEditor::MovingRange::EmptyBehavior emptyBehavior)

Set if this range will invalidate itself if it becomes empty.

emptyBehavior is the behavior on becoming empty

See also emptyBehavior().

[pure virtual] void MovingRange::setFeedback(KTextEditor::MovingRangeFeedback *feedback)

Sets the currently active MovingRangeFeedback for this range. This will trigger evaluation if feedback must be send again (for example if mouse is already inside range).

feedback is the MovingRangeFeedback to assign to this range. If null, simply removes the previous MovingRangeFeedback.

See also feedback().

[pure virtual] void MovingRange::setInsertBehaviors(KTextEditor::MovingRange::InsertBehaviors insertBehaviors)

Set insert behaviors.

insertBehaviors are the new insert behaviors

See also insertBehaviors().

[pure virtual] void MovingRange::setRange(KTextEditor::Range range)

Set the range of this range.

A TextRange is not allowed to be empty, as soon as start == end position, it will become automatically invalid!

range new range for this clever range

[pure virtual, since 6.0] void MovingRange::setRange(KTextEditor::Range range, KTextEditor::Attribute::Ptr attribute)

Set the range of this range and the connected attribute. Avoids internal overhead of separate setting that.

A TextRange is not allowed to be empty, as soon as start == end position, it will become automatically invalid!

range is the new range for this clever range

attribute is the attribute to assign to this range. If null, simply removes the previous Attribute.

This function was introduced in 6.0.

[pure virtual, since 6.0] void MovingRange::setRange(KTextEditor::Range range, KTextEditor::Attribute::Ptr attribute, qreal zDepth)

Set the range of this range and the connected attribute and Z-depth. Avoids internal overhead of separate setting that.

A TextRange is not allowed to be empty, as soon as start == end position, it will become automatically invalid!

range is the new range for this clever range

attribute is the attribute to assign to this range. If null, simply removes the previous Attribute.

zDepth is the new Z-depth of this range

This function was introduced in 6.0.

void MovingRange::setRange(KTextEditor::Cursor start, KTextEditor::Cursor end)

This is an overloaded function.

Set the range of this range A TextRange is not allowed to be empty, as soon as start == end position, it will become automatically invalid!

start is the new start for this clever range

end is the new end for this clever range

[pure virtual] void MovingRange::setView(KTextEditor::View *view)

Sets the currently active view for this range. This will trigger update of the relevant view parts, if the view changed. Set view before the attribute, that will avoid not needed redraws.

view is the View to assign to this range. If null, simply removes the previous view.

See also view().

[pure virtual] void MovingRange::setZDepth(qreal zDepth)

Set the current Z-depth of this range. Ranges with smaller Z-depth than others will win during rendering. This will trigger update of the relevant view parts, if the depth changed. Set depth before the attribute, that will avoid not needed redraws. Default is 0.0.

zDepth is new Z-depth of this range

See also zDepth().

[pure virtual] const KTextEditor::MovingCursor &MovingRange::start() const

Retrieve start cursor of this range, read-only. Returns start cursor

[noexcept] KTextEditor::LineRange MovingRange::toLineRange() const

Convert this MovingRange to a simple LineRange. Returns LineRange from the start line to the end line of this range.

const KTextEditor::Range MovingRange::toRange() const

Convert this clever range into a dumb one. Returns normal range

[pure virtual] KTextEditor::View *MovingRange::view() const

Gets the active view for this range. Might be already invalid, internally only used for pointer comparisons.

Returns a pointer to the active view

See also setView().

[pure virtual] qreal MovingRange::zDepth() const

Gets the current Z-depth of this range. Ranges with smaller Z-depth than others will win during rendering. Default is 0.0.

Defined depths for common kind of ranges use in editor components implementing this interface, smaller depths are more more in the foreground and will win during rendering:

• Selection == -100000.0
• Search == -10000.0
• Bracket Highlighting == -1000.0
• Folding Hover == -100.0

Returns current Z-depth of this range

See also setZDepth().

KTextEditor::Range MovingRange::operator KTextEditor::Range() const

Convert this clever range into a dumb one. Equal to toRange, allowing to use implicit conversion. Returns normal range

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

no assignment operator, no copying around clever ranges.