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.

Object properties

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

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).
:setup {[args]} Set a declarative widget hierarchy description. Inherited from wibox.widget
:add_button (button) Add a new awful.button to this widget. Inherited from wibox.widget
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. Inherited from wibox.widget
:emit_signal (name, ...) Emit a signal. Inherited from gears.object
: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

Signals

widget::layout_changed When the layout (size) change. Inherited from wibox.widget
widget::redraw_needed When the widget content changed. Inherited from wibox.widget
button::press When a mouse button is pressed over the widget. Inherited from wibox.widget
button::release When a mouse button is released over the widget. Inherited from wibox.widget
mouse::enter When the mouse enter a widget. Inherited from wibox.widget
mouse::leave When the mouse leave a widget. Inherited from wibox.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

Object properties

markup string · 1 signal
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:


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 text The new value affected to the property.
text string · 1 signal
Set a textbox text.

Type constraints:

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

See also:


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 a textbox ellipsize mode.

Valid values are:

  • start
  • middle
  • end

Type constraints:

  • mode string Where should long lines be shortened? “start”, “middle” or “end”.

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 mode The new value affected to the property.
wrap string · 1 signal

Set a textbox wrap mode.

Valid values are:

  • word
  • char
  • word_char

Type constraints:

  • mode string Where to wrap? After “word”, “char” or “word_char”.

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 mode The new value affected to the property.
valign string · 1 signal

The textbox' vertical alignment.

Valid values are:

  • top
  • center
  • bottom

Type constraints:

  • mode string Where should the textbox be drawn? “top”, “center” or “bottom”.

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 mode The new value affected to the property.
align string · 1 signal

Set a textbox horizontal alignment.

Valid values are:

  • left
  • center
  • right

Type constraints:

  • mode string Where should the textbox be drawn? “left”, “center” or “right”.

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 mode The new value affected to the property.
font string · 1 signal · 1 theme variable
Set a textbox font.

Type constraints:

  • font string The font description as string.

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.textbox_fontFallback when font isn't set.
children table · Inherited from wibox.widget
Get or set the children elements.

Type constraints:

  • children table The children.
all_children table · Inherited from wibox.widget
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:

  • children table The children.
forced_height number or nil · Inherited from wibox.widget
Force a widget height.

Type constraints:

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

Type constraints:

  • width number or nil The width (nil for automatic)
opacity number · Inherited from wibox.widget
The widget opacity (transparency).

Type constraints:

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

The table contains a list of awful.button objects.

See also:

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:

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

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

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

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

  • 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]} · Inherited from wibox.widget
Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

  • args An array containing the widgets disposition
:add_button (button) · Inherited from wibox.widget
Add a new awful.button to this widget.

Parameters:

  • button awful.button The button to add.
:emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget
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, ...) · Inherited from gears.object
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) · Inherited from gears.object
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) · 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 string The name of the signal.
  • func function The callback to call when the signal is emitted.

Signals

widget::layout_changed · Inherited from wibox.widget
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 · Inherited from wibox.widget
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 · Inherited from wibox.widget
When a mouse button is pressed over the widget.

Arguments:

  • 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 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 · Inherited from wibox.widget
When a mouse button is released over the widget.

Arguments:

  • 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 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 · Inherited from wibox.widget
When the mouse enter a widget.

Arguments:

  • self table The current object instance itself.
  • 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 · Inherited from wibox.widget
When the mouse leave a widget.

Arguments:

  • self table The current object instance itself.
  • 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