Module: wibox.container.background
A container capable of changing the background color, foreground color and widget shape.
Info:
- Copyright: 2010 Uli Schlachter
- Author: Uli Schlachter
Constructors
wibox.container.background ([widget[, bg[, shape]]]) | Returns a new background container. |
Object properties
widget | widget | The widget displayed in the background widget. | |
bg | color | The background color/pattern/gradient to use. | |
fg | color | The foreground (text) color/pattern/gradient to use. | |
shape | gears.shape or function | The background shape. | |
border_width | number | Add a border of a specific width. | |
border_color | color | Set the color for the border. | |
border_strategy | string | How the border width affects the contained widget. | |
bgimage | string or surface or function | The background image to use. | |
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 |
Deprecated object properties
shape_border_width | number | When a shape is set, also draw a border. | |
shape_border_color | color | When a shape is set, also draw a border. |
Object methods
:set_shape (shape) | Set the background shape. | |
: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 |
Constructors
- wibox.container.background ([widget[, bg[, shape]]])
-
Returns a new background container.
A background container applies a background and foreground color to another widget.
Parameters:
- widget widget The widget to display. (optional)
- bg color The background to use for that widget. (optional)
- shape gears.shape or function A gears.shape compatible shape function (optional)
Object properties
- widget widget
-
The widget displayed in the background widget.
Type constraints:
- widget widget The widget to be disaplayed inside of the background area.
- bg color · 1 signal
-
The background color/pattern/gradient to use.
Type constraints:
- bg color A color string, pattern or gradient
See also:
Usage:
local text_widget = { text = 'Hello world!', widget = wibox.widget.textbox } parent : setup { { text_widget, bg = '#ff0000', widget = wibox.container.background }, { text_widget, bg = '#00ff00', widget = wibox.container.background }, { text_widget, bg = '#0000ff', widget = wibox.container.background }, spacing = 10, layout = wibox.layout.fixed.vertical }
Click to display more Emit signals:
property::bg
When the bg value changes.self
wibox.container.background The object which changed (useful when connecting many object to the same callback).new_value
bg The new value affected to the property.
- fg color · 1 signal
-
The foreground (text) color/pattern/gradient to use.
Type constraints:
- fg color A color string, pattern or gradient
See also:
Usage:
local text_widget = { text = 'Hello world!', widget = wibox.widget.textbox } parent : setup { { text_widget, fg = '#ff0000', widget = wibox.container.background }, { text_widget, fg = '#00ff00', widget = wibox.container.background }, { text_widget, fg = '#0000ff', widget = wibox.container.background }, spacing = 10, layout = wibox.layout.fixed.vertical }
Click to display more Emit signals:
property::fg
When the fg value changes.self
wibox.container.background The object which changed (useful when connecting many object to the same callback).new_value
fg The new value affected to the property.
- shape gears.shape or function
-
The background shape.
Use set_shape to set additional shape paramaters.
Type constraints:
- shape gears.shape or function A function taking a context, width and height as arguments
See also:
Usage:
parent : setup { { -- Adding a shape without margin may result in cropped output { text = 'Hello world!', widget = wibox.widget.textbox }, shape = gears.shape.hexagon, bg = beautiful.bg_normal, shape_border_color = beautiful.border_color, shape_border_width = beautiful.border_width, widget = wibox.container.background }, { -- To solve this, use a margin { { text = 'Hello world!', widget = wibox.widget.textbox }, left = 10, right = 10, top = 3, bottom = 3, widget = wibox.container.margin }, shape = gears.shape.hexagon, bg = beautiful.bg_normal, border_color = beautiful.border_color, border_width = beautiful.border_width, widget = wibox.container.background }, spacing = 10, layout = wibox.layout.fixed.vertical }
- border_width number · 1 signal
-
Add a border of a specific width.
If the shape is set, the border will also be shaped.
See wibox.container.background.shape for an usage example.
Type constraints:
- width number The border width. (default 0)
See also:
Click to display more Emit signals:
property::border_width
When the border_width value changes.self
wibox.container.background The object which changed (useful when connecting many object to the same callback).new_value
width
The new value affected to the property.
- border_color color · 1 signal · 1 theme variable
-
Set the color for the border.
See wibox.container.background.shape for an usage example.
Type constraints:
- fg color The border color, pattern or gradient (default self._private.foreground)
See also:
Click to display more Emit signals:
property::border_color
When the border_color value changes.self
wibox.container.background The object which changed (useful when connecting many object to the same callback).new_value
fg The new value affected to the property.
Consumed theme variables:
Theme variable Usage beautiful.fg_normal
Fallback when ‘fg’ and border_color aren’t set. - border_strategy string
-
How the border width affects the contained widget.
The valid values are:
- none: Just apply the border, do not affect the content size (default).
- inner: Squeeze the size of the content by the border width.
- bgimage string or surface or function
-
The background image to use.
If
image
is a function, it will be called with(context, cr, width, height)
as arguments. Any other arguments passed to this method will be appended.Type constraints:
- image string, surface or function A background image or a function
See also:
- 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)
- height
number or nil
The height (
- forced_width number or nil · Inherited from wibox.widget
-
Force a widget width.
Type constraints:
- width
number or nil
The width (
nil
for automatic)
- width
number or nil
The width (
- 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:
Deprecated object properties
- shape_border_width number
-
When a shape is set, also draw a border.
See wibox.container.background.shape for an usage example.
Type constraints:
- width number The border width
See also:
- shape_border_color color · 1 theme variable
-
When a shape is set, also draw a border.
See wibox.container.background.shape for an usage example.
Type constraints:
- fg color The border color, pattern or gradient (default self._private.foreground)
See also:
Click to display more Consumed theme variables:
Theme variable Usage beautiful.fg_normal
Fallback when ‘fg’ and border_color aren’t set.
Object methods
- :set_shape (shape) · 1 signal
-
Set the background shape.
Any other arguments will be passed to the shape function.
Parameters:
- shape gears.shape or function A function taking a context, width and height as arguments
See also:
Click to display more Emit signals:
property::set_shape
When the set_shape value changes.self
wibox.container.background The object which changed (useful when connecting many object to the same callback).new_value
shape The new value affected to the property.
- :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: