Atom

The Cursor class represents the little blinking line identifying where text can be inserted.

Cursors belong to TextEditors and have some metadata attached in the form of a DisplayMarker.

Calls your callback when the cursor has been moved.

callback(event)

event

.oldBufferPosition

.oldScreenPosition

.newBufferPosition

.newScreenPosition

.textChanged

.cursor

Cursor that triggered the event

Returns a Disposable on which .dispose() can be called to unsubscribe.

Calls your callback when the cursor is destroyed

callback()

Function

Returns a Disposable on which .dispose() can be called to unsubscribe.

Moves a cursor to a given screen position.

screenPosition

Array of two numbers: the screen row, and the screen column.

options

optional

Object with the following keys:

.autoscroll

A Boolean which, if true, scrolls the TextEditor to wherever the cursor moves to.

Returns the screen position of the cursor as a Point.

Moves a cursor to a given buffer position.

bufferPosition

Array of two numbers: the buffer row, and the buffer column.

options

optional

Object with the following keys:

.autoscroll

Boolean indicating whether to autoscroll to the new position. Defaults to true if this is the most recently added cursor, false otherwise.

Returns the current buffer position as an Array.

Returns the cursor's current screen row.

Returns the cursor's current screen column.

Retrieves the cursor's current buffer row.

Returns the cursor's current buffer column.

Returns the cursor's current buffer row of text excluding its line ending.

Returns whether the cursor is at the start of a line.

Returns whether the cursor is on the line return character.

Returns the underlying DisplayMarker for the cursor. Useful with overlay Decorations.

Identifies if the cursor is surrounded by whitespace.

"Surrounded" here means that the character directly before and after the cursor are both whitespace.

Returns a Boolean.

This method returns false if the character before or after the cursor is whitespace.

Returns whether the cursor is currently between a word and non-word character. The non-word characters are defined by the editor.nonWordCharacters config value.

Returns a Boolean.

options

optional

Object

.wordRegex

A RegExp indicating what constitutes a "word" (default: ::wordRegExp).

Returns whether this cursor is between a word's start and end.

Returns a Boolean

Returns the indentation level of the current line.

Retrieves the scope descriptor for the cursor's current position.

Returns a ScopeDescriptor

Returns true if this cursor has no non-whitespace characters before its current position.

Identifies if this cursor is the last in the TextEditor.

"Last" is defined as the most recently added cursor.

Returns a Boolean.

Moves the cursor up one screen row.

rowCount

optional

Number number of rows to move (default: 1)

options

optional

Object with the following keys:

.moveToEndOfSelection

if true, move to the left of the selection if a selection exists.

Moves the cursor down one screen row.

rowCount

optional

Number number of rows to move (default: 1)

options

optional

Object with the following keys:

.moveToEndOfSelection

if true, move to the left of the selection if a selection exists.

Moves the cursor left one screen column.

columnCount

optional

Number number of columns to move (default: 1)

options

optional

Object with the following keys:

.moveToEndOfSelection

if true, move to the left of the selection if a selection exists.

Moves the cursor right one screen column.

columnCount

optional

Number number of columns to move (default: 1)

options

optional

Object with the following keys:

.moveToEndOfSelection

if true, move to the right of the selection if a selection exists.

Moves the cursor to the top of the buffer.

Moves the cursor to the bottom of the buffer.

Moves the cursor to the beginning of the line.

Moves the cursor to the beginning of the buffer line.

Moves the cursor to the beginning of the first character in the line.

Moves the cursor to the end of the line.

Moves the cursor to the end of the buffer line.

Moves the cursor to the beginning of the word.

Moves the cursor to the end of the word.

Moves the cursor to the beginning of the next word.

Moves the cursor to the previous word boundary.

Moves the cursor to the next word boundary.

Moves the cursor to the previous subword boundary.

Moves the cursor to the next subword boundary.

Moves the cursor to the beginning of the buffer line, skipping all whitespace.

Moves the cursor to the beginning of the next paragraph

Moves the cursor to the beginning of the previous paragraph

options

optional

Object with the following keys:

.wordRegex

A RegExp indicating what constitutes a "word" (default: ::wordRegExp)

Returns buffer position of previous word boundary. It might be on the current word, or the previous word.

options

optional

Object with the following keys:

.wordRegex

A RegExp indicating what constitutes a "word" (default: ::wordRegExp)

Returns buffer position of the next word boundary. It might be on the current word, or the previous word.

Retrieves the buffer position of where the current word starts.

options

optional

An Object with the following keys:

.wordRegex

A RegExp indicating what constitutes a "word" (default: ::wordRegExp).

.includeNonWordCharacters

A Boolean indicating whether to include non-word characters in the default word regex. Has no effect if wordRegex is set.

.allowPrevious

A Boolean indicating whether the beginning of the previous word can be returned.

Returns a Range.

Retrieves the buffer position of where the current word ends.

options

optional

Object with the following keys:

.wordRegex

A RegExp indicating what constitutes a "word" (default: ::wordRegExp)

.includeNonWordCharacters

A Boolean indicating whether to include non-word characters in the default word regex. Has no effect if wordRegex is set.

Returns a Range.

Retrieves the buffer position of where the next word starts.

options

optional

Object

.wordRegex

A RegExp indicating what constitutes a "word" (default: ::wordRegExp).

Returns a Range

options

optional

Object

.wordRegex

A RegExp indicating what constitutes a "word" (default: ::wordRegExp).

Returns the buffer Range occupied by the word located under the cursor.

options

optional

Object

.includeNewline

A Boolean which controls whether the Range should include the newline.

Returns the buffer Range for the current line.

Retrieves the range for the current paragraph.

A paragraph is defined as a block of text surrounded by empty lines or comments.

Returns a Range.

Returns the characters preceding the cursor in the current word.

Compare this cursor's buffer position to another cursor's buffer position.

See Point::compare for more details.

otherCursor

Cursor to compare against

Deselects the current selection.

Get the RegExp used by the cursor to determine what a "word" is.

options

optional

Object with the following keys:

.includeNonWordCharacters

A Boolean indicating whether to include non-word characters in the regex. (default: true)

Returns a RegExp.

Get the RegExp used by the cursor to determine what a "subword" is.

options

optional

Object with the following keys:

.backwards

A Boolean indicating whether to look forwards or backwards for the next subword. (default: false)

Returns a RegExp.

Cursor extended

Event Subscription

Managing Cursor Position

Cursor Position Details

Moving the Cursor

Local Positions and Ranges

Comparing to another cursor

Utilities