Anansi v0.0.3 Anansi.Cursor

ANSI escape codes that manipulate the terminal cursor.

ANSI treats the cursor co-ordinates as positive integers of format {row in 1..∞, col in 1..∞}.

It will ignore requests to move the cursor beyond the bounds of the terminal window.

Summary

Functions

back()

Moves cursor left

back(amount)

Moves cursor left by amount

backward()

Moves cursor left

backward(amount)

Moves cursor left by amount

backwards()

Moves cursor left

backwards(amount)

Moves cursor left by amount

col(col)

Move cursor to col of the current row

down()

Moves cursor down

down(amount)

Moves cursor down by amount

erase(thing)

Erases entire thing around cursor

erase(thing, way)

Erases thing around the cursor in the specified way

forward()

Moves cursor right

forward(amount)

Moves cursor right by amount

forwards()

Moves cursor right

forwards(amount)

Moves cursor right by amount

hide()

Hides the cursor

home()

Moves cursor to top-left corner of screen ({1, 1})

left()

Moves cursor left

left(amount)

Moves cursor left by amount

move()

Moves cursor forwards

move(direction)

Moves cursor in direction

move(direction, amount)

Moves cursor in direction by amount

next()

Moves cursor right

next(amount)

Moves cursor right by amount

position()

Asks the terminal to report the current cursor position

position(arg)

Move cursor to position {row, col}.

prev()

Moves cursor left

prev(amount)

Moves cursor left by amount

restore()

Moves the cursor to saved position

right()

Moves cursor right

right(amount)

Moves cursor right by amount

row(row)

Move cursor to row of the current column

save()

Saves the cursor position

show()

Shows the cursor

up()

Moves cursor up

up(amount)

Moves cursor up by amount

Functions

back()

Moves cursor left.

back(amount)

Moves cursor left by amount.

backward()

Moves cursor left.

backward(amount)

Moves cursor left by amount.

backwards()

Moves cursor left.

backwards(amount)

Moves cursor left by amount.

col(col)

Move cursor to col of the current row.

down()

Moves cursor down.

down(amount)

Moves cursor down by amount.

erase(thing)

Erases entire thing around cursor.

Supported things: :screen, :line.

Additionally, the thing can be a keyword list of things and ways to erase via erase/2.

erase(thing, way)

Erases thing around the cursor in the specified way.

You can erase :all around the cursor, or just erase to :start or :end of thing.

Supported things: :screen, :line.

forward()

Moves cursor right.

forward(amount)

Moves cursor right by amount.

forwards()

Moves cursor right.

forwards(amount)

Moves cursor right by amount.

hide()

Hides the cursor.

home()

Moves cursor to top-left corner of screen ({1, 1}).

left()

Moves cursor left.

left(amount)

Moves cursor left by amount.

move()

Moves cursor forwards.

move(direction)

Moves cursor in direction.

Allowed directions: :up, :down, :right, or :left.

The :right direction is aliased as :forward, :forwards, and :next.

The :left direction is aliased as :backward, :backwards, :back, and :prev.

Alternatively, the direction can be a keyword list of directions and amounts to move via move/2.

move(direction, amount)

Moves cursor in direction by amount.

Allowed directions: :up, :down, :right, or :left.

The :right direction is aliased as :forward, :forwards, and :next.

The :left direction is aliased as :backward, :backwards, :back, and :prev.

Additionally, the :pos direction will move to a supplied {row, col} location, and the :row and :col directions will set that co-ordinate to amount and the other to 1.

next()

Moves cursor right.

next(amount)

Moves cursor right by amount.

position()

Asks the terminal to report the current cursor position.

Terminal will insert "\e[n;mR" into the input device where n is the row and m the column.

position(arg)

Move cursor to position {row, col}.

prev()

Moves cursor left.

prev(amount)

Moves cursor left by amount.

restore()

Moves the cursor to saved position.

right()

Moves cursor right.

right(amount)

Moves cursor right by amount.

row(row)

Move cursor to row of the current column.

save()

Saves the cursor position.

show()

Shows the cursor.

up()

Moves cursor up.

up(amount)

Moves cursor up by amount.