Module: wibox.widget.textbox

Usage example

Usage:

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

Info:

  • Copyright: 2010, 2011 Uli Schlachter, dodo
  • Author: Uli Schlachter,dodo

Constructors

wibox.widget.textbox ([text=""[, ignore_markup=false]]) Create a new textbox.

Functions

wibox.widget.textbox.add_button (button) Add a new awful.button to this widget.

Object properties

markup string Set the text of the textbox (with Pango markup).
text text Set a textbox' text.
ellipsize mode Set a textbox' ellipsize mode.
wrap mode Set a textbox' wrap mode.
valign mode The textbox' vertical alignment
align mode Set a textbox' horizontal alignment.
font font Set a textbox' font
children table Get or set the children elements.
all_children table Get all direct and indirect children widgets.
forced_height number or nil Force a widget height.
forced_width number or nil Force a widget width.
opacity number The widget opacity (transparency).
visible boolean The widget visibility.
buttons table The widget buttons.

Object methods

:get_preferred_size (s) Get the preferred size of a textbox.
:get_height_for_width (width, s) Get the preferred height of a textbox at a given width.
:get_preferred_size_at_dpi (dpi) Get the preferred size of a textbox.
:get_height_for_width_at_dpi (width, dpi) Get the preferred height of a textbox at a given width.
:set_markup_silently (text) Set the text of the textbox (with Pango markup).
:setup {[args]} Set a declarative widget hierarchy description.
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
:emit_signal (name, ...) Emit a signal.
:connect_signal (name, func) Connect to a signal.
:weak_connect_signal (name, func) Connect to a signal weakly.

Signals

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

Theme variables

beautiful.font string The textbox font.


Constructors

wibox.widget.textbox ([text=""[, ignore_markup=false]])
Create a new textbox.

Parameters:

  • text string The textbox content (default "")
  • ignore_markup boolean Ignore the pango/HTML markup (default false)

Returns:

    table A new textbox widget

Functions

wibox.widget.textbox.add_button (button)
Add a new awful.button to this widget.

Parameters:

  • button awful.button The button to add.

Object properties

markup (string)
Set the text of the textbox (with Pango markup).

Type constraints:

  • 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.

See also:

text (text)
Set a textbox' text.

Type constraints:

  • text The text to display. Pango markup is ignored and shown as-is.

See also:

ellipsize (mode)
Set a textbox' ellipsize mode.

Type constraints:

  • mode Where should long lines be shortened? “start”, “middle” or “end”
wrap (mode)
Set a textbox' wrap mode.

Type constraints:

  • mode Where to wrap? After “word”, “char” or “word_char”
valign (mode)
The textbox' vertical alignment

Type constraints:

  • mode Where should the textbox be drawn? “top”, “center” or “bottom”
align (mode)
Set a textbox' horizontal alignment.

Type constraints:

  • mode Where should the textbox be drawn? “left”, “center” or “right”
font (font)
Set a textbox' font

Type constraints:

  • font The font description as string
children (table)
Get or set the children elements.

Type constraints:

all_children (table)
Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow id the widget, or any of its children, contain (directly or indirectly) itself.

Type constraints:

forced_height (number or nil)
Force a widget height.

Type constraints:

  • height number or nil The height (nil for automatic)
forced_width (number or nil)
Force a widget width.

Type constraints:

  • width number or nil The width (nil for automatic)
opacity (number)
The widget opacity (transparency).

Type constraints:

  • opacity number The opacity (between 0 and 1) (default 1)
visible (boolean)
The widget visibility.
buttons (table)
The widget buttons.

The table contains a list of awful.button objects.

See also:

Object methods

:get_preferred_size (s)
Get the preferred size of a textbox. This returns the size that the textbox would use if infinite space were available.

Parameters:

  • 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)
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:

  • 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)
Get the preferred size of a textbox. This returns the size that the textbox would use if infinite space were available.

Parameters:

  • 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)
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:

  • width number The available width.
  • dpi number The DPI value to render at.

Returns:

    number The needed height.
:set_markup_silently (text)
Set the text of the textbox (with Pango markup).

Parameters:

  • 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.
:setup {[args]}
Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

  • args An array containing the widgets disposition
:emit_signal_recursive (signal_name, ...)
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.

Parameters:

  • signal_name string
  • ... Other arguments
:emit_signal (name, ...)
Emit a signal.

Parameters:

  • 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().
:connect_signal (name, func)
Connect to a signal.

Parameters:

  • name string The name of the signal.
  • func function The callback to call when the signal is emitted.
:weak_connect_signal (name, func)
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 string The name of the signal.
  • func function The callback to call when the signal is emitted.

Signals

widget::layout_changed
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. 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:

button::press
When a mouse button is pressed over the widget.

Arguments:

  • 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 The entry from the result of wibox.drawable: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:

button::release
When a mouse button is released over the widget.

Arguments:

  • 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 The entry from the result of wibox.drawable: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::enter
When the mouse enter a widget.

Arguments:

  • find_widgets_result The entry from the result of wibox.drawable: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::leave
When the mouse leave a widget.

Arguments:

  • find_widgets_result The entry from the result of wibox.drawable: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:

Theme variables

beautiful.font (string)
The textbox font.
generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00