Raxol.Terminal.Cursor.Style behaviour (Raxol v2.0.1)
View SourceHandles cursor style and visibility control for the terminal emulator.
This module provides functions for changing cursor appearance, controlling visibility, and managing cursor blinking.
Summary
Functions
Makes the cursor blink.
Gets the current cursor blink mode.
Gets the current cursor state.
Gets the current cursor style.
Hides the cursor.
Sets the cursor style to bar.
Sets the cursor blink rate in milliseconds.
Sets the cursor style to block.
Sets a custom cursor shape.
Sets the cursor style to underline.
Makes the cursor visible.
Toggles the cursor blinking state.
Toggles the cursor visibility.
Updates the cursor blink state and returns the updated cursor and visibility.
Callbacks
@callback blink(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback get_blink(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: boolean()
@callback get_state(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: atom()
@callback get_style(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: atom()
@callback hide(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback set_bar(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback set_blink_rate( cursor :: Raxol.Terminal.Cursor.Manager.t(), rate :: integer() ) :: Raxol.Terminal.Cursor.Manager.t()
@callback set_block(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback set_custom( cursor :: Raxol.Terminal.Cursor.Manager.t(), shape :: atom(), dimensions :: map() ) :: Raxol.Terminal.Cursor.Manager.t()
@callback set_underline(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback show(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback toggle_blink(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback toggle_visibility(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: Raxol.Terminal.Cursor.Manager.t()
@callback update_blink(cursor :: Raxol.Terminal.Cursor.Manager.t()) :: {Raxol.Terminal.Cursor.Manager.t(), boolean()}
Functions
Makes the cursor blink.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.blink(cursor)
iex> cursor.state
:blinkingGets the current cursor blink mode.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> Style.get_blink(cursor)
trueGets the current cursor state.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> Style.get_state(cursor)
:visibleGets the current cursor style.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> Style.get_style(cursor)
:blockHides the cursor.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.hide(cursor)
iex> cursor.state
:hiddenSets the cursor style to bar.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.set_bar(cursor)
iex> cursor.style
:barSets the cursor blink rate in milliseconds.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.set_blink_rate(cursor, 1000)
iex> cursor.blink_rate
1000Sets the cursor style to block.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.set_block(cursor)
iex> cursor.style
:blockSets a custom cursor shape.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.set_custom(cursor, "█", {2, 1})
iex> cursor.style
:custom
iex> cursor.custom_shape
"█"Sets the cursor style to underline.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.set_underline(cursor)
iex> cursor.style
:underlineMakes the cursor visible.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Manager.set_state(cursor, :hidden)
iex> cursor = Style.show(cursor)
iex> cursor.state
:visibleToggles the cursor blinking state.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.toggle_blink(cursor)
iex> cursor.state
:blinking
iex> cursor = Style.toggle_blink(cursor)
iex> cursor.state
:visibleToggles the cursor visibility.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.toggle_visibility(cursor)
iex> cursor.state
:hidden
iex> cursor = Style.toggle_visibility(cursor)
iex> cursor.state
:visibleUpdates the cursor blink state and returns the updated cursor and visibility.
Examples
iex> alias Raxol.Terminal.Cursor.{Manager, Style}
iex> cursor = Manager.new()
iex> cursor = Style.blink(cursor)
iex> {_cursor, visible} = Style.update_blink(cursor)
iex> is_boolean(visible)
true