class

Term2::Components::Cursor

Inherits Term2::Model < Reference < Object

Constructors

new

Class methods

blink

Blink is a command used to initialize cursor blinking.

Instance methods

blink

Cursor Blink state (true = visible/hidden depending on logic, effectively "on" cycle) In Go: Blink bool. In Crystal we use this for visibility toggle.

blink=(blink : Bool)

Cursor Blink state (true = visible/hidden depending on logic, effectively "on" cycle) In Go: Blink bool. In Crystal we use this for visibility toggle.

blink?

blink_cmd

BlinkCmd is a command used to manage cursor blinking.

blink_speed

blink_speed=(blink_speed : Time::Span)

blur

Blur blurs the cursor.

char

char is the character under the cursor

char=(char : String)

char is the character under the cursor

focus

Focus focuses the cursor to allow it to blink if desired.

focus=(focus : Bool)

focus indicates whether the containing input is focused

focus?

focus indicates whether the containing input is focused

focus_cmd

id

The ID of this Model as it relates to other cursors (usually 0 unless multiple cursors managed)

id=(id : Int32)

The ID of this Model as it relates to other cursors (usually 0 unless multiple cursors managed)

init

Init is the first function that will be called. It returns an optional initial command. To not perform an initial command return nil.

mode

mode determines the behavior of the cursor

mode=(mode : Mode)

mode determines the behavior of the cursor

set_char(char : String)

SetChar sets the character under the cursor.

set_mode(mode : Mode) : Cmd

SetMode sets the model's cursor mode. This method returns a command.

style

style=(style : Style)

text_style

text_style=(text_style : Style)

update(msg : Msg) : Tuple(Cursor, Cmd)

Update updates the cursor.

view

View displays the cursor.

Nested types