Class awful.widget.taglist

Taglist widget module for awful

Info:

Functions

awful.taglist (screen, filter, buttons[, style={}[, update_function=nil[, base_widget=nil]]]) Create a new taglist widget.
taglist.filter.noempty (t) Filtering function to include all nonempty tags on the screen.
taglist.filter.selected (t) Filtering function to include selected tags on the screen.
taglist.filter.all () Filtering function to include all tags on the screen.

Theme variables

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


Functions

Methods
awful.taglist (screen, filter, buttons[, style={}[, update_function=nil[, base_widget=nil]]])
Create a new taglist widget. The last two arguments (update_function and base_widget) serve to customize the layout of the taglist (eg. to make it vertical). For that, you will need to copy the awful.widget.common.list_update function, make your changes to it and pass it as update_function here. Also change the base_widget if the default is not what you want.
  • screen The screen to draw taglist for.
  • filter Filter function to define what clients will be listed.
  • buttons A table with buttons binding to set.
  • style The style overrides default theme.
    • fg_focus string or pattern (default nil)
    • bg_focus string or pattern (default nil)
    • fg_urgent string or pattern (default nil)
    • bg_urgent string or pattern (default nil)
    • bg_occupied string or pattern (default nil)
    • fg_occupied string or pattern (default nil)
    • bg_empty string or pattern (default nil)
    • fg_empty string or pattern (default nil)
    • bg_volatile string or pattern (default nil)
    • fg_volatile string or pattern (default nil)
    • squares_sel string (default nil)
    • squares_unsel string (default nil)
    • squares_sel_empty string (default nil)
    • squares_unsel_empty string (default nil)
    • squares_resize string (default nil)
    • disable_icon string (default nil)
    • font string (default nil)
    • spacing number The spacing between tags. (default nil)
  • update_function Function to create a tag widget on each update. See awful.widget.common. (optional)
  • base_widget Optional container widget for tag widgets. Default is wibox.layout.fixed.horizontal().
    • bg_focus The background color for focused client.
    • fg_focus The foreground color for focused client.
    • bg_urgent The background color for urgent clients.
    • fg_urgent The foreground color for urgent clients.
    • squares_sel A user provided image for selected squares. (optional)
    • squares_unsel A user provided image for unselected squares. (optional)
    • squares_sel_empty A user provided image for selected squares for empty tags. (optional)
    • squares_unsel_empty A user provided image for unselected squares for empty tags. (optional)
    • squares_resize True or false to resize squares. (optional)
    • font The font.
taglist.filter.noempty (t)
Filtering function to include all nonempty tags on the screen.
  • t The tag.

Returns:

    true if t is not empty, else false
taglist.filter.selected (t)
Filtering function to include selected tags on the screen.
  • t The tag.

Returns:

    true if t is not empty, else false
taglist.filter.all ()
Filtering function to include all tags on the screen.

Returns:

    true

Theme variables

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

Type:

  • color (default fg_focus)

See also:

beautiful.taglist_bg_focus
The tag list main background color.

Type:

  • color (default bg_focus)

See also:

beautiful.taglist_fg_urgent
The tag list urgent elements foreground (text) color.

Type:

  • color (default fg_urgent)

See also:

beautiful.taglist_bg_urgent
The tag list urgent elements background color.

Type:

  • color (default bg_urgent)

See also:

beautiful.taglist_bg_occupied
The tag list occupied elements background color.

Type:

  • color

See also:

beautiful.taglist_fg_occupied
The tag list occupied elements foreground (text) color.

Type:

  • color

See also:

beautiful.taglist_bg_empty
The tag list empty elements background color.

Type:

  • color

See also:

beautiful.taglist_fg_empty
The tag list empty elements foreground (text) color.

Type:

  • color

See also:

beautiful.taglist_bg_volatile
The tag list volatile elements background color.

Type:

  • color

See also:

beautiful.taglist_fg_volatile
The tag list volatile elements foreground (text) color.

Type:

  • color

See also:

beautiful.taglist_squares_sel
The selected elements background image.

Type:

  • surface

See also:

beautiful.taglist_squares_unsel
The unselected elements background image.

Type:

  • surface

See also:

beautiful.taglist_squares_sel_empty
The selected empty elements background image.

Type:

  • surface

See also:

beautiful.taglist_squares_unsel_empty
The unselected empty elements background image.

Type:

  • surface

See also:

beautiful.taglist_squares_resize
If the background images can be resized.

Type:

  • boolean
beautiful.taglist_disable_icon
Do not display the tag icons, even if they are set.

Type:

  • boolean
beautiful.taglist_font
The taglist font.

Type:

  • string
beautiful.taglist_spacing
The space between the taglist elements.

Type:

  • spacing number The spacing between tags. (default 0)
beautiful.taglist_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:

beautiful.taglist_shape_border_width
The shape elements border width.

Type:

  • number (default 0)

See also:

beautiful.taglist_shape_border_color
The elements shape border color.

Type:

  • color

See also:

beautiful.taglist_shape_empty
The shape used for the empty elements.

See also:

beautiful.taglist_shape_border_width_empty
The shape used for the empty elements border width.

Type:

  • number (default 0)

See also:

beautiful.taglist_shape_border_color_empty
The empty elements shape border color.

Type:

  • color

See also:

beautiful.taglist_shape_focus
The shape used for the selected elements.

See also:

beautiful.taglist_shape_border_width_focus
The shape used for the selected elements border width.

Type:

  • number (default 0)

See also:

beautiful.taglist_shape_border_color_focus
The selected elements shape border color.

Type:

  • color

See also:

beautiful.taglist_shape_urgent
The shape used for the urgent elements.

See also:

beautiful.taglist_shape_border_width_urgent
The shape used for the urgent elements border width.

Type:

  • number (default 0)

See also:

beautiful.taglist_shape_border_color_urgent
The urgents elements shape border color.

Type:

  • color

See also:

beautiful.taglist_shape_volatile
The shape used for the volatile elements.

See also:

beautiful.taglist_shape_border_width_volatile
The shape used for the volatile elements border width.

Type:

  • number (default 0)

See also:

beautiful.taglist_shape_border_color_volatile
The volatile elements shape border color.

Type:

  • color

See also:

generated by LDoc 1.4.6 Last updated 2017-09-11 12:23:44