class
Opal::UI::CharacterGrid
- Opal::UI::CharacterGrid
- Opal::UI::Control
- Opal::UI::Element
- Reference
- Object
Overview
Interactive, highly configurable 2D character grid control. Renders regular horizontal and vertical grid lines with customizable intervals, glyph styles (solid, heavy, double, dashed, dotted, crosses, etc.), major/minor lines, panning offsets, interval scaling (zoom), mouse dragging, and coordinate rulers.
Defined in:
opal/ui/components/character_grid.crConstructors
Instance Method Summary
-
#adjust_interval(d_x : Int32, d_y : Int32) : Nil
Adjusts grid intervals (zoom)
- #bg : Color
- #bg=(bg : Color)
- #border_color : Color
- #border_color=(border_color : Color)
- #border_style : Symbol
- #border_style=(border_style : Symbol)
- #current_style : Graphics::GridStylePreset
- #current_style=(current_style : Graphics::GridStylePreset)
-
#cycle_colors : Nil
Cycles between built-in color palettes
-
#cycle_style : Graphics::GridStylePreset
Cycles through all 10 available presets
- #fg : Color
- #fg=(fg : Color)
- #glyphs : Graphics::GridGlyphs
- #glyphs=(glyphs : Graphics::GridGlyphs)
-
#handle_key(key : Terminal::KeyEvent) : Bool
Default key event handler.
-
#handle_mouse(event : Terminal::MouseEvent) : Bool
Default mouse event handler.
- #height : Int32
- #height=(height : Int32)
- #initial_interval_x : Int32
- #initial_interval_x=(initial_interval_x : Int32)
- #initial_interval_y : Int32
- #initial_interval_y=(initial_interval_y : Int32)
- #intersection_fg : Color | Nil
- #intersection_fg=(intersection_fg : Color | Nil)
- #interval_x : Int32
- #interval_x=(interval_x : Int32)
- #interval_y : Int32
- #interval_y=(interval_y : Int32)
- #last_h : Int32
- #last_h=(last_h : Int32)
- #last_w : Int32
- #last_w=(last_w : Int32)
- #last_x : Int32
- #last_x=(last_x : Int32)
- #last_y : Int32
- #last_y=(last_y : Int32)
- #major_fg : Color | Nil
- #major_fg=(major_fg : Color | Nil)
- #major_interval_x : Int32 | Nil
- #major_interval_x=(major_interval_x : Int32 | Nil)
- #major_interval_y : Int32 | Nil
- #major_interval_y=(major_interval_y : Int32 | Nil)
- #offset_x : Int32
- #offset_x=(offset_x : Int32)
- #offset_y : Int32
- #offset_y=(offset_y : Int32)
- #on_interval_change : Proc(Int32, Int32, Nil) | Nil
- #on_interval_change=(on_interval_change : Proc(Int32, Int32, Nil) | Nil)
-
#on_pan : Proc(Int32, Int32, Nil) | Nil
Callbacks
-
#on_pan=(on_pan : Proc(Int32, Int32, Nil) | Nil)
Callbacks
- #on_style_change : Proc(Graphics::GridStylePreset, Nil) | Nil
- #on_style_change=(on_style_change : Proc(Graphics::GridStylePreset, Nil) | Nil)
-
#pan(dx : Int32, dy : Int32) : Nil
Pans the grid view by (dx, dy)
- #preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)
- #render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil
- #render(buffer : Buffer) : Nil
-
#reset : Nil
Resets pan offsets and intervals to initial creation values
-
#set_style(preset : Graphics::GridStylePreset | Symbol | String) : Nil
Changes the active grid style preset
- #show_border=(show_border : Bool)
- #show_border? : Bool
- #show_coordinates=(show_coordinates : Bool)
- #show_coordinates? : Bool
- #show_horizontal=(show_horizontal : Bool)
- #show_horizontal? : Bool
- #show_vertical=(show_vertical : Bool)
- #show_vertical? : Bool
- #title : String | Nil
- #title=(title : String | Nil)
- #width : Int32
- #width=(width : 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(interval_x : Int32 = 8, interval_y : Int32 = 4, offset_x : Int32 = 0, offset_y : Int32 = 0, style : Symbol | Graphics::GridStylePreset | Graphics::GridGlyphs = :solid, fg : Color = Color.hex("#6272A4"), bg : Color = Color.none, intersection_fg : Color | Nil = Color.hex("#8BE9FD"), major_interval_x : Int32 | Nil = nil, major_interval_y : Int32 | Nil = nil, major_fg : Color | Nil = Color.hex("#BD93F9"), show_horizontal : Bool = true, show_vertical : Bool = true, show_coordinates : Bool = false, show_border : Bool = true, border_color : Color = Color.hex("#6272A4"), border_style : Symbol = :rounded, title : String | Nil = "Character Grid", width : Int32 | Nil = 30, height : Int32 | Nil = 12)
#
Instance Method Detail
def handle_key(key : Terminal::KeyEvent) : Bool
#
Description copied from module Opal::UI::InputHookable
Default key event handler. Override in subclasses if not using @default_input_proc.
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.
def set_style(preset : Graphics::GridStylePreset | Symbol | String) : Nil
#
Changes the active grid style preset