class Crysterm::Widget

• Crysterm::Widget
• Reference
• Object

Included Modules

• Crystallabs::Helpers::Alias_Methods
• Crysterm::Helpers
• Crysterm::Macros
• Crysterm::Mixin::Children
• Crysterm::Mixin::Data
• Crysterm::Mixin::Name
• Crysterm::Mixin::Pos
• Crysterm::Mixin::Style
• Crysterm::Mixin::Uid
• EventHandler

Direct Known Subclasses

• Crysterm::Widget::Box
• Crysterm::Widget::Layout
• Crysterm::Widget::List
• Crysterm::Widget::ListTable
• Crysterm::Widget::Menu

Defined in:

Constant Summary

SGR_REGEX = /\e\[[\d;]*m/

Convenience regex for matching SGR sequences.

SGR_REGEX_AT_BEGINNING = /^#{SGR_REGEX}/

Convenience regex for matching SGR sequences.

TAG_REGEX = /\{(\/?)([\w\-,;!#]*)\}/

Convenience regex for matching Crysterm tags and their content (i.e. '{bold}This text is bold{/bold}').

Constructors

• .new(parent = nil, *, name : Nil | String = @name, screen : Nil | Crysterm::Screen = @screen, left : Int32 | String | Nil = @left, top : Int32 | String | Nil = @top, right : Int32 | Nil = @right, bottom : Int32 | Nil = @bottom, width : Int32 | String | Nil = @width, height : Int32 | String | Nil = @height, resizable : Bool = @resizable, visible = nil, fixed : Bool = @fixed, align : Tput::Namespace::AlignFlag = @align, overflow : Crysterm::Overflow = @overflow, scrollbar : Bool = @scrollbar, track : Bool = @track, content = "", parse_tags : Bool = @parse_tags, wrap_content : Bool = @wrap_content, label = nil, hover_text = nil, scrollable = nil, always_scroll : Bool = @always_scroll, draggable : Bool = @draggable, focused = false, focus_on_click : Bool = @focus_on_click, keys : Bool = @keys, vi : Bool = @vi, input = nil, style = nil, styles : Crysterm::Styles = @styles, index : Int32 = -1, children = [] of Widget)

Class Method Summary

• .sattr(style, fg = nil, bg = nil)

Instance Method Summary

• #_align(line, width, align = Tput::AlignFlag::None, align_left_too = false)

  Aligns content

• #_clines : Crysterm::Widget::CLines
• #_clines=(_clines : Crysterm::Widget::CLines)
• #_get_coords(get = false, noscroll = false)
• #_is_list : Bool

  XXX FIX by removing at some point Used only for lists.

• #_is_list=(_is_list : Bool)

  XXX FIX by removing at some point Used only for lists.

• #_label : Widget | Nil

  Widget implementing the label.

• #_label!
• #_label=(_label : Widget | Nil)

  Widget implementing the label.

• #_minimal_children_rectangle(xi, xl, yi, yl, get)

  Returns minimum widget size based on bounding box

• #_minimal_content_rectangle(xi, xl, yi, yl)

  Returns minimum widget size based on content.

• #_minimal_rectangle(xi, xl, yi, yl, get)

  Returns minimum widget size

• #_parse_attr(lines : CLines)
• #_parse_tags(text)

  Convert {red-fg}foo{/red-fg} to \e[31mfoo\e[39m.

• #_pcontent : String | Nil

  Printable, word-wrapped content, ready for rendering into the element.

• #_pcontent=(_pcontent : String | Nil)

  Printable, word-wrapped content, ready for rendering into the element.

• #_recalculate_index
• #_render(with_children = true)

  Renders all child elements into the output buffer.

• #_scroll_bottom
• #_wrap_content(content, colwidth)

  Wraps content based on available widget width

• #abottom(get = false)

  Returns computed absolute bottom position

• #aheight(get = false)

  Returns computed height

• #aleft(get = false)

  Returns computed absolute left position

• #align : Tput::AlignFlag

  Alignment of contained text

• #align=(align : Tput::AlignFlag)

  Alignment of contained text

• #always_scroll=(always_scroll : Bool)
• #always_scroll? : Bool
• #aright(get = false)

  Returns computed absolute right position

• #atop(get = false)

  Returns computed absolute top position

• #awidth(get = false)

  Returns computed width

• #back!

  Sends widget to back

• #base_limit : Int32
• #base_limit=(base_limit : Int32)
• #border_char(border, x, xi, xl, y, yi, yl, default_attr)
• #bottom : Int32 | Nil

  User-defined bottom

• #bottom=(val : Int32 | Nil)

  Sets Widget's @bottom

• #child_base : Int32

  Offset from the top of content (in number of lines) due to scrolling.

• #child_base=(child_base : Int32)

  Offset from the top of content (in number of lines) due to scrolling.

• #child_offset : Int32

  Offset of cursor (in number of lines) within Widget.

• #child_offset=(child_offset : Int32)

  Offset of cursor (in number of lines) within Widget.

• #clear_base_line(i)
• #clear_last_rendered_position(get = false, override = false)

  Clears area/position of widget's last render

• #clear_line(i)
• #clickable=(clickable : Bool)

  Is element clickable?

• #clickable? : Bool

  Is element clickable?

• #content : String

  Widget's user-set content in original form.

• #content=(content)

  Processes and sets widget content.

• #delete_bottom(n)
• #delete_line(i = nil, n = 1)
• #delete_top(n = 1)
• #destroy
• #determine_screen
• #disable_drag
• #draggable=(draggable : Bool)
• #draggable=(draggable : Bool)

  Is element draggable?

• #draggable? : Bool?

  Is element draggable?

• #enable_drag(x)
• #focus

  Puts current widget in focus

• #focus_on_click=(focus_on_click : Bool)
• #focus_on_click? : Bool
• #focused?

  Returns whether widget is currently in focus

• #front!

  Sends widget to front

• #get_baseline(i)
• #get_content
• #get_line(i)
• #get_lines
• #get_screen_lines
• #get_scroll

  Returns total amount of lines by which widget is scrolled.

• #get_scroll_height
• #get_scroll_perc(s)
• #get_text
• #height : Int32 | String | Nil

  User-defined height (setter is defined below)

• #height=(val : Int32 | String | Nil)

  Sets widget's total height

• #hide

  Hides widget from screen

• #ibottom

  Returns computed content offset from bottom

• #ignore_keys=(ignore_keys : Bool)
• #ignore_keys? : Bool
• #iheight

  Returns summed amount of content offset from top and bottom

• #ileft

  Returns computed content offset from left

• #index : Int32
• #index=(index : Int32)
• #input=(input : Bool)

  Does it accept keyboard input?

• #input? : Bool

  Does it accept keyboard input?

• #insert(element, i = -1)

  Inserts element to list of children at a specified position (at end by default)

• #insert_bottom(line)
• #insert_line(i = nil, line = "")
• #insert_top(line)
• #interactive=(interactive : Bool)
• #interactive? : Bool
• #iright

  Returns computed content offset from right

• #items : Array(Crysterm::Widget::Box)
• #items=(items : Array(Crysterm::Widget::Box))
• #itop

  Returns computed content offset from top

• #iwidth

  Returns summed amount of content offset from left and right

• #keyable=(keyable : Bool)

  Can element receive keyboard input? (Managed internally; use input for user-side setting)

• #keyable? : Bool

  Can element receive keyboard input? (Managed internally; use input for user-side setting)

• #keys=(keys : Bool)

  Should widget react to some pre-defined keys in it?

• #keys? : Bool

  Should widget react to some pre-defined keys in it?

• #label=(text : String | Nil)

  Sets or clears label text

• #last_rendered_position
• #left : Int32 | String | Nil

  User-defined left

• #left=(val : Int32 | String | Nil)

  Sets Widget's @left

• #overflow : Crysterm::Overflow

  What action to take when widget is overflowing parent's rectangle?

• #overflow=(overflow : Crysterm::Overflow)

  What action to take when widget is overflowing parent's rectangle?

• #parent : Widget | Nil

  Widget's parent Widget, if any.

• #parent=(parent : Widget | Nil)

  Widget's parent Widget, if any.

• #parent_or_screen

  Returns parent Widget (if any) or Screen to which the widget may be attached.

• #parse_tags=(parse_tags : Bool)

  Is element's content to be parsed for tags?

• #parse_tags? : Bool

  Is element's content to be parsed for tags?

• #pop_line(n)
• #process_content(no_tags = false)
• #push_line(line)
• #rbottom

  Returns computed relative bottom position

• #really_scrollable?

  Potentially use this where ever .scrollable? is used

• #remove(element)

  Removes element from list of children

• #remove_from_parent

  Removes node from its parent.

• #remove_hover
• #remove_label

  Removes widget label

• #render(with_children = true)
• #reposition_label(event = nil)

  Repositions label to the right place.

• #reset_scroll
• #resizable=(resizable : Bool)

  Can Crysterm resize the widget if/when needed?

• #resizable? : Bool

  Can Crysterm resize the widget if/when needed?

• #right : Int32 | Nil

  User-defined right

• #right=(val : Int32 | Nil)

  Sets Widget's @right

• #rleft

  Returns computed relative left position

• #rright

  Returns computed relative right position

• #rtop

  Returns computed relative top position

• #sattr(style, fg = nil, bg = nil)
• #screen : Crysterm::Screen | Nil

  Screen owning this element, forced to non-nil at time of access.

• #screen=(screen : Crysterm::Screen | Nil)

  Screen owning this element, forced to non-nil at time of access.

• #screen? : Crysterm::Screen?

  Screen owning this element, forced to non-nil at time of access.

• #screenshot(xi = nil, xl = nil, yi = nil, yl = nil)

  Takes screenshot of a widget.

• #scroll(offset = 1, always = false)

  Scrolls widget by offset lines down or up

• #scroll_to(offset, always = false)
• #scrollable=(scrollable : Bool)

  Is element scrollable?

• #scrollable? : Bool

  Is element scrollable?

• #scrollbar=(scrollbar : Bool)
• #scrollbar? : Bool
• #set_baseline(i, line)
• #set_content(content : String = "", no_clear = false, no_tags = false)
• #set_hover(hover_text)
• #set_index(index : Int)
• #set_label(text : String, side = "left")

  Sets widget label.

• #set_line(i, line)
• #set_scroll_perc(i)
• #set_text(content = "", no_clear = false)
• #shift_line(n)
• #show

  Shows widget on screen

• #snapshot(include_decorations = true, dxi = 0, dxl = 0, dyi = 0, dyl = 0)

  Takes screenshot of a widget in a more convenient way than #screenshot.

• #str_width(text)
• #toggle_visibility

  Toggles widget visibility

• #top : Int32 | String | Nil

  User-defined top

• #top=(val : Int32 | String | Nil)

  Sets Widget's @top

• #track=(track : Bool)

  Should widget indicate the scroll position?

• #track? : Bool

  Should widget indicate the scroll position?

• #unshift_line(line)
• #vi=(vi : Bool)
• #vi? : Bool
• #visible?

  Returns whether widget is visible.

• #width : Int32 | String | Nil

  User-defined width (setter is defined below)

• #width=(val : Int32 | String | Nil)

  Sets widget's total width

• #wrap_content=(wrap_content : Bool)

  Can element's content be word-wrapped?

• #wrap_content? : Bool

  Can element's content be word-wrapped?

Constructor Detail

Class Method Detail

Instance Method Detail

snapshot(true, -1, 2, -3, 4)

screenshot(-ileft - 1, width + iright + 2, -itop - 3, height + ibottom + 4)