class

Opal::UI::CodeView

Inherits Opal::UI::Control < Opal::UI::InputHookable < Opal::UI::Element < Opal::UI::Themable < Reference < Object

Code and disassembly viewing element with line numbers, syntax highlighting, cursor indicator, and vertical scrolling.

Constructors

new(code : String = "", language : Symbol | String = :plain, start_line : Int32 = 1, highlighted_line : Int32 | Nil = nil, scroll_offset : Int32 = 0, show_line_numbers : Bool = true, gutter_fg : Color | Symbol | String | Nil = nil, cursor_fg : Color | Symbol | String | Nil = nil, cursor_indicator : String | Nil = nil, scrollable : Bool = true, auto_scroll : Bool = false, scroll_speed : Float64 = 1.0)

Class methods

print(code : String, language : Symbol | String = :plain, show_line_numbers : Bool = true, start_line : Int32 = 1, io : IO = STDOUT, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil

Class convenience method printing styled code directly to IO

to_string(code : String, language : Symbol | String = :plain, show_line_numbers : Bool = true, start_line : Int32 = 1, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String

Class convenience method returning styled code string

Instance methods

auto_scroll=(auto_scroll : Bool)

auto_scroll?

code

code=(code : String)

cursor_fg

cursor_fg=(cursor_fg : Color | Nil)

cursor_indicator

cursor_indicator=(cursor_indicator : String | Nil)

gutter_fg

gutter_fg=(gutter_fg : Color | Nil)

handle_key(event : Terminal::KeyEvent) : Bool

Default key event handler. Override in subclasses if not using @default_input_proc.

handle_mouse(event : Terminal::MouseEvent) : Bool

Default mouse event handler. Override in subclasses if not using @default_input_proc.

highlighted_line

highlighted_line=(highlighted_line : Int32 | Nil)

language

language=(language : Symbol)

lines

preferred_print_size(available_w : Int32) : Tuple(Int32, Int32)

Preferred size in print mode: full line count

preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)

render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil

render_print(buffer : Buffer, width : Int32, height : Int32) : Nil

Render hook for print mode: resets scroll offset

scroll_down(count : Int32 = 1) : Nil

scroll_offset

scroll_offset=(scroll_offset : Int32)

scroll_speed

scroll_speed=(scroll_speed : Float64)

scroll_up(count : Int32 = 1) : Nil

scrollable=(scrollable : Bool)

scrollable?

show_line_numbers=(show_line_numbers : Bool)

show_line_numbers?

start_line

start_line=(start_line : Int32)

tick(dt : Float64 = 0.0166) : Nil