module

Tput::Output::Cursor

Inherits Tput::Macros / Crystallabs::Helpers::Boolean / Crystallabs::Helpers::Alias_Methods

Instance methods

char_pos_absolute(param : Int32 | Nil = 1)

CSI Pm ` Character Position Absolute [column] (default = [row,1]) (HPA). TODO switch to adjust_xy

Source

cursor_backward(param = 1)

CSI Ps A Cursor Up Ps Times (default = 1) (CUU).

Source

cursor_backward_tab(param = 1)

CSI Ps Z Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).

Source

cursor_char_absolute(point : Point)

Sets cursor x coordinate to absolute value param.

CSI Ps G
Cursor Character Absolute  [column] (default = [row,1]) (CHA).

Source

cursor_char_absolute(param = 0)

Sets cursor x coordinate to absolute value param.

CSI Ps G
Cursor Character Absolute  [column] (default = [row,1]) (CHA).

Source

cursor_color(color : String)

Sets cursor color. XTerm, rxvt, and screen specific.

Accepted values are the color names listed in /etc/X11/rgb.txt.

Source

cursor_color(color : Color)

Sets cursor color. XTerm, rxvt, and screen specific.

Accepted values are the color names listed in /etc/X11/rgb.txt.

Source

cursor_down(param = 1)

CSI Ps A Cursor Up Ps Times (default = 1) (CUU).

Source

cursor_forward(param : Int = 1)

Cursor forward. CSI Ps C Cursor Forward Ps Times (default = 1) (CUF).

Source

cursor_forward_tab(param = 1)

CSI Ps I Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).

Source

cursor_line_absolute(point : Point)

Sets cursor y coordinate to absolute value param.

CSI Pm d
Line Position Absolute  [row] (default = [1,column]) (VPA).

NOTE: Can't find in terminfo, no idea why it has multiple params (Pm).

Source

cursor_line_absolute(param = 1)

Source

cursor_next_line(param = 1)

CSI Ps E Cursor Next Line Ps Times (default = 1) (CNL). same as CSI Ps B ?

Source

cursor_position(row : Int = 0, column : Int = 0)

Set cursor position. CSI Ps ; Ps H Cursor Position [row;column] (default = [1,1]) (CUP).

Source

cursor_position(point : Tput::Point)

Set cursor position. CSI Ps ; Ps H Cursor Position [row;column] (default = [1,1]) (CUP).

Source

cursor_preceding_line(param = 1)

CSI Ps F Cursor Preceding Line Ps Times (default = 1) (CNL). reuse CSI Ps A ?

Source

cursor_shape(shape, blink = false)

Sets cursor shape.

Only XTerm, (u)rxvt, screen, and iTerm2. Does nothing otherwise. If you know of any others, post them.

Source

cursor_up(param = 1)

CSI Ps A Cursor Up Ps Times (default = 1) (CUU).

Source

dynamic_cursor_color(param)

OSC Ps ; Pt ST OSC Ps ; Pt BEL Change dynamic colors

Source

h_position_relative(param = 1)

141 61 a * HPR - Horizontal Position Relative reuse CSI Ps C ? TODO switch to adjust_xy; how can we put cuf() without adjusting state?

Source

hide_cursor

Source

hv_position(row = 0, col = 0)

CSI Ps ; Ps f Horizontal and Vertical Position [row;column] (default = [1,1]) (HVP). TODO adjust_xy

Source

lrestore_cursor(key = :local, hide = false)

Restore Cursor Locally

Source

lsave_cursor(key = :local)

Save Cursor Locally

Source

move(point : Point)

Moves cursor to desired point by using absolute coordinate instructions

Source

move(x = nil, y = nil)

Moves cursor to desired point by using absolute coordinate instructions

Source

omove(point : Point)

Moves cursor to desired point by using instructions relative to current position

NOTE fix cud and cuu calls

Source

omove(x = 0, y = 0)

Moves cursor to desired point by using instructions relative to current position

NOTE fix cud and cuu calls

Source

reset_cursor

Source

reset_cursor_color

OSC Ps ; Pt ST OSC Ps ; Pt BEL Reset colors

Source

restore_cursor(key : String | Nil = nil, hide : Bool = false)

Restore saved cursor position.

ESC 8 Restore Cursor (DECRC).

Source

restore_cursor_a

CSI u Restore cursor (ANSI.SYS).

Source

restore_reported_cursor

Source

rmove(dx, dy)

Move cursor by dx columns and dy rows

Source

rmove(point : Point)

Move cursor by dx columns and dy rows

Source

rsetx(dx)

Move cursor forward or back by dx columns

Source

rsety(dy)

Move cursor forward or back by dy rows

Source

save_cursor(key : String | Nil = nil)

Save cursor position.

ESC 7 Save Cursor (DECSC).

Source

save_cursor_a

CSI s Save cursor (ANSI.SYS).

Source

set_cursor_style(style = CursorStyle::SteadyBlock)

CSI Ps SP q Set cursor style (DECSCUSR, VT520). Ps = 0 -> blinking block. Ps = 1 -> blinking block (default). Ps = 2 -> steady block. Ps = 3 -> blinking underline. Ps = 4 -> steady underline.

Source

show_cursor

Source

v_position_relative(param = 1)

145 65 e * VPR - Vertical Position Relative reuse CSI Ps B ? TODO adjust_xy

Source