Module: wibox.widget.textbox

A widget to display either plain or HTML text.

Usage:

    wibox.widget{
        markup = "This <i>is</i> a <b>textbox</b>!!!",
        halign = "center",
        valign = "center",
        widget = wibox.widget.textbox
    }
    

Class Hierarchy

Info:

  • Copyright: 2010, 2011 Uli Schlachter, dodo
  • Originally authored by: Uli Schlachter,dodo
    (Full contributors list available on our github project)

Constructors

wibox.widget.textbox (text, ignore_markup) Create a new textbox.

Static module functions

wibox.widget.textbox.get_markup_geometry (text, s, font) -> table Get geometry of text label, as if textbox would be created for it on the screen.

Object properties

markup string Set the HTML text of the textbox.
text string Set a textbox plain text.
ellipsize string Set the text ellipsize mode.
wrap string Set a textbox wrap mode.
valign string The vertical text alignment.
halign string The horizontal text alignment.
font font Set a textbox font.
line_spacing_factor number or nil Set the distance between the lines.
justify boolean Justify the text when there is more space.
indent number How to indent text with multiple lines.
children table Get or set the children elements. Inherited from wibox.widget.base
all_children table Get all direct and indirect children widgets. Inherited from wibox.widget.base
forced_height number or nil Force a widget height. Inherited from wibox.widget.base
forced_width number or nil Force a widget width. Inherited from wibox.widget.base
opacity number The widget opacity (transparency). Inherited from wibox.widget.base
visible boolean The widget visibility. Inherited from wibox.widget.base
buttons table The widget buttons. Inherited from wibox.widget.base

Deprecated object properties

align string The horizontal text alignment. Deprecated

Object methods

:get_preferred_size (s) -> (number, number) Get the preferred size of a textbox.
:get_height_for_width (width, s) -> number Get the preferred height of a textbox at a given width.
:get_preferred_size_at_dpi (dpi) -> (number, number) Get the preferred size of a textbox.
:get_height_for_width_at_dpi (width, dpi) -> number Get the preferred height of a textbox at a given width.
:set_markup_silently (text) -> boolean or (boolean, string) Set the text of the textbox.(with Pango markup).
:add_button (button) Add a new awful.button to this widget. Inherited from wibox.widget.base
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. Inherited from wibox.widget.base
:index (widget, recursive, ...) -> (number, widget, table) Get the index of a widget. Inherited from wibox.widget.base
:connect_signal (name, func) Connect to a signal. Inherited from gears.object
:weak_connect_signal (name, func) Connect to a signal weakly. Inherited from gears.object
:disconnect_signal (name, func) Disonnect from a signal. Inherited from gears.object
:emit_signal (name, ...) Emit a signal. Inherited from gears.object

Signals

widget::layout_changed When the layout (size) change. Inherited from wibox.widget.base
widget::redraw_needed When the widget content changed. Inherited from wibox.widget.base
button::press When a mouse button is pressed over the widget. Inherited from wibox.widget.base
button::release When a mouse button is released over the widget. Inherited from wibox.widget.base
mouse::enter When the mouse enter a widget. Inherited from wibox.widget.base
mouse::leave When the mouse leave a widget. Inherited from wibox.widget.base


Constructors

🔗 wibox.widget.textbox (text, ignore_markup)
Create a new textbox.

Parameters:

Name Type(s) Description Default value
text Optional string The textbox content ""
ignore_markup Optional boolean Ignore the pango/HTML markup false

Returns:

    table A new textbox widget

Static module functions

🔗 wibox.widget.textbox.get_markup_geometry (text, s, font) -> table
Get geometry of text label, as if textbox would be created for it on the screen.

Parameters:

Name Type(s) Description Default value
text string The text content, pango markup supported. Not applicable
s Optional integer or screen The screen on which the textbox would be displayed. nil
font Optional string The font description as string. beautiful.font

Returns:

    table Geometry (width, height) hashtable.

Object properties

🔗 markup string · 1 signal

Set the HTML text of the textbox.

The main difference between text and markup is that markup is able to render a small subset of HTML tags. See the Pango markup) documentation to see what is and isn't valid in this property.

 local w = wibox.widget {
     markup = "This is some <i>text</i>, <b>HTML tags</b> <u>WILL</u> work.",
     widget = wibox.widget.textbox,
 }

The wibox.widget.textbox colors are usually set by wrapping into a wibox.container.background widget, but can also be done using the markup:

 local w = wibox.widget {
     markup = "<span background='#ff0000' foreground='#0000ff'>Some</span>"..
       " nice <span foreground='#00ff00'>colors!</span>",
     widget = wibox.widget.textbox,
 }

Constraints:

Default value : self.text
Valid values : The text to set. This can contain pango markup (e.g. <b>bold</b>). You can use gears.string.escape to escape parts of it.

See also:

text Set a textbox plain text. object properties

Click to display more

Emit signals:

  • property::markup When the markup value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value markup The new value affected to the property.
🔗 text string · 1 signal

Set a textbox plain text.

This property renders the text as-is, it does not interpret it:

 local w = wibox.widget {
     text   = "This is some <i>text</i>, <b>HTML tags</b> will <u>NOT</u> work.",
     widget = wibox.widget.textbox,
 }

One exception are the control characters, which are interpreted:

 local w = wibox.widget {
     text   = "This is some text\nover\nmultiple lines!",
     widget = wibox.widget.textbox,
 }

Constraints:

Default value : ""
Valid values : The text to display. Pango markup is ignored and shown as-is.

See also:

markup Set the HTML text of the textbox. object properties

Click to display more

Emit signals:

  • property::text When the text value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value text The new value affected to the property.
🔗 ellipsize string · 1 signal
Set the text ellipsize mode.

See Pango for additional details: Layout.set_ellipsize

Constraints:

Default value : "end"
Valid values:
"start"
"middle"
"end"
"none"

Usage:

    widget{
        text = "This is a very long text, that cannot be displayed fully.",
        ellipsize = "start",
        widget = wibox.widget.textbox,
    },
    widget{
        text = "This is a very long text, that cannot be displayed fully.",
        ellipsize = "end",
        widget = wibox.widget.textbox,
    },
    widget{
        text = "This is a very long text, that cannot be displayed fully.",
        ellipsize = "middle",
        widget = wibox.widget.textbox,
    },
    widget{
        text = "This is a very long text, that cannot be displayed fully.",
        ellipsize = "none",
        valign = "top",
        widget = wibox.widget.textbox,
    }

Click to display more

Emit signals:

  • property::ellipsize When the ellipsize value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value ellipsize The new value affected to the property.
🔗 wrap string · 1 signal
Set a textbox wrap mode.

Constraints:

Default value : "word_char"
Valid values: : Where to wrap? After "word", "char" or "word_char".
"word"
"char"
"word_char"

Usage:

    for _, wrap in ipairs {"word", "char", "word_char"} do
        local w = wibox.widget {
            wrap   = wrap,
            text   = "Notable dinausors: Tyrannosaurus-Rex, Triceratops, Velociraptor, Sauropods, Archaeopteryx.",
            widget = wibox.widget.textbox,
        }
    end

Click to display more

Emit signals:

  • property::wrap When the wrap value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value wrap The new value affected to the property.
🔗 valign string · 1 signal
The vertical text alignment.

This aligns the text within the widget's bounds. In some situations this may differ from aligning the widget with wibox.container.place.

Constraints:

Default value : "center"
Valid values:
"top"
"center"
"bottom"

Usage:

    for _, valign in ipairs {"top", "center", "bottom"} do
        local w = wibox.widget {
            valign = valign,
            text   = "some text",
            widget = wibox.widget.textbox,
        }
    end

Click to display more

Emit signals:

  • property::valign When the valign value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value valign The new value affected to the property.
🔗 halign string · 1 signal
The horizontal text alignment.

This aligns the text within the widget's bounds. In some situations this may differ from aligning the widget with wibox.container.place.

Constraints:

Default value : "left"
Valid values:
"left"
"center"
"right"

Usage:

    for _, align in ipairs {"left", "center", "right"} do
        local w = wibox.widget {
            halign = align,
            text   = "some text",
            widget = wibox.widget.textbox,
        }
    end

Click to display more

Emit signals:

  • property::halign When the halign value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value halign The new value affected to the property.
🔗 font font · 1 signal · 1 theme variable

Set a textbox font.

There is multiple valid font string representation. The most precise is XFT. It is also possible to use the family name, followed by the face and size such as Monospace Bold 10. This script lists the fonts present on your system:

#!/usr/bin/env lua

local lgi = require("lgi")
local pangocairo = lgi.PangoCairo

local font_map = pangocairo.font_map_get_default()

for k, v in pairs(font_map:list_families()) do
    print(v:get_name(), "monospace?: "..tostring(v:is_monospace()))
    for k2, v2 in ipairs(v:list_faces()) do
        print("    ".. v2:get_face_name())
    end
end

Save this script somewhere on your system, chmod +x it and run it. It will list something like:

Sans    monospace?: false
    Regular
    Bold
    Italic
    Bold Italic

In this case, the font could be Sans 10 or Sans Bold Italic 10.

Here are examples of several font families:

Usage example output:

sans 0 sans NORMAL NORMAL
Roboto, Bold 0 Roboto NORMAL NORMAL
DejaVu Sans, Oblique 0 DejaVu Sans NORMAL OBLIQUE
Noto Mono, Regular 0 Noto Mono NORMAL NORMAL

Usage example:

local pango = require("lgi").Pango
local fonts = {
    "sans",
    "Roboto, Bold",
    "DejaVu Sans, Oblique",
    "Noto Mono, Regular"
}

for _, font in ipairs(fonts) do
    local w = wibox.widget {
        font   = font,
        text   = "The quick brown fox jumps over the lazy dog!",
        widget = wibox.widget.textbox,
    }

    -- Use the low level Pango API to validate the font was parsed properly.
    local desc = pango.FontDescription.from_string(w.font)
    print(
        string.format(
            "%s %d %s %s %s",
            w.font,
            desc:get_size(),
            desc:get_family(),
            desc:get_variant(),
            desc:get_style()
         )
    )
end

The font size is a number at the end of the font description string:

for _, font in ipairs { "sans 8", "sans 10", "sans 12", "sans 14" } do
    local w = wibox.widget {
        font   = font,
        text   = "The quick brown fox jumps over the lazy dog!",
        widget = wibox.widget.textbox,
    }
end

Constraints:

Default value : beautiful.font
Type description:
string : A Pango font description.
string : An XFT string, such as "--dejavu sans mono-medium-r-normal---80-----iso10646-1".

Click to display more

Emit signals:

  • property::font When the font value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value font The new value affected to the property.

Consumed theme variables:

Theme variable Usage
beautiful.fontThe default font.
beautiful.font
🔗 line_spacing_factor number or nil · 1 signal
Set the distance between the lines.

Constraints:

Default value : nil
Type description:
nil : Automatic (most probably 1.0).
Unit : Distance between lines as a ratio of the line height. 1.0 means no spacing. Less than 1.0 will squash the lines and more than 1.0 will move them further apart.
Negative allowed : false

Usage:

    for _, spacing in ipairs {0.0, 0.1, 0.5, 0.9, 1, 1.5, 2.0, 2.5} do
        local text = "This text shas a line\nspacing of "..tostring(spacing).. "\nunits."
    
        widget{
            text                = text,
            font                = "sans 10",
            line_spacing_factor = spacing,
            widget              = wibox.widget.textbox,
        }
    end
    
    Please note that the Pango version (one of AwesomeWM dependency) must be at
    least 1.44 for this to work.

Click to display more

Emit signals:

🔗 justify boolean · 1 signal
Justify the text when there is more space.

Constraints:

Default value : false
Valid values : true or false.

Usage:

    local lorem_ipsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed "..
        "do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad "..
        "minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex "..
        "ea commodo consequat."
    
    widget{
        text    = lorem_ipsum,
        justify = false,
        widget  = wibox.widget.textbox,
    }
    
    widget{
        text    = lorem_ipsum,
        justify = true,
        widget  = wibox.widget.textbox,
    }

Click to display more

Emit signals:

  • property::justify When the justify value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value justify The new value affected to the property.
🔗 indent number · 1 signal
How to indent text with multiple lines.

Note that this does nothing if align == "center".

Constraints:

Default value : 0.0
Unit : points
Negative allowed : true

Usage:

    local lorem_ipsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed "..
        "do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad "..
        "minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex "..
        "ea commodo consequat."
    for _, indent in ipairs { -10, 0, 10 } do
        widget{
            text   = lorem_ipsum,
            indent = indent,
            widget = wibox.widget.textbox,
        }
    end

Click to display more

Emit signals:

  • property::indent When the indent value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value indent The new value affected to the property.
🔗 children table · Inherited from wibox.widget.base
Get or set the children elements.

Constraints:

Default value : {}
Table content : A list of wibox.widget.

See also:

all_children Get all direct and indirect children widgets. object properties
🔗 all_children table · Inherited from wibox.widget.base
Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow if there is a loop in the widgets hierarchy. A hierarchy loop is when a widget, or any of its children, contain (directly or indirectly) itself.

Constraints:

Default value : {}
Table content : A list of wibox.widget.

See also:

children Get or set the children elements. object properties
🔗 forced_height number or nil · Inherited from wibox.widget.base
Force a widget height.

Constraints:

Default value : nil
Type description:
nil : Let the layout decide the height. Usually using the widget native height.
number : Enforce a number of pixels.
Unit : pixel
Negative allowed : false

See also:

forced_width Force a widget width. object properties
🔗 forced_width number or nil · Inherited from wibox.widget.base
Force a widget width.

Constraints:

Default value : nil
Type description:
nil : Let the layout decide the width. Usually using the widget native width.
number : Enforce a number of pixels.
Unit : pixel
Negative allowed : false

See also:

forced_height Force a widget height. object properties
🔗 opacity number · Inherited from wibox.widget.base
The widget opacity (transparency).

Constraints:

Default value : 1.0
Unit : A gradient between transparent (0.0) and opaque (1.0).
Minimum value : 0.0
Maximum value : 1.0

See also:

visible The widget visibility. object properties
🔗 visible boolean · Inherited from wibox.widget.base
The widget visibility.

Constraints:

Default value : true
Valid values : true or false.

See also:

opacity The widget opacity (transparency). object properties
🔗 buttons table · Inherited from wibox.widget.base
The widget buttons.

The table contains a list of awful.button objects.

Constraints:

Default value : {}
Table content : A list of awful.button.

See also:

awful.button Create easily new buttons objects ignoring certain modifiers. module

Deprecated object properties

🔗 align string · 1 signal
The horizontal text alignment.

Renamed to halign for consistency with other APIs.

Click to display more

Emit signals:

  • property::align When the align value changes.
    • self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
    • new_value align The new value affected to the property.

Object methods

🔗 :get_preferred_size (s) -> (number, number)
Get the preferred size of a textbox.

This returns the size that the textbox would use if infinite space were available.

Parameters:

Name Type(s) Description
s integer or screen The screen on which the textbox will be displayed.

Returns:

  1. number The preferred width.
  2. number The preferred height.
🔗 :get_height_for_width (width, s) -> number
Get the preferred height of a textbox at a given width.

This returns the height that the textbox would use when it is limited to the given width.

Parameters:

Name Type(s) Description
width number The available width.
s integer or screen The screen on which the textbox will be displayed.

Returns:

    number The needed height.
🔗 :get_preferred_size_at_dpi (dpi) -> (number, number)
Get the preferred size of a textbox.

This returns the size that the textbox would use if infinite space were available.

Parameters:

Name Type(s) Description
dpi number The DPI value to render at.

Returns:

  1. number The preferred width.
  2. number The preferred height.
🔗 :get_height_for_width_at_dpi (width, dpi) -> number
Get the preferred height of a textbox at a given width.

This returns the height that the textbox would use when it is limited to the given width.

Parameters:

Name Type(s) Description
width number The available width.
dpi number The DPI value to render at.

Returns:

    number The needed height.
🔗 :set_markup_silently (text) -> boolean or (boolean, string)
Set the text of the textbox.(with Pango markup).

Parameters:

Name Type(s) Description
text string The text to set. This can contain pango markup (e.g. <b>bold</b>). You can use gears.string.escape to escape parts of it.

Returns:

    boolean true

Or

  1. boolean false
  2. string Error message explaining why the markup was invalid.
🔗 :add_button (button) · Inherited from wibox.widget.base
Add a new awful.button to this widget.

Parameters:

Name Type(s) Description
button awful.button The button to add.
🔗 :emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget.base

Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.

This is useful to track signals when there is a dynamic set of containers and layouts wrapping the widget.

Note that this function has some flaws:

  1. The signal is only forwarded once the widget tree has been built. This happens after all currently scheduled functions have been executed. Therefore, it will not start to work right away.
  2. In case the widget is present multiple times in a single widget tree, this function will also forward the signal multiple times (once per upward tree path).
  3. If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

Name Type(s) Description
signal_name string
... Other arguments
🔗 :index (widget, recursive, ...) -> (number, widget, table) · Inherited from wibox.widget.base
Get the index of a widget.

Parameters:

Name Type(s) Description
widget widget The widget to look for.
recursive Optional boolean Recursively check accross the sub-widgets hierarchy.
... Optional widget Additional widgets to add at the end of the sub-widgets hierarchy "path".

Returns:

  1. number The widget index.
  2. widget The parent widget.
  3. table The hierarchy path between "self" and "widget".
🔗 :connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Usage example output:

In slot [obj]   nil nil nil
In slot [obj]   foo bar 42

Parameters:

Name Type(s) Description
name string The name of the signal.
func function The callback to call when the signal is emitted.

Usage:

    local o = gears.object{}
    -- Function can be attached to signals
    local function slot(obj, a, b, c)
        print("In slot", obj, a, b, c)
    end
    o:connect_signal("my_signal", slot)
    -- Emitting can be done without arguments. In that case, the object will be
    -- implicitly added as an argument.
    o:emit_signal "my_signal"
    -- It is also possible to add as many random arguments are required.
    o:emit_signal("my_signal", "foo", "bar", 42)
    -- Finally, to allow the object to be garbage collected (the memory freed), it
    -- is necessary to disconnect the signal or use weak_connect_signal
    o:disconnect_signal("my_signal", slot)
    -- This time, the slot wont be called as it is no longer connected.
    o:emit_signal "my_signal"
🔗 :weak_connect_signal (name, func) · Inherited from gears.object
Connect to a signal weakly.

This allows the callback function to be garbage collected and automatically disconnects the signal when that happens. Warning: Only use this function if you really, really, really know what you are doing.

Parameters:

Name Type(s) Description
name string The name of the signal.
func function The callback to call when the signal is emitted.
🔗 :disconnect_signal (name, func) · Inherited from gears.object
Disonnect from a signal.

Parameters:

Name Type(s) Description
name string The name of the signal.
func function The callback that should be disconnected.
🔗 :emit_signal (name, ...) · Inherited from gears.object
Emit a signal.

Parameters:

Name Type(s) Description
name string The name of the signal
... Extra arguments for the callback functions. Each connected function receives the object as first argument and then any extra arguments that are given to emit_signal()

Signals

🔗 widget::layout_changed · Inherited from wibox.widget.base
When the layout (size) change. This signal is emitted when the previous results of :layout() and :fit() are no longer valid. Unless this signal is emitted, :layout() and :fit() must return the same result when called with the same arguments.

See also:

widget::redraw_needed When the widget content changed. signals
🔗 widget::redraw_needed · Inherited from wibox.widget.base
When the widget content changed. This signal is emitted when the content of the widget changes. The widget will be redrawn, it is not re-layouted. Put differently, it is assumed that :layout() and :fit() would still return the same results as before.

See also:

widget::layout_changed When the layout (size) change. signals
🔗 button::press · Inherited from wibox.widget.base
When a mouse button is pressed over the widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 button::release · Inherited from wibox.widget.base
When a mouse button is released over the widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
lx number The horizontal position relative to the (0,0) position in the widget.
ly number The vertical position relative to the (0,0) position in the widget.
button number The button number.
mods table The modifiers (mod4, mod1 (alt), Control, Shift)
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 mouse::enter · Inherited from wibox.widget.base
When the mouse enter a widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
🔗 mouse::leave · Inherited from wibox.widget.base
When the mouse leave a widget.

Arguments:

Name Type(s) Description
self table The current object instance itself.
find_widgets_result table The entry from the result of wibox:find_widgets for the position that the mouse hit.
drawable wibox.drawable The drawable containing the widget.
widget widget The widget being displayed.
hierarchy wibox.hierarchy The hierarchy managing the widget's geometry.
x number An approximation of the X position that the widget is visible at on the surface.
y number An approximation of the Y position that the widget is visible at on the surface.
width number An approximation of the width that the widget is visible at on the surface.
height number An approximation of the height that the widget is visible at on the surface.
widget_width number The exact width of the widget in its local coordinate system.
widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse Manipulate and inspect the mouse cursor. module
generated by LDoc 1.4.6