Class: Tuile::Component::LogWindow

Inherits:
Window show all
Defined in:
lib/tuile/component/log_window.rb

Overview

Shows a log. Construct your logger pointed at a IO to route log lines into this window:

log_window = Tuile::Component::LogWindow.new
logger = Logger.new(Tuile::Component::LogWindow::IO.new(log_window))

Any logger that writes formatted lines to an IO works the same way —for example ‘TTY::Logger` configured with the `:console` handler and `output: LogWindow::IO.new(window)`.

Defined Under Namespace

Classes: IO

Instance Attribute Summary

Attributes inherited from Window

#caption, #footer

Attributes included from HasContent

#content

Attributes inherited from Tuile::Component

#key_shortcut, #parent, #rect

Instance Method Summary collapse

Methods inherited from Window

#children, #content_size, #focusable?, #handle_key, #handle_mouse, #key_shortcut=, #rect=, #repaint, #scrollbar=

Methods included from HasContent

#children, #handle_key, #handle_mouse, #on_focus, #rect=

Methods inherited from Tuile::Component

#active=, #active?, #attached?, #children, #content_size, #cursor_position, #depth, #find_shortcut_component, #focus, #focusable?, #handle_key, #handle_mouse, #keyboard_hint, #on_child_removed, #on_focus, #on_tree, #repaint, #root, #screen, #tab_stop?

Constructor Details

#initialize(caption = "Log") ⇒ LogWindow

Returns a new instance of LogWindow.

Parameters:

  • caption (String) (defaults to: "Log") 


16
17
18
19
20
21
22
23
24
 
# File 'lib/tuile/component/log_window.rb', line 16

def initialize(caption = "Log")
  super
  list = Component::List.new
  list.auto_scroll = true
  # Allow scrolling when a long stacktrace is logged.
  list.cursor = Component::List::Cursor.new
  self.content = list
  self.scrollbar = true
end

Instance Method Details

#log(string) ⇒ void

This method returns an undefined value.

Appends given line to the log. Can be called from any thread. Does nothing if nil is passed in.

Parameters:

  • string (String, nil) —

    the line (or multiple lines) to log.



29
30
31
32
33
34
 
# File 'lib/tuile/component/log_window.rb', line 29

def log(string)
  return if string.nil?
  screen.event_queue.submit do
    content.add_line(string)
  end
end