Module: awful.titlebar

Create widget area on the edge of a client.

Create a titlebar

This example reproduces what the default rc.lua does. It shows how to handle the titlebars on a lower level.

-- Create a titlebar for the client.
-- By default, ruled.client will create one, but all it does is to call this
-- function.
local top_titlebar = awful.titlebar(c, {
    size      = 20,
    bg_normal = "#ff0000",
})

-- buttons for the titlebar
local buttons = gears.table.join(
    awful.button({ }, 1, function()
        client.focus = c
        c:raise()
        awful.mouse.client.move(c)
    end),
    awful.button({ }, 3, function()
        client.focus = c
        c:raise()
        awful.mouse.client.resize(c)
    end)
)

top_titlebar.widget = {
    { -- Left
        awful.titlebar.widget.iconwidget(c),
        buttons = buttons,
        layout  = wibox.layout.fixed.horizontal
    },
    { -- Middle
        { -- Title
            halign = "center",
            widget = awful.titlebar.widget.titlewidget(c)
        },
        buttons = buttons,
        layout  = wibox.layout.flex.horizontal
    },
    { -- Right
        awful.titlebar.widget.floatingbutton (c),
        awful.titlebar.widget.maximizedbutton(c),
        awful.titlebar.widget.stickybutton   (c),
        awful.titlebar.widget.ontopbutton    (c),
        awful.titlebar.widget.closebutton    (c),
        layout = wibox.layout.fixed.horizontal()
    },
    layout = wibox.layout.align.horizontal
}

Info:

  • Copyright: 2012 Uli Schlachter
  • Originally authored by: Uli Schlachter
    (Full contributors list available on our github project)

Constructors

awful.titlebar (c, args) Create a new titlebar for the given client.
awful.titlebar.widget.titlewidget (c) Create a new title widget.
awful.titlebar.widget.iconwidget (c) Create a new icon widget.
awful.titlebar.widget.button (c, name, selector, action) Create a new button widget.
awful.titlebar.widget.floatingbutton (c) Create a new float button for a client.
awful.titlebar.widget.maximizedbutton (c) Create a new maximize button for a client.
awful.titlebar.widget.minimizebutton (c) Create a new minimize button for a client.
awful.titlebar.widget.closebutton (c) Create a new closing button for a client.
awful.titlebar.widget.ontopbutton (c) Create a new ontop button for a client.
awful.titlebar.widget.stickybutton (c) Create a new sticky button for a client.

Static module functions

awful.titlebar.show (c, position) Show the client's titlebar.
awful.titlebar.hide (c, position) Hide the client's titlebar.
awful.titlebar.toggle (c, position) Toggle the client's titlebar, hiding it if it is visible, otherwise showing it.

Object methods

:setup {[args]} Set a declarative widget hierarchy description.

Theme variables

beautiful.titlebar_fg_normal color The titlebar foreground (text) color.
beautiful.titlebar_bg_normal color The titlebar background color.
beautiful.titlebar_bgimage_normal gears.surface or string The titlebar background image image.
beautiful.titlebar_fg color The titlebar foreground (text) color.
beautiful.titlebar_bg color The titlebar background color.
beautiful.titlebar_bgimage gears.surface or string The titlebar background image image.
beautiful.titlebar_fg_focus color The focused titlebar foreground (text) color.
beautiful.titlebar_bg_focus color The focused titlebar background color.
beautiful.titlebar_bgimage_focus gears.surface or string The focused titlebar background image image.
beautiful.titlebar_fg_urgent color The urgent titlebar foreground (text) color.
beautiful.titlebar_bg_urgent color The urgent titlebar background color.
beautiful.titlebar_bgimage_urgent gears.surface or string The urgent titlebar background image.
beautiful.titlebar_floating_button_normal gears.surface or string The normal non-floating button image.
beautiful.titlebar_maximized_button_normal gears.surface or string The normal non-maximized button image.
beautiful.titlebar_minimize_button_normal gears.surface or string The normal minimize button image.
beautiful.titlebar_minimize_button_normal_hover gears.surface or string The hovered minimize button image.
beautiful.titlebar_minimize_button_normal_press gears.surface or string The pressed minimize button image.
beautiful.titlebar_close_button_normal gears.surface or string The normal close button image.
beautiful.titlebar_close_button_normal_hover gears.surface or string The hovered close button image.
beautiful.titlebar_close_button_normal_press gears.surface or string The pressed close button image.
beautiful.titlebar_ontop_button_normal gears.surface or string The normal non-ontop button image.
beautiful.titlebar_sticky_button_normal gears.surface or string The normal non-sticky button image.
beautiful.titlebar_floating_button_focus gears.surface or string The focused client non-floating button image.
beautiful.titlebar_maximized_button_focus gears.surface or string The focused client non-maximized button image.
beautiful.titlebar_minimize_button_focus gears.surface or string The focused client minimize button image.
beautiful.titlebar_minimize_button_focus_hover gears.surface or string The hovered+focused client minimize button image.
beautiful.titlebar_minimize_button_focus_press gears.surface or string The pressed+focused minimize button image.
beautiful.titlebar_close_button_focus gears.surface or string The focused client close button image.
beautiful.titlebar_close_button_focus_hover gears.surface or string The hovered+focused close button image.
beautiful.titlebar_close_button_focus_press gears.surface or string The pressed+focused close button image.
beautiful.titlebar_ontop_button_focus gears.surface or string The focused client non-ontop button image.
beautiful.titlebar_sticky_button_focus gears.surface or string The focused client sticky button image.
beautiful.titlebar_floating_button_normal_active gears.surface or string The normal floating button image.
beautiful.titlebar_floating_button_normal_active_hover gears.surface or string The hovered floating client button image.
beautiful.titlebar_floating_button_normal_active_press gears.surface or string The pressed floating client button image.
beautiful.titlebar_maximized_button_normal_active gears.surface or string The maximized client button image.
beautiful.titlebar_maximized_button_normal_active_hover gears.surface or string The hozered+maximized client button image.
beautiful.titlebar_maximized_button_normal_active_press gears.surface or string The pressed+maximized button image.
beautiful.titlebar_ontop_button_normal_active gears.surface or string The ontop button image.
beautiful.titlebar_ontop_button_normal_active_hover gears.surface or string The hovered+ontop client button image.
beautiful.titlebar_ontop_button_normal_active_press gears.surface or string The pressed+ontop client button image.
beautiful.titlebar_sticky_button_normal_active gears.surface or string The sticky button image.
beautiful.titlebar_sticky_button_normal_active_hover gears.surface or string The hovered+sticky button image.
beautiful.titlebar_sticky_button_normal_active_press gears.surface or string The pressed+sticky client button image.
beautiful.titlebar_floating_button_focus_active gears.surface or string The floating+focused client button image.
beautiful.titlebar_floating_button_focus_active_hover gears.surface or string The hovered+floating+focused button image.
beautiful.titlebar_floating_button_focus_active_press gears.surface or string The pressed+floating+focused button image.
beautiful.titlebar_maximized_button_focus_active gears.surface or string The maximized+focused button image.
beautiful.titlebar_maximized_button_focus_active_hover gears.surface or string The hovered+maximized+focused button image.
beautiful.titlebar_maximized_button_focus_active_press gears.surface or string The pressed+maximized+focused button image.
beautiful.titlebar_ontop_button_focus_active gears.surface or string The ontop+focused button image.
beautiful.titlebar_ontop_button_focus_active_hover gears.surface or string The hovered+ontop+focused button image.
beautiful.titlebar_ontop_button_focus_active_press gears.surface or string The pressed+ontop+focused button image.
beautiful.titlebar_sticky_button_focus_active gears.surface or string The sticky+focused button image.
beautiful.titlebar_sticky_button_focus_active_hover gears.surface or string The hovered+sticky+focused button image.
beautiful.titlebar_sticky_button_focus_active_press gears.surface or string The pressed+sticky+focused button image.
beautiful.titlebar_floating_button_normal_inactive gears.surface or string The inactive+floating button image.
beautiful.titlebar_floating_button_normal_inactive_hover gears.surface or string The hovered+inactive+floating button image.
beautiful.titlebar_floating_button_normal_inactive_press gears.surface or string The pressed+inactive+floating button image.
beautiful.titlebar_maximized_button_normal_inactive gears.surface or string The inactive+maximized button image.
beautiful.titlebar_maximized_button_normal_inactive_hover gears.surface or string The hovered+inactive+maximized button image.
beautiful.titlebar_maximized_button_normal_inactive_press gears.surface or string The pressed+maximized+inactive button image.
beautiful.titlebar_ontop_button_normal_inactive gears.surface or string The inactive+ontop button image.
beautiful.titlebar_ontop_button_normal_inactive_hover gears.surface or string The hovered+inactive+ontop button image.
beautiful.titlebar_ontop_button_normal_inactive_press gears.surface or string The pressed+inactive+ontop button image.
beautiful.titlebar_sticky_button_normal_inactive gears.surface or string The inactive+sticky button image.
beautiful.titlebar_sticky_button_normal_inactive_hover gears.surface or string The hovered+inactive+sticky button image.
beautiful.titlebar_sticky_button_normal_inactive_press gears.surface or string The pressed+inactive+sticky button image.
beautiful.titlebar_floating_button_focus_inactive gears.surface or string The inactive+focused+floating button image.
beautiful.titlebar_floating_button_focus_inactive_hover gears.surface or string The hovered+inactive+focused+floating button image.
beautiful.titlebar_floating_button_focus_inactive_press gears.surface or string The pressed+inactive+focused+floating button image.
beautiful.titlebar_maximized_button_focus_inactive gears.surface or string The inactive+focused+maximized button image.
beautiful.titlebar_maximized_button_focus_inactive_hover gears.surface or string The hovered+inactive+focused+maximized button image.
beautiful.titlebar_maximized_button_focus_inactive_press gears.surface or string The pressed+inactive+focused+maximized button image.
beautiful.titlebar_ontop_button_focus_inactive gears.surface or string The inactive+focused+ontop button image.
beautiful.titlebar_ontop_button_focus_inactive_hover gears.surface or string The hovered+inactive+focused+ontop button image.
beautiful.titlebar_ontop_button_focus_inactive_press gears.surface or string The pressed+inactive+focused+ontop button image.
beautiful.titlebar_sticky_button_focus_inactive gears.surface or string The inactive+focused+sticky button image.
beautiful.titlebar_sticky_button_focus_inactive_hover gears.surface or string The hovered+inactive+focused+sticky button image.
beautiful.titlebar_sticky_button_focus_inactive_press gears.surface or string The pressed+inactive+focused+sticky button image.
beautiful.titlebar_tooltip_messages_close string The message in the close button tooltip.
beautiful.titlebar_tooltip_messages_minimize string The message in the minimize button tooltip.
beautiful.titlebar_tooltip_messages_maximized_active string The message in the maximize button tooltip when the client is maximized.
beautiful.titlebar_tooltip_messages_maximized_inactive string The message in the maximize button tooltip when the client is unmaximized.
beautiful.titlebar_tooltip_messages_floating_active string The message in the floating button tooltip when then client is floating.
beautiful.titlebar_tooltip_messages_floating_inactive string The message in the floating button tooltip when then client isn't floating.
beautiful.titlebar_tooltip_messages_ontop_active string The message in the onTop button tooltip when the client is onTop.
beautiful.titlebar_tooltip_messages_ontop_inactive string The message in the onTop button tooltip when client isn't onTop.
beautiful.titlebar_tooltip_messages_sticky_active string The message in the sticky button tooltip when the client is sticky.
beautiful.titlebar_tooltip_messages_sticky_inactive string The message in the sticky button tooltip when the client isn't sticky.
beautiful.titlebar_tooltip_delay_show integer The delay in second before the titlebar buttons tooltip is shown.
beautiful.titlebar_tooltip_margins_leftright integer The inner left and right margins for tooltip messages.
beautiful.titlebar_tooltip_margins_topbottom integer The inner top and bottom margins for the tooltip messages.
beautiful.titlebar_tooltip_timeout number The time in second before invoking the timer_function callback.
beautiful.titlebar_tooltip_align string The text horizontal alignment in tooltips.

Fields

awful.titlebar.enable_tooltip boolean Show tooltips when hover on titlebar buttons.
awful.titlebar.fallback_name string Title to display if client name is not set.


Constructors

🔗 awful.titlebar (c, args) · 12 theme variables

Create a new titlebar for the given client.

Every client can hold up to four titlebars, one for each side (i.e. each value of args.position).

If this constructor is called again with the same values for the client (c) and the titlebar position (args.position), the previous titlebar will be removed and replaced by the new one.

 -- Create default titlebar.
 awful.titlebar(c)

 -- Create titlebar on the client's bottom edge.
 awful.titlebar(c, { position = "bottom" })

 -- Create titlebar with inverted colors.
 awful.titlebar(c, { bg_normal = beautiful.fg_normal, fg_normal = beautiful.bg_normal })

Parameters:

Name Type(s) Description Default value
c client The client the titlebar will be attached to. Not applicable
args Optional table A table with extra arguments for the titlebar. {}
size Optional number The size of the titlebar. Will be interpreted as height for horizontal titlebars or as width for vertical titlebars. font.height*1.5
position Optional string Possible values are "top", "left", "right" and "bottom". "top"
bg_normal Optional string Undefined
bg_focus Optional string Undefined
bg_urgent Optional string Undefined
bgimage_normal Optional string Undefined
bgimage_focus Optional string Undefined
fg_normal Optional string Undefined
fg_focus Optional string Undefined
fg_urgent Optional string Undefined
font Optional string Undefined

Returns:

    wibox.drawable The newly created titlebar object.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_fg_normal
beautiful.titlebar_bg_normal
beautiful.titlebar_bgimage_normal
beautiful.titlebar_fg
beautiful.titlebar_bg
beautiful.titlebar_bgimage
beautiful.titlebar_fg_focus
beautiful.titlebar_bg_focus
beautiful.titlebar_bgimage_focus
beautiful.titlebar_fg_urgent
beautiful.titlebar_bg_urgent
beautiful.titlebar_bgimage_urgent
🔗 awful.titlebar.widget.titlewidget (c)
Create a new title widget.

A title widget displays the name of a client. Please note that this returns a textbox and all of textbox' API is available. This way, you can e.g. modify the font that is used.

Parameters:

Name Type(s) Description
c client The client for which a titlewidget should be created.

Returns:

    The title widget.
🔗 awful.titlebar.widget.iconwidget (c)
Create a new icon widget.

An icon widget displays the icon of a client. Please note that this returns an imagebox and all of the imagebox' API is available. This way, you can e.g. disallow resizes.

Parameters:

Name Type(s) Description
c client The client for which an icon widget should be created.

Returns:

    The icon widget.
🔗 awful.titlebar.widget.button (c, name, selector, action) · 15 theme variables
Create a new button widget.

A button widget displays an image and reacts to mouse clicks. Please note that the caller has to make sure that this widget gets redrawn when needed by calling the returned widget's :update() method. The selector function should return a value describing a state. If the value is a boolean, either "active" or "inactive" are used. The actual image is then found in the theme as titlebar_[name]_button_[normal/focus]_[state]. If that value does not exist, the focused state is ignored for the next try.

Parameters:

Name Type(s) Description
c client The client for which a button is created.
name string Name of the button, used for accessing the theme and in the tooltip.
selector function A function that selects the image that should be displayed.
action function Function that is called when the button is clicked.

Returns:

    wibox.widget The widget

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_tooltip_messages_close
beautiful.titlebar_tooltip_messages_minimize
beautiful.titlebar_tooltip_messages_maximized_active
beautiful.titlebar_tooltip_messages_maximized_inactive
beautiful.titlebar_tooltip_messages_floating_active
beautiful.titlebar_tooltip_messages_floating_inactive
beautiful.titlebar_tooltip_messages_ontop_active
beautiful.titlebar_tooltip_messages_ontop_inactive
beautiful.titlebar_tooltip_messages_sticky_active
beautiful.titlebar_tooltip_messages_sticky_inactive
beautiful.titlebar_tooltip_delay_show
beautiful.titlebar_tooltip_margins_leftright
beautiful.titlebar_tooltip_margins_topbottom
beautiful.titlebar_tooltip_timeout
beautiful.titlebar_tooltip_align
🔗 awful.titlebar.widget.floatingbutton (c) · 14 theme variables
Create a new float button for a client.

Parameters:

Name Type(s) Description
c client The client for which the button is wanted.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_floating_button_normal
beautiful.titlebar_floating_button_focus
beautiful.titlebar_floating_button_normal_active
beautiful.titlebar_floating_button_normal_active_hover
beautiful.titlebar_floating_button_normal_active_press
beautiful.titlebar_floating_button_focus_active
beautiful.titlebar_floating_button_focus_active_hover
beautiful.titlebar_floating_button_focus_active_press
beautiful.titlebar_floating_button_normal_inactive
beautiful.titlebar_floating_button_normal_inactive_hover
beautiful.titlebar_floating_button_normal_inactive_press
beautiful.titlebar_floating_button_focus_inactive
beautiful.titlebar_floating_button_focus_inactive_hover
beautiful.titlebar_floating_button_focus_inactive_press
🔗 awful.titlebar.widget.maximizedbutton (c) · 14 theme variables
Create a new maximize button for a client.

Parameters:

Name Type(s) Description
c client The client for which the button is wanted.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_maximized_button_focus_active
beautiful.titlebar_maximized_button_focus_active_hover
beautiful.titlebar_maximized_button_focus_active_press
beautiful.titlebar_maximized_button_normal_inactive
beautiful.titlebar_maximized_button_normal_inactive_hover
beautiful.titlebar_maximized_button_normal_inactive_press
beautiful.titlebar_maximized_button_focus_inactive
beautiful.titlebar_maximized_button_focus_inactive_hover
beautiful.titlebar_maximized_button_focus_inactive_press
beautiful.titlebar_maximized_button_normal
beautiful.titlebar_maximized_button_focus
beautiful.titlebar_maximized_button_normal_active
beautiful.titlebar_maximized_button_normal_active_hover
beautiful.titlebar_maximized_button_normal_active_press
🔗 awful.titlebar.widget.minimizebutton (c) · 6 theme variables
Create a new minimize button for a client.

Parameters:

Name Type(s) Description
c client The client for which the button is wanted.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_minimize_button_normal
beautiful.titlebar_minimize_button_normal_hover
beautiful.titlebar_minimize_button_normal_press
beautiful.titlebar_minimize_button_focus
beautiful.titlebar_minimize_button_focus_hover
beautiful.titlebar_minimize_button_focus_press
🔗 awful.titlebar.widget.closebutton (c) · 6 theme variables
Create a new closing button for a client.

Parameters:

Name Type(s) Description
c client The client for which the button is wanted.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_close_button_normal
beautiful.titlebar_close_button_normal_hover
beautiful.titlebar_close_button_normal_press
beautiful.titlebar_close_button_focus
beautiful.titlebar_close_button_focus_hover
beautiful.titlebar_close_button_focus_press
🔗 awful.titlebar.widget.ontopbutton (c) · 14 theme variables
Create a new ontop button for a client.

Parameters:

Name Type(s) Description
c client The client for which the button is wanted.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_ontop_button_normal
beautiful.titlebar_ontop_button_focus
beautiful.titlebar_ontop_button_normal_active
beautiful.titlebar_ontop_button_normal_active_hover
beautiful.titlebar_ontop_button_normal_active_press
beautiful.titlebar_ontop_button_focus_active
beautiful.titlebar_ontop_button_focus_active_hover
beautiful.titlebar_ontop_button_focus_active_press
beautiful.titlebar_ontop_button_normal_inactive
beautiful.titlebar_ontop_button_normal_inactive_hover
beautiful.titlebar_ontop_button_normal_inactive_press
beautiful.titlebar_ontop_button_focus_inactive
beautiful.titlebar_ontop_button_focus_inactive_hover
beautiful.titlebar_ontop_button_focus_inactive_press
🔗 awful.titlebar.widget.stickybutton (c) · 14 theme variables
Create a new sticky button for a client.

Parameters:

Name Type(s) Description
c client The client for which the button is wanted.

Click to display more

Consumed theme variables:

Theme variable Usage
beautiful.titlebar_sticky_button_normal
beautiful.titlebar_sticky_button_focus
beautiful.titlebar_sticky_button_normal_active
beautiful.titlebar_sticky_button_normal_active_hover
beautiful.titlebar_sticky_button_normal_active_press
beautiful.titlebar_sticky_button_focus_active
beautiful.titlebar_sticky_button_focus_active_hover
beautiful.titlebar_sticky_button_focus_active_press
beautiful.titlebar_sticky_button_normal_inactive
beautiful.titlebar_sticky_button_normal_inactive_hover
beautiful.titlebar_sticky_button_normal_inactive_press
beautiful.titlebar_sticky_button_focus_inactive
beautiful.titlebar_sticky_button_focus_inactive_hover
beautiful.titlebar_sticky_button_focus_inactive_press

Static module functions

🔗 awful.titlebar.show (c, position) · 1 permission
Show the client's titlebar.

Parameters:

Name Type(s) Description Default value
c client The client whose titlebar is modified Not applicable
position Optional string The position of the titlebar. Must be one of "left", "right", "top", "bottom". "top"

Click to display more

Requested actions or permissions:

Class Permission Context Default Description
clienttitlebarsshowgrantedCalled when awful.titlebar.show is called.
🔗 awful.titlebar.hide (c, position)
Hide the client's titlebar.

Parameters:

Name Type(s) Description Default value
c client The client whose titlebar is modified Not applicable
position Optional string The position of the titlebar. Must be one of "left", "right", "top", "bottom". "top"
🔗 awful.titlebar.toggle (c, position) · 1 permission
Toggle the client's titlebar, hiding it if it is visible, otherwise showing it.

Parameters:

Name Type(s) Description Default value
c client The client whose titlebar is modified Not applicable
position Optional string The position of the titlebar. Must be one of "left", "right", "top", "bottom". "top"

Click to display more

Requested actions or permissions:

Class Permission Context Default Description
clienttitlebarstogglegrantedCalled when awful.titlebar.toggle is called.

Object methods

🔗 :setup {[args]}
Set a declarative widget hierarchy description.

See The declarative layout system

Parameters:

Name Type(s) Description
args table An array containing the widgets disposition

Theme variables

🔗 beautiful.titlebar_fg_normal color
The titlebar foreground (text) color.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_bg_normal color
The titlebar background color.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_bgimage_normal gears.surface or string
The titlebar background image image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_fg color
The titlebar foreground (text) color.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_bg color
The titlebar background color.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_bgimage gears.surface or string
The titlebar background image image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_fg_focus color
The focused titlebar foreground (text) color.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_bg_focus color
The focused titlebar background color.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_bgimage_focus gears.surface or string
The focused titlebar background image image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_fg_urgent color
The urgent titlebar foreground (text) color.

See also:

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

Click to display more

Used by:

  • awful.titlebar Create a new titlebar for the given client.
  • urgent Set to `true` when the client ask for attention.
🔗 beautiful.titlebar_bg_urgent color
The urgent titlebar background color.

See also:

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

Click to display more

Used by:

  • awful.titlebar Create a new titlebar for the given client.
  • urgent Set to `true` when the client ask for attention.
🔗 beautiful.titlebar_bgimage_urgent gears.surface or string
The urgent titlebar background image.

See also:

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

Click to display more

Used by:

  • awful.titlebar Create a new titlebar for the given client.
  • urgent Set to `true` when the client ask for attention.
🔗 beautiful.titlebar_floating_button_normal gears.surface or string
The normal non-floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_normal gears.surface or string
The normal non-maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_minimize_button_normal gears.surface or string
The normal minimize button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_minimize_button_normal_hover gears.surface or string
The hovered minimize button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_minimize_button_normal_press gears.surface or string
The pressed minimize button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_close_button_normal gears.surface or string
The normal close button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_close_button_normal_hover gears.surface or string
The hovered close button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_close_button_normal_press gears.surface or string
The pressed close button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_normal gears.surface or string
The normal non-ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_normal gears.surface or string
The normal non-sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_focus gears.surface or string
The focused client non-floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_focus gears.surface or string
The focused client non-maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_minimize_button_focus gears.surface or string
The focused client minimize button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_minimize_button_focus_hover gears.surface or string
The hovered+focused client minimize button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_minimize_button_focus_press gears.surface or string
The pressed+focused minimize button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_close_button_focus gears.surface or string
The focused client close button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_close_button_focus_hover gears.surface or string
The hovered+focused close button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_close_button_focus_press gears.surface or string
The pressed+focused close button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_focus gears.surface or string
The focused client non-ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_focus gears.surface or string
The focused client sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_normal_active gears.surface or string
The normal floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_normal_active_hover gears.surface or string
The hovered floating client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_normal_active_press gears.surface or string
The pressed floating client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_normal_active gears.surface or string
The maximized client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_normal_active_hover gears.surface or string
The hozered+maximized client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_normal_active_press gears.surface or string
The pressed+maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_normal_active gears.surface or string
The ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_normal_active_hover gears.surface or string
The hovered+ontop client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_normal_active_press gears.surface or string
The pressed+ontop client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_normal_active gears.surface or string
The sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_normal_active_hover gears.surface or string
The hovered+sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_normal_active_press gears.surface or string
The pressed+sticky client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_focus_active gears.surface or string
The floating+focused client button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_focus_active_hover gears.surface or string
The hovered+floating+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_focus_active_press gears.surface or string
The pressed+floating+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_focus_active gears.surface or string
The maximized+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_focus_active_hover gears.surface or string
The hovered+maximized+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_focus_active_press gears.surface or string
The pressed+maximized+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_focus_active gears.surface or string
The ontop+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_focus_active_hover gears.surface or string
The hovered+ontop+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_focus_active_press gears.surface or string
The pressed+ontop+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_focus_active gears.surface or string
The sticky+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_focus_active_hover gears.surface or string
The hovered+sticky+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_focus_active_press gears.surface or string
The pressed+sticky+focused button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_normal_inactive gears.surface or string
The inactive+floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_normal_inactive_hover gears.surface or string
The hovered+inactive+floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_normal_inactive_press gears.surface or string
The pressed+inactive+floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_normal_inactive gears.surface or string
The inactive+maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_normal_inactive_hover gears.surface or string
The hovered+inactive+maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_normal_inactive_press gears.surface or string
The pressed+maximized+inactive button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_normal_inactive gears.surface or string
The inactive+ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_normal_inactive_hover gears.surface or string
The hovered+inactive+ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_normal_inactive_press gears.surface or string
The pressed+inactive+ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_normal_inactive gears.surface or string
The inactive+sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_normal_inactive_hover gears.surface or string
The hovered+inactive+sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_normal_inactive_press gears.surface or string
The pressed+inactive+sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_focus_inactive gears.surface or string
The inactive+focused+floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_focus_inactive_hover gears.surface or string
The hovered+inactive+focused+floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_floating_button_focus_inactive_press gears.surface or string
The pressed+inactive+focused+floating button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_focus_inactive gears.surface or string
The inactive+focused+maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_focus_inactive_hover gears.surface or string
The hovered+inactive+focused+maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_maximized_button_focus_inactive_press gears.surface or string
The pressed+inactive+focused+maximized button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_focus_inactive gears.surface or string
The inactive+focused+ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_focus_inactive_hover gears.surface or string
The hovered+inactive+focused+ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_ontop_button_focus_inactive_press gears.surface or string
The pressed+inactive+focused+ontop button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_focus_inactive gears.surface or string
The inactive+focused+sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_focus_inactive_hover gears.surface or string
The hovered+inactive+focused+sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_sticky_button_focus_inactive_press gears.surface or string
The pressed+inactive+focused+sticky button image.

See also:

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

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_close string
The message in the close button tooltip.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_minimize string
The message in the minimize button tooltip.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_maximized_active string
The message in the maximize button tooltip when the client is maximized.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_maximized_inactive string
The message in the maximize button tooltip when the client is unmaximized.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_floating_active string
The message in the floating button tooltip when then client is floating.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_floating_inactive string
The message in the floating button tooltip when then client isn't floating.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_ontop_active string
The message in the onTop button tooltip when the client is onTop.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_ontop_inactive string
The message in the onTop button tooltip when client isn't onTop.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_sticky_active string
The message in the sticky button tooltip when the client is sticky.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_messages_sticky_inactive string
The message in the sticky button tooltip when the client isn't sticky.

See also:

awful.titlebar Create widget area on the edge of a client. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_delay_show integer
The delay in second before the titlebar buttons tooltip is shown. It is used as the delay_show parameter passed to the awful.tooltip constructor function.

See also:

awful.tooltip Tooltip module for awesome objects. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_margins_leftright integer
The inner left and right margins for tooltip messages. It is used as the margins_leftright parameter passed to the awful.tooltip constructor function.

See also:

awful.tooltip Tooltip module for awesome objects. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_margins_topbottom integer
The inner top and bottom margins for the tooltip messages. It is used as the margins_topbottom parameter passed to the awful.tooltip constructor function.

See also:

awful.tooltip Tooltip module for awesome objects. module

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_timeout number
The time in second before invoking the timer_function callback. It is used as the timeout parameter passed to the awful.tooltip constructor function.

See also:

awful.tooltip.timeout Change the tooltip's update interval. (awful.tooltip) object properties

Click to display more

Used by:

🔗 beautiful.titlebar_tooltip_align string

The text horizontal alignment in tooltips. It is used as the align parameter passed to the awful.tooltip constructor function.

Valid values are:

  • "right"
  • "top_right"
  • "left"
  • "bottom_left"
  • "top_left"
  • "bottom"
  • "top"

See also:

awful.tooltip Tooltip module for awesome objects. module

Click to display more

Used by:

Fields

🔗 awful.titlebar.enable_tooltip boolean
Show tooltips when hover on titlebar buttons.
🔗 awful.titlebar.fallback_name string
Title to display if client name is not set.
generated by LDoc 1.4.6