abstract class Opal::Terminal::Driver

• Opal::Terminal::Driver
• Reference
• Object

Overview

Abstract base interface for terminal input/output drivers.

Direct Known Subclasses

• Opal::Asciicast::Driver
• Opal::Terminal::MockDriver
• Opal::Terminal::PosixDriver
• Opal::Terminal::WindowsDriver

Defined in:

opal/terminal/driver.cr

Constructors

• .new(output : IO = STDOUT, input : IO = STDIN)

Instance Method Summary

• #check_resize : ResizeEvent | Nil

  Checks if the terminal window size has changed since last check.

• #clear : Nil
• #disable_mouse : Nil
• #enable_mouse : Nil
• #enter_alternate_screen : Nil
• #exit_alternate_screen : Nil
• #flush : Nil
• #flush_input : Nil

  Flushes any queued input events and purges platform input buffers

• #hide_cursor : Nil
• #input : IO
• #input=(input : IO)
• #move_to(row : Int32, col : Int32) : Nil
• #on_resize : Proc(Int32, Int32, Nil) | Nil
• #on_resize=(on_resize : Proc(Int32, Int32, Nil) | Nil)
• #output : IO
• #output=(output : IO)
• #poll_event(timeout_ms : Int32 = 0) : KeyEvent | MouseEvent | ResizeEvent | Nil

  Non-blocking or timed check for input/resize events.

• #raw_mode(&)
• #read_event : KeyEvent | MouseEvent | ResizeEvent | Nil

  Reads the next key, mouse, or resize event from the terminal, consuming from the internal event queue if multiple events arrived in the same read chunk.

• #show_cursor : Nil
• #size : Tuple(Int32, Int32)
• #write(str : String) : Nil

Constructor Detail

Instance Method Detail