Module: awful.widget.taglist

Taglist widget module for awful.

Here is a more advanced example of how to extend the taglist. It provides:

  • mouse "hover" color
  • an extra index field
  • a powerline look and feel

s.mytaglist = awful.widget.taglist {
    screen  = s,
    filter  = awful.widget.taglist.filter.all,
    style   = {
        shape = gears.shape.powerline
    },
    layout   = {
        spacing = -12,
        spacing_widget = {
            color  = "#dddddd",
            shape  = gears.shape.powerline,
            widget = wibox.widget.separator,
        },
        layout  = wibox.layout.fixed.horizontal
    },
    widget_template = {
        {
            {
                {
                    {
                        {
                            id     = "index_role",
                            widget = wibox.widget.textbox,
                        },
                        margins = 4,
                        widget  = wibox.container.margin,
                    },
                    bg     = "#dddddd",
                    shape  = gears.shape.circle,
                    widget = wibox.container.background,
                },
                {
                    {
                        id     = "icon_role",
                        widget = wibox.widget.imagebox,
                    },
                    margins = 2,
                    widget  = wibox.container.margin,
                },
                {
                    id     = "text_role",
                    widget = wibox.widget.textbox,
                },
                layout = wibox.layout.fixed.horizontal,
            },
            left  = 18,
            right = 18,
            widget = wibox.container.margin
        },
        id     = "background_role",
        widget = wibox.container.background,
        -- Add support for hover colors and an index label
        create_callback = function(self, c3, index, objects) --luacheck: no unused args
            self:get_children_by_id("index_role")[1].markup = "<b> "..c3.index.." </b>"
            self:connect_signal("mouse::enter", function()
                if self.bg ~= "#ff0000" then
                    self.backup     = self.bg
                    self.has_backup = true
                end
                self.bg = "#ff0000"
            end)
            self:connect_signal("mouse::leave", function()
                if self.has_backup then self.bg = self.backup end
            end)
        end,
        update_callback = function(self, c3, index, objects) --luacheck: no unused args
            self:get_children_by_id("index_role")[1].markup = "<b> "..c3.index.." </b>"
        end,
    },
    buttons = taglist_buttons
}

As demonstrated in the example above, there are a few "shortcuts" to avoid re-inventing the wheel. By setting the predefined roles as widget ids, awful.widget.common will do most of the work to update the values automatically. All of them are optional. The supported roles are:

awful.widget.common also has 2 callbacks to give more control over the widget:

  • create_callback: Called once after the widget instance is created
  • update_callback: Called every time the data is refreshed

Both callback have the same parameters:

  • self: The widget instance (widget).
  • t: The tag (tag)
  • index: The widget position in the list (number)
  • tags: The list of tag, in order (table)

Class Hierarchy

Info:

Constructors

awful.widget.taglist (args, filter, buttons, style, update_function, base_widget) Create a new taglist widget.

Object properties

screen screen The taglist screen.
base_layout wibox.layout Set the taglist layout.
count number The current number of tags. Read only
update_function function An alternative function to configure the content.
filter function or nil A function to restrict the content of the taglist.
source function The function used to gather the group of tags.
widget_template template or nil A template used to generate the individual tag widgets.
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

Object methods

: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
: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
:disconnect_signal (name, func) Disconnect from a signal. Inherited from gears.object

Theme variables

beautiful.taglist_fg_focus color The tag list main foreground (text) color.
beautiful.taglist_bg_focus color The tag list main background color.
beautiful.taglist_fg_urgent color The tag list urgent elements foreground (text) color.
beautiful.taglist_bg_urgent color The tag list urgent elements background color.
beautiful.taglist_bg_occupied color The tag list occupied elements background color.
beautiful.taglist_fg_occupied color The tag list occupied elements foreground (text) color.
beautiful.taglist_bg_empty color The tag list empty elements background color.
beautiful.taglist_fg_empty color The tag list empty elements foreground (text) color.
beautiful.taglist_bg_volatile color The tag list volatile elements background color.
beautiful.taglist_fg_volatile color The tag list volatile elements foreground (text) color.
beautiful.taglist_squares_sel surface The selected elements background image.
beautiful.taglist_squares_unsel surface The unselected elements background image.
beautiful.taglist_squares_sel_empty surface The selected empty elements background image.
beautiful.taglist_squares_unsel_empty surface The unselected empty elements background image.
beautiful.taglist_squares_resize boolean If the background images can be resized.
beautiful.taglist_disable_icon boolean Do not display the tag icons, even if they are set.
beautiful.taglist_font string The taglist font.
beautiful.taglist_spacing number The space between the taglist elements.
beautiful.taglist_shape gears.shape The main shape used for the elements.
beautiful.taglist_shape_border_width number The shape elements border width.
beautiful.taglist_shape_border_color color The elements shape border color.
beautiful.taglist_shape_empty gears.shape The shape used for the empty elements.
beautiful.taglist_shape_border_width_empty number The shape used for the empty elements border width.
beautiful.taglist_shape_border_color_empty color The empty elements shape border color.
beautiful.taglist_shape_focus gears.shape The shape used for the selected elements.
beautiful.taglist_shape_border_width_focus number The shape used for the selected elements border width.
beautiful.taglist_shape_border_color_focus color The selected elements shape border color.
beautiful.taglist_shape_urgent gears.shape The shape used for the urgent elements.
beautiful.taglist_shape_border_width_urgent number The shape used for the urgent elements border width.
beautiful.taglist_shape_border_color_urgent color The urgents elements shape border color.
beautiful.taglist_shape_volatile gears.shape The shape used for the volatile elements.
beautiful.taglist_shape_border_width_volatile number The shape used for the volatile elements border width.
beautiful.taglist_shape_border_color_volatile color The volatile elements shape border color.

List source functions

awful.widget.taglist.source.for_screen All tags for the defined screen ordered by indices.

List filters

awful.widget.taglist.filter.noempty Filtering function to include all nonempty tags on the screen.
awful.widget.taglist.filter.selected Filtering function to include selected tags on the screen.
awful.widget.taglist.filter.all Filtering function to include all tags on the screen.

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

🔗 awful.widget.taglist (args, filter, buttons, style, update_function, base_widget)
Create a new taglist widget. The last two arguments (updatefunction and layout) serve to customize the layout of the taglist (eg. to make it vertical). For that, you will need to copy the awful.widget.common.listupdate function, make your changes to it and pass it as update_function here. Also change the layout if the default is not what you want.

Parameters:

Name Type(s) Description Default value
args table Not applicable
screen screen The screen to draw taglist for. Not applicable
filter function[opt=nil] Filter function to define what clients will be listed. Not applicable
buttons table A table with buttons binding to set. Not applicable
update_function Optional function Function to create a tag widget on each update. See awful.widget.common. Undefined
layout Optional widget Optional layout widget for tag widgets. Default is wibox.layout.fixed.horizontal(). Undefined
source Optional function The function used to generate the list of tag. awful.widget.taglist.source.for_screen
widget_template Optional table A custom widget to be used for each tag Undefined
style Optional table The style overrides default theme. {}
style.fg_focus Optional string or pattern beautiful.taglist_fg_focus
style.bg_focus Optional string or pattern beautiful.taglist_bg_focus
style.fg_urgent Optional string or pattern beautiful.taglist_fg_urgent
style.bg_urgent Optional string or pattern beautiful.taglist_bg_urgent
style.bg_occupied Optional string or pattern beautiful.taglist_bg_occupied
style.fg_occupied Optional string or pattern beautiful.taglist_fg_occupied
style.bg_empty Optional string or pattern beautiful.taglist_bg_empty
style.fg_empty Optional string or pattern beautiful.taglist_fg_empty
style.bg_volatile Optional string or pattern beautiful.taglist_bg_volatile
style.fg_volatile Optional string or pattern beautiful.taglist_fg_volatile
style.squares_sel Optional string A user provided image for selected squares. beautiful.taglist_squares_sel
style.squares_unsel Optional string A user provided image for unselected squares. beautiful.taglist_squares_unsel
style.squares_sel_empty Optional string A user provided image for selected squares for empty tags. beautiful.taglist_squares_sel_empty
style.squares_unsel_empty Optional string A user provided image for unselected squares for empty tags. beautiful.taglist_squares_unsel_empty
style.squares_resize Optional boolean true or false to resize squares. beautiful.taglist_squares_resize
style.disable_icon Optional string beautiful.taglist_disable_icon
style.font Optional string The font. beautiful.taglist_font
style.spacing Optional number The spacing between tags. beautiful.taglist_spacing
style.squares_sel Optional string A user provided image for selected squares. beautiful.taglist_squares_sel
style.squares_unsel Optional string A user provided image for unselected squares. beautiful.taglist_squares_unsel
style.squares_sel_empty Optional string A user provided image for selected squares for empty tags. beautiful.taglist_squares_sel_empty
style.squares_unsel_empty Optional string A user provided image for unselected squares for empty tags. beautiful.taglist_squares_unsel_empty
style.squares_resize Optional boolean true or false to resize squares. beautiful.taglist_squares_resize
style.font Optional string The font. beautiful.taglist_font
style.shape Optional gears.shape or function beautiful.taglist_shape
style.shape_border_width Optional number beautiful.taglist_shape_border_width
style.shape_border_color Optional string beautiful.taglist_shape_border_color
style.shape_empty Optional gears.shape or function beautiful.taglist_shape_empty
style.shape_border_width_empty Optional number beautiful.taglist_shape_border_width_empty
style.border_color_empty Optional string beautiful.taglist_shape_border_color_empty
style.shape_focus Optional gears.shape or function beautiful.taglist_shape_focus
style.shape_border_width_focus Optional number beautiful.taglist_shape_border_width_focus
style.shape_border_color_focus Optional string beautiful.taglist_shape_border_color_focus
style.shape_urgent Optional gears.shape or function beautiful.taglist_shape_urgent
style.shape_border_width_urgent Optional number beautiful.taglist_shape_border_width_urgent
style.shape_border_color_urgent Optional string beautiful.taglist_shape_border_color_urgent
style.shape_volatile Optional gears.shape or function beautiful.taglist_shape_volatile
style.shape_border_width_volatile Optional number beautiful.taglist_shape_border_width_volatile
style.shape_border_color_volatile Optional string beautiful.taglist_shape_border_color_volatile
filter DEPRECATED use args.filter Not applicable
buttons DEPRECATED use args.buttons Not applicable
style DEPRECATED use args.style Not applicable
update_function DEPRECATED use args.update_function Not applicable
base_widget DEPRECATED use args.base_layout Not applicable

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.taglist_fg_focus
beautiful.taglist_bg_focus
beautiful.taglist_fg_urgent
beautiful.taglist_bg_urgent
beautiful.taglist_bg_occupied
beautiful.taglist_fg_occupied
beautiful.taglist_bg_empty
beautiful.taglist_fg_empty
beautiful.taglist_bg_volatile
beautiful.taglist_fg_volatile
beautiful.taglist_squares_sel
beautiful.taglist_squares_unsel
beautiful.taglist_squares_sel_empty
beautiful.taglist_squares_unsel_empty
beautiful.taglist_squares_resize
beautiful.taglist_disable_icon
beautiful.taglist_font
beautiful.taglist_spacing
beautiful.taglist_shape
beautiful.taglist_shape_border_width
beautiful.taglist_shape_border_color
beautiful.taglist_shape_empty
beautiful.taglist_shape_border_width_empty
beautiful.taglist_shape_border_color_empty
beautiful.taglist_shape_focus
beautiful.taglist_shape_border_width_focus
beautiful.taglist_shape_border_color_focus
beautiful.taglist_shape_urgent
beautiful.taglist_shape_border_width_urgent
beautiful.taglist_shape_border_color_urgent
beautiful.taglist_shape_volatile
beautiful.taglist_shape_border_width_volatile
beautiful.taglist_shape_border_color_volatile

Object properties

🔗 screen screen
The taglist screen.

Constraints:

Default value : Obtained from the constructor.
Type description:
screen : A valid screen object such as retured by awful.screen.focused() or mouse.screen.
integer : A screen global id. Avoid using this since they are unsorted.
string : The "primary" value is also valid.
🔗 base_layout wibox.layout
Set the taglist layout.

Constraints:

Default value : wibox.layout.fixed.horizontal

See also:

wibox.layout.fixed.horizontal Creates and returns a new horizontal fixed layout. (wibox.layout.fixed) constructors
🔗 count number · 1 signal · read only
The current number of tags.

Note that the taglist is usually lazy-loaded. Reading this property may cause the widgets to be created. Depending on where the property is called from, it might, in theory, cause an infinite loop.

Constraints:

Default value : This current number of tags.
Negative allowed : false
Valid values : The number of tags.

Click to display more

Emit signals:

  • property::count When the count value changes.
    • self awful.widget.taglist The object which changed (useful when connecting many object to the same callback).
    • new_value count The new value affected to the property.
🔗 update_function function
An alternative function to configure the content.

You should use widget_template if it fits your use case first. This API is very low level.

Constraints:

Default value : The default function delegate everything to the widget_template.
Function prototype:
Parameters:
layout (widget) : The base layout object.
buttons (table) : The buttons for this tag entry (see below).
label (string) : The tag name.
data (table) : Arbitrary metadate.
tags (table) : The list of tags (ordered).
metadata (table) : Other values.
Return : The function returns nothing.
🔗 filter function or nil
A function to restrict the content of the taglist.

Constraints:

Default value : nil
Function prototype:
Parameters:
t (tag) : The tag to accept or reject.
Return (boolean) : true if the tag is accepter or false if it is rejected.

See also:

source The function used to gather the group of tags. object properties
awful.widget.taglist.filter.noempty Filtering function to include all nonempty tags on the screen. list filters
awful.widget.taglist.filter.selected Filtering function to include selected tags on the screen. list filters
awful.widget.taglist.filter.all Filtering function to include all tags on the screen. list filters
awful.widget.taglist.source.for_screen All tags for the defined screen ordered by indices. list source functions
🔗 source function
The function used to gather the group of tags.

Constraints:

Default value : awful.widget.taglist.source.for_screen
Function prototype:
Parameters:
s (screen) : The taglist screen.
metadata (table) : Various metadata.
Return (table) : The list of tags

See also:

filter A function to restrict the content of the taglist. object properties
awful.widget.taglist.source.for_screen All tags for the defined screen ordered by indices. list source functions
🔗 widget_template template or nil
A template used to generate the individual tag widgets.

Constraints:

Default value : nil
Type description:
table : A table containing a widget tree definition. WARNING: This is really a table and NOT a widget object. Use the widget = come.class.here to define the topmost class rather than construct an instance.
🔗 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:

wibox.widget.base.all_children
🔗 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:

wibox.widget.base.children
🔗 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:

wibox.widget.base.forced_width
🔗 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:

wibox.widget.base.forced_height
🔗 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:

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

Constraints:

Default value : true
Valid values : true or false.

See also:

wibox.widget.base.opacity
🔗 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

Object methods

🔗 :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().
🔗 :connect_signal (name, func) · Inherited from gears.object
Connect to a signal.

Parameters:

Name Type(s) Description
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 Type(s) Description
name string The name of the signal.
func function The callback to call when the signal is emitted.
🔗 :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".
🔗 :disconnect_signal (name, func) · Inherited from gears.object
Disconnect from a signal.

Parameters:

Name Type(s) Description
name string The name of the signal.
func function The callback that should be disconnected.

Theme variables

🔗 beautiful.taglist_fg_focus color
The tag list main foreground (text) color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_bg_focus color
The tag list main background color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_fg_urgent color
The tag list urgent elements foreground (text) color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_bg_urgent color
The tag list urgent elements background color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_bg_occupied color
The tag list occupied elements background color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_fg_occupied color
The tag list occupied elements foreground (text) color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_bg_empty color
The tag list empty elements background color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_fg_empty color
The tag list empty elements foreground (text) color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_bg_volatile color
The tag list volatile elements background color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_fg_volatile color
The tag list volatile elements foreground (text) color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_squares_sel surface
The selected elements background image.

See also:

gears.surface Utilities to integrate and manipulate Cairo drawing surfaces. module

Click to display more

Used by:
🔗 beautiful.taglist_squares_unsel surface
The unselected elements background image.

See also:

gears.surface Utilities to integrate and manipulate Cairo drawing surfaces. module

Click to display more

Used by:
🔗 beautiful.taglist_squares_sel_empty surface
The selected empty elements background image.

See also:

gears.surface Utilities to integrate and manipulate Cairo drawing surfaces. module

Click to display more

Used by:
🔗 beautiful.taglist_squares_unsel_empty surface
The unselected empty elements background image.

See also:

gears.surface Utilities to integrate and manipulate Cairo drawing surfaces. module

Click to display more

Used by:
🔗 beautiful.taglist_squares_resize boolean
If the background images can be resized.
Click to display more

Used by:
🔗 beautiful.taglist_disable_icon boolean
Do not display the tag icons, even if they are set.
Click to display more

Used by:
🔗 beautiful.taglist_font string
The taglist font.
Click to display more

Used by:
🔗 beautiful.taglist_spacing number
The space between the taglist elements.

Type constraints:

Name Type(s) Description Default value
spacing Optional number The spacing between tags. 0

Click to display more

Used by:
🔗 beautiful.taglist_shape gears.shape
The main shape used for the elements. This will be the fallback for state specific shapes. To get a shape for the whole taglist, use wibox.container.background.

See also:

gears.shape Module dedicated to gather common shape painters. module
beautiful.taglist_shape_empty The shape used for the empty elements. theme variables
beautiful.taglist_shape_focus The shape used for the selected elements. theme variables
beautiful.taglist_shape_urgent The shape used for the urgent elements. theme variables
beautiful.taglist_shape_volatile The shape used for the volatile elements. theme variables

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_width number
The shape elements border width.

See also:

wibox.container.background A container capable of changing the background color, foreground color and widget shape. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_color color
The elements shape border color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_empty gears.shape
The shape used for the empty elements.

See also:

gears.shape Module dedicated to gather common shape painters. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_width_empty number
The shape used for the empty elements border width.

See also:

wibox.container.background A container capable of changing the background color, foreground color and widget shape. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_color_empty color
The empty elements shape border color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_focus gears.shape
The shape used for the selected elements.

See also:

gears.shape Module dedicated to gather common shape painters. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_width_focus number
The shape used for the selected elements border width.

See also:

wibox.container.background A container capable of changing the background color, foreground color and widget shape. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_color_focus color
The selected elements shape border color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_urgent gears.shape
The shape used for the urgent elements.

See also:

gears.shape Module dedicated to gather common shape painters. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_width_urgent number
The shape used for the urgent elements border width.

See also:

wibox.container.background A container capable of changing the background color, foreground color and widget shape. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_color_urgent color
The urgents elements shape border color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_volatile gears.shape
The shape used for the volatile elements.

See also:

gears.shape Module dedicated to gather common shape painters. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_width_volatile number
The shape used for the volatile elements border width.

See also:

wibox.container.background A container capable of changing the background color, foreground color and widget shape. module

Click to display more

Used by:
🔗 beautiful.taglist_shape_border_color_volatile color
The volatile elements shape border color.

See also:

gears.color This module simplifies the creation of cairo pattern objects. module

Click to display more

Used by:

List source functions

🔗 awful.widget.taglist.source.for_screen
All tags for the defined screen ordered by indices.

This is the default source.

See also:

screen A physical or virtual screen object. module

List filters

🔗 awful.widget.taglist.filter.noempty
Filtering function to include all nonempty tags on the screen.
Name Type(s) Description
t The tag.
🔗 awful.widget.taglist.filter.selected
Filtering function to include selected tags on the screen.
Name Type(s) Description
t The tag.
🔗 awful.widget.taglist.filter.all
Filtering function to include all tags on the screen.

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