abstract class
Opal::UI::Control
- Opal::UI::Control
- Opal::UI::Element
- Reference
- Object
Overview
Abstract base class for all interactive, focusable UI components.
Integrates with InputHookable to support custom per-control input hooks,
default input lifecycles, and code puppeting.
Included Modules
Direct Known Subclasses
- Opal::UI::Button
- Opal::UI::CharacterGrid
- Opal::UI::Checkbox
- Opal::UI::CodeView
- Opal::UI::Collapsible
- Opal::UI::ColorPicker
- Opal::UI::ColorPicker3D
- Opal::UI::CommandPalette
- Opal::UI::ContentSwitcher
- Opal::UI::CurveEditor
- Opal::UI::DockContainer
- Opal::UI::Dropdown
- Opal::UI::EquationViewer
- Opal::UI::FileDialog
- Opal::UI::FilterList
- Opal::UI::GridContainer
- Opal::UI::HexViewer
- Opal::UI::InputRemapper
- Opal::UI::Mesh3D
- Opal::UI::Modal
- Opal::UI::Palette
- Opal::UI::RadioSet
- Opal::UI::RichLog
- Opal::UI::Screen
- Opal::UI::ScrollBar
- Opal::UI::Slider
- Opal::UI::Switch
- Opal::UI::Table
- Opal::UI::Tabs
- Opal::UI::TargetSelector2D
- Opal::UI::Tree
- Opal::UI::Window
Defined in:
opal/ui/control.crConstructors
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