class
Opal::UI::Window
- Opal::UI::Window
- Opal::UI::Control
- Opal::UI::Element
- Reference
- Object
Overview
Movable, resizable floating window container with title bar, minimize/maximize/close buttons, drop shadow depth, and strict client area content clipping.
Defined in:
opal/ui/components/window.crConstructors
Instance Method Summary
- #active=(active : Bool)
- #active? : Bool
- #active_border_fg : Color | Nil
- #active_border_fg=(active_border_fg : Color | Nil)
- #bg : Color | Nil
- #bg=(bg : Color | Nil)
- #border : Border | Nil
- #border=(border : Border | Nil)
- #border_fg : Color | Nil
- #border_fg=(border_fg : Color | Nil)
- #closable=(closable : Bool)
- #closable? : Bool
-
#close : self
Closes the window and triggers callback
- #close_glyph : String | Nil
- #close_glyph=(close_glyph : String | Nil)
- #content : Element | Nil
- #content=(content : Element | Nil)
- #drag_border_fg : Color | Nil
- #drag_border_fg=(drag_border_fg : Color | Nil)
- #dragging? : Bool
-
#handle_mouse(event : Terminal::MouseEvent) : Bool
Default mouse event handler.
- #height : Int32
- #height=(height : Int32)
- #inactive_border_fg : Color | Nil
- #inactive_border_fg=(inactive_border_fg : Color | Nil)
- #maximizable=(maximizable : Bool)
- #maximizable? : Bool
- #maximize!(max_w : Int32 = 80, max_h : Int32 = 24) : self
- #maximize_glyph : String | Nil
- #maximize_glyph=(maximize_glyph : String | Nil)
- #maximized=(maximized : Bool)
- #maximized? : Bool
- #min_height : Int32
- #min_height=(min_height : Int32)
- #min_width : Int32
- #min_width=(min_width : Int32)
- #minimizable=(minimizable : Bool)
- #minimizable? : Bool
- #minimize! : self
- #minimize_glyph : String | Nil
- #minimize_glyph=(minimize_glyph : String | Nil)
- #minimized=(minimized : Bool)
- #minimized? : Bool
- #on_close : Proc(Window, Nil) | Nil
- #on_close=(on_close : Proc(Window, Nil) | Nil)
-
#on_drag : Proc(Window, Int32, Int32, Nil) | Nil
Drag and resize callbacks
- #on_drag(&block : Window, Int32, Int32 -> Nil) : self
-
#on_drag=(on_drag : Proc(Window, Int32, Int32, Nil) | Nil)
Drag and resize callbacks
- #on_maximize : Proc(Window, Nil) | Nil
- #on_maximize=(on_maximize : Proc(Window, Nil) | Nil)
- #on_minimize : Proc(Window, Nil) | Nil
- #on_minimize=(on_minimize : Proc(Window, Nil) | Nil)
- #on_resize : Proc(Window, Int32, Int32, Nil) | Nil
- #on_resize(&block : Window, Int32, Int32 -> Nil) : self
- #on_resize=(on_resize : Proc(Window, Int32, Int32, Nil) | Nil)
- #preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)
- #render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil
- #resizable=(resizable : Bool)
- #resizable? : Bool
- #resize_border_fg : Color | Nil
- #resize_border_fg=(resize_border_fg : Color | Nil)
- #resize_glyph : Char | Nil
- #resize_glyph=(resize_glyph : Char | Nil)
- #resize_handle_fg : Color | Nil
- #resize_handle_fg=(resize_handle_fg : Color | Nil)
- #resizing? : Bool
- #restore!(max_w : Int32 = 80, max_h : Int32 = 24) : self
- #shadow_char : Char | Nil
- #shadow_char=(shadow_char : Char | Nil)
- #shadow_fg : Color | Nil
- #shadow_fg=(shadow_fg : Color | Nil)
- #title : String
- #title=(title : String)
-
#title_fg : Color | Nil
Manipulable theme styling and character swaps
-
#title_fg=(title_fg : Color | Nil)
Manipulable theme styling and character swaps
-
#toggle_maximize(max_w : Int32 = 80, max_h : Int32 = 24) : self
Toggles window maximize state
-
#toggle_minimize : self
Toggles window minimize state
- #width : Int32
- #width=(width : Int32)
- #x : Int32
- #x=(x : Int32)
- #y : Int32
- #y=(y : Int32)
Constructor methods inherited from class Opal::UI::Control
new
new
Instance methods inherited from module Opal::UI::InputHookable
custom_inputs=(custom_inputs : Bool)
custom_inputs=,
custom_inputs? : Bool
custom_inputs?,
default_input_proc : Proc(InputEvent, Bool) | Nil
default_input_proc,
default_input_proc=(default_input_proc : Proc(InputEvent, Bool) | Nil)
default_input_proc=,
fallback_to_defaults!(enabled : Bool = true) : self
fallback_to_defaults!,
fallback_to_defaults=(fallback_to_defaults : Bool)
fallback_to_defaults=,
fallback_to_defaults? : Bool
fallback_to_defaults?,
focus : self
focus,
focused=(focused : Bool)
focused=,
focused? : Bool
focused?,
handle_default_input(event : InputEvent) : Bool
handle_default_input,
handle_input(event : InputEvent) : Bool
handle_input,
handle_key(key : Terminal::KeyEvent) : Bool
handle_key,
handle_mouse(event : Terminal::MouseEvent) : Bool
handle_mouse,
input_hook : Proc(InputEvent, Bool) | Nil
input_hook,
input_hook=(input_hook : Proc(InputEvent, Bool) | Nil)
input_hook=,
on_input(&block : self, InputEvent -> Bool) : self
on_input,
puppet(&block : self, InputEvent -> Bool) : self
puppet,
reset_inputs : self
reset_inputs,
setup_default_inputs : Nil
setup_default_inputs,
unfocus : self
unfocus,
use_custom_inputs!(enabled : Bool = true) : self
use_custom_inputs!
Instance methods inherited from class Opal::UI::Element
add_class(name : String) : self
add_class,
children : Array(Element)
children,
classes : Set(String)
classes,
classes=(classes : Set(String))
classes=,
has_class?(name : String) : Bool
has_class?,
id : String | Nil
id,
id=(id : String | Nil)
id=,
preferred_print_size(available_w : Int32) : Tuple(Int32, Int32)
preferred_print_size,
preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)
preferred_size,
print(io : IO = STDOUT, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil
print,
query(selector : String) : Array(Element)query(klass : T.class) : Array(T) forall T query, query_one(selector : String) : Element
query_one(klass : T.class) : T forall T query_one, query_one?(selector : String) : Element | Nil
query_one?(klass : T.class) : T | Nil forall T query_one?, remove_class(name : String) : self remove_class, render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil render, render_print(buffer : Buffer, width : Int32, height : Int32) : Nil render_print, to_print_s(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_print_s, to_string(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_string
Instance methods inherited from module Opal::UI::Themable
current_theme : Theme
current_theme,
style(&block : self -> Nil) : self
style,
theme : Theme | Nil
theme,
theme=(theme : Theme | Nil)
theme=,
with_theme(new_theme : Theme | Symbol | String) : self
with_theme
Constructor Detail
def self.new(title : String, x : Int32 = 2, y : Int32 = 2, width : Int32 = 40, height : Int32 = 12, min_width : Int32 = 18, min_height : Int32 = 5, closable : Bool = true, minimizable : Bool = true, maximizable : Bool = true, resizable : Bool = true, content : Element | Nil = nil, on_close : Proc(Window, Nil) | Nil = nil, title_fg : Color | Symbol | String | Nil = nil, border_fg : Color | Symbol | String | Nil = nil, active_border_fg : Color | Symbol | String | Nil = nil, inactive_border_fg : Color | Symbol | String | Nil = nil, bg : Color | Symbol | String | Nil = nil, border : Border | Symbol | String | Nil = nil, close_glyph : String | Nil = nil, maximize_glyph : String | Nil = nil, minimize_glyph : String | Nil = nil, resize_glyph : Char | Nil = nil)
#
Instance Method Detail
def handle_mouse(event : Terminal::MouseEvent) : Bool
#
Description copied from module Opal::UI::InputHookable
Default mouse event handler. Override in subclasses if not using @default_input_proc.
Drag and resize callbacks
Toggles window maximize state