Editor/com.darkrockstudios.texteditor/TextEditorRange

TextEditorRange

data class TextEditorRange(val start: CharLineOffset, val end: CharLineOffset)(source)

A region of the document from start (inclusive) to end (exclusive), the unit used for selections, edits, and rich spans. Build one from two CharLineOffsets with fromOffsets or CharLineOffset.toRange, which order the endpoints for you.

Constructors

TextEditorRange

constructor(start: CharLineOffset, end: CharLineOffset)

Types

Companion

object Companion

Properties

end

val end: CharLineOffset

start

val start: CharLineOffset

Functions

affectedLines

fun affectedLines(): IntRange

Returns an IntRange representing the line numbers that this TextEditorRange spans.

fun affectedLines(buffer: Int, maxLines: Int): IntRange

Returns an IntRange representing the line numbers that this TextEditorRange spans, with an optional buffer of additional lines on either side.

affectedLineWraps

fun affectedLineWraps(state: TextEditorState): IntRange

Returns an IntRange representing the line wrap numbers that this TextEditorRange spans.

containsLine

fun containsLine(lineIndex: Int): Boolean

True if lineIndex falls within the lines this range covers.

intersects

fun intersects(other: TextEditorRange): Boolean

True if this range and other overlap by at least one position.

isSingleLine

fun isSingleLine(): Boolean

True if the range begins and ends on the same line.

merge

fun merge(other: TextEditorRange): TextEditorRange

Returns the smallest range that covers both this range and other.

validate

fun validate(): Boolean

True if end is strictly after start (i.e. the range is non-empty and well-ordered).