awesome

• Index

Contents

• Constructors
• Object properties
• Object methods
• Deprecated object properties
• Signals

Widgets

• awful.widget.button
• awful.widget.clienticon
• awful.widget.keyboardlayout
• awful.widget.launcher
• awful.widget.layoutbox
• awful.widget.layoutlist
• awful.widget.prompt
• awful.widget.taglist
• awful.widget.tasklist
• awful.widget.watch
• naughty.list.actions
• naughty.list.notifications
• naughty.widget.icon
• naughty.widget.message
• naughty.widget.title
• wibox.widget.calendar
• wibox.widget.checkbox
• wibox.widget.graph
• wibox.widget.imagebox
• wibox.widget.piechart
• wibox.widget.progressbar
• wibox.widget.separator
• wibox.widget.slider
• wibox.widget.systray
• wibox.widget.textbox
• wibox.widget.textclock

Core components

• awesome
• awful.keygrabber
• client and awful.client
• drawable
• gears.timer
• mousegrabber
• naughty.action
• naughty.notification
• root
• screen and awful.screen
• tag and awful.tag

Input handling

• awful.button
• awful.key
• awful.keyboard
• mouse

Declarative rules

• ruled.client
• ruled.notifications

Widget containers

• awful.widget.only_on_screen
• naughty.widget.background
• wibox.container.arcchart
• wibox.container.background
• wibox.container.border
• wibox.container.constraint
• wibox.container.margin
• wibox.container.mirror
• wibox.container.place
• wibox.container.radialprogressbar
• wibox.container.rotate
• wibox.container.scroll
• wibox.container.tile

Widget layouts

• wibox.layout.align
• wibox.layout.fixed
• wibox.layout.flex
• wibox.layout.grid
• wibox.layout.manual
• wibox.layout.ratio
• wibox.layout.stack

Popups and bars

• awful.hotkeys_popup.widget
• awful.menu
• awful.popup
• awful.titlebar
• awful.tooltip
• awful.wallpaper
• awful.wibar
• awful.widget.calendar_popup
• menubar
• naughty.layout.box
• naughty.layout.legacy
• wibox

Utility libraries

• gears.debug
• gears.filesystem
• gears.geometry
• gears.math
• gears.object
• gears.protected_call
• gears.sort
• gears.string
• gears.table
• gears.wallpaper

Theme related libraries

• beautiful
• gears.color
• gears.shape

Libraries

• awful.completion
• awful.hotkeys_popup
• awful.layout
• awful.permissions
• awful.placement
• awful.prompt
• awful.rules
• awful.spawn
• awful.util
• dbus
• gears.matcher
• gears.surface
• menubar.menu_gen
• menubar.utils
• naughty
• selection
• wibox.widget

Sample files

• rc.lua
• theme.lua

Classes

• awful.screenshot
• awful.widget.common
• gears.cache
• gears.matrix
• menubar.icon_theme
• menubar.index_theme
• wibox.hierarchy
• wibox.widget.base
• xproperties

Documentation

• Authors
• Readme
• Contributing
• The Widget system
• Creating new widget
• Default configuration file documentation
• Change Awesome appearance
• My first Awesome
• The AwesomeWM client layout system
• Startup options
• Building and Testing
• Using Cairo and LGI
• Tips for upgrading your configuration
• NEWS
• FAQ

Module: naughty.widget.message

A notification content message widget.

This widget is a specialized wibox.widget.textbox with the following extra features:

• Honor the beautiful notification variables.
• React to the naughty.notification object message changes.

Usage:

local notif = naughty.notification {
    title   = "A notification",
    message = "This notification no actions!",
    icon    = beautiful.awesome_icon,
}

wibox.widget {
    notification = notif,
    widget       = naughty.widget.message,
}

Constructors

Object properties

Object methods

Deprecated object properties

Signals

Constructors

🔗 naughty.widget.message {[args]} · 2 theme variables

Create a new naughty.widget.message.

Parameters:

Note: This constructors uses named parameters calling convention. It means you call it with {} and omit the parantheses. For example, calling this will all default argument would be naughty.widget.message{}. This is a Lua shortcut syntax equivalent to naughty.widget.message({}). args is only a placeholder name for the "lone table argument" used in named parameters calls.

Name		Type(s)	Description
args		table
notification		naughty.notification	The notification.

Click to display more

Consumed theme variables:

Theme variable	Usage
beautiful.notification_fg
beautiful.notification_font

Object properties

🔗 notification naughty.notification · 1 signal

The attached notification.

Constraints:

Default value	: This is usually set in the construtor.

Click to display more

Emit signals:

• property::notification When the notification value changes.
• self naughty.widget.message The object which changed (useful when connecting many object to the same callback).
• new_value notification The new value affected to the property.

🔗 markup string · Inherited from wibox.widget.textbox · 1 signal

Set the HTML text of the textbox.

The main difference between text and markup is that markup is able to render a small subset of HTML tags. See the Pango markup) documentation to see what is and isn't valid in this property.

 local w = wibox.widget {
     markup = "This is some <i>text</i>, <b>HTML tags</b> <u>WILL</u> work.",
     widget = wibox.widget.textbox,
 }

The wibox.widget.textbox colors are usually set by wrapping into a wibox.container.background widget, but can also be done using the markup:

 local w = wibox.widget {
     markup = "<span background='#ff0000' foreground='#0000ff'>Some</span>"..
       " nice <span foreground='#00ff00'>colors!</span>",
     widget = wibox.widget.textbox,
 }

Constraints:

Default value	: self.text
Valid values	: The text to set. This can contain pango markup (e.g. <b>bold</b>). You can use gears.string.escape to escape parts of it.

See also:

text	Set a textbox plain text.	object properties

Click to display more

Emit signals:

• property::markup When the markup value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value markup The new value affected to the property.

🔗 text string · Inherited from wibox.widget.textbox · 1 signal

Set a textbox plain text.

This property renders the text as-is, it does not interpret it:

 local w = wibox.widget {
     text   = "This is some <i>text</i>, <b>HTML tags</b> will <u>NOT</u> work.",
     widget = wibox.widget.textbox,
 }

One exception are the control characters, which are interpreted:

 local w = wibox.widget {
     text   = "This is some text\nover\nmultiple lines!",
     widget = wibox.widget.textbox,
 }

Constraints:

Default value	: ""
Valid values	: The text to display. Pango markup is ignored and shown as-is.

See also:

markup	Set the HTML text of the textbox.	object properties

Click to display more

Emit signals:

• property::text When the text value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value text The new value affected to the property.

🔗 ellipsize string · Inherited from wibox.widget.textbox · 1 signal

Set the text ellipsize mode.

See Pango for additional details: Layout.set_ellipsize

Constraints:

Default value	: "end"
Valid values:
"start"
"middle"
"end"
"none"

Usage:

widget{
    text = "This is a very long text, that cannot be displayed fully.",
    ellipsize = "start",
    widget = wibox.widget.textbox,
},
widget{
    text = "This is a very long text, that cannot be displayed fully.",
    ellipsize = "end",
    widget = wibox.widget.textbox,
},
widget{
    text = "This is a very long text, that cannot be displayed fully.",
    ellipsize = "middle",
    widget = wibox.widget.textbox,
},
widget{
    text = "This is a very long text, that cannot be displayed fully.",
    ellipsize = "none",
    valign = "top",
    widget = wibox.widget.textbox,
}

Click to display more

Emit signals:

• property::ellipsize When the ellipsize value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value ellipsize The new value affected to the property.

🔗 wrap string · Inherited from wibox.widget.textbox · 1 signal

Set a textbox wrap mode.

Constraints:

Default value	: "word_char"
Valid values:	: Where to wrap? After "word", "char" or "word_char".
"word"
"char"
"word_char"

Usage:

for _, wrap in ipairs {"word", "char", "word_char"} do
    local w = wibox.widget {
        wrap   = wrap,
        text   = "Notable dinausors: Tyrannosaurus-Rex, Triceratops, Velociraptor, Sauropods, Archaeopteryx.",
        widget = wibox.widget.textbox,
    }
end

Click to display more

Emit signals:

• property::wrap When the wrap value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value wrap The new value affected to the property.

🔗 valign string · Inherited from wibox.widget.textbox · 1 signal

The vertical text alignment.

This aligns the text within the widget's bounds. In some situations this may differ from aligning the widget with wibox.container.place.

Constraints:

Default value	: "center"
Valid values:
"top"
"center"
"bottom"

Usage:

for _, valign in ipairs {"top", "center", "bottom"} do
    local w = wibox.widget {
        valign = valign,
        text   = "some text",
        widget = wibox.widget.textbox,
    }
end

Click to display more

Emit signals:

• property::valign When the valign value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value valign The new value affected to the property.

🔗 halign string · Inherited from wibox.widget.textbox · 1 signal

The horizontal text alignment.

This aligns the text within the widget's bounds. In some situations this may differ from aligning the widget with wibox.container.place.

Constraints:

Default value	: "left"
Valid values:
"left"
"center"
"right"

Usage:

for _, align in ipairs {"left", "center", "right"} do
    local w = wibox.widget {
        halign = align,
        text   = "some text",
        widget = wibox.widget.textbox,
    }
end

Click to display more

Emit signals:

• property::halign When the halign value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value halign The new value affected to the property.

🔗 font font · Inherited from wibox.widget.textbox · 1 signal · 1 theme variable

Set a textbox font.

There is multiple valid font string representation. The most precise is XFT. It is also possible to use the family name, followed by the face and size such as Monospace Bold 10. This script lists the fonts present on your system:

#!/usr/bin/env lua

local lgi = require("lgi")
local pangocairo = lgi.PangoCairo

local font_map = pangocairo.font_map_get_default()

for k, v in pairs(font_map:list_families()) do
    print(v:get_name(), "monospace?: "..tostring(v:is_monospace()))
    for k2, v2 in ipairs(v:list_faces()) do
        print("    ".. v2:get_face_name())
    end
end

Save this script somewhere on your system, chmod +x it and run it. It will list something like:

Sans    monospace?: false
    Regular
    Bold
    Italic
    Bold Italic

In this case, the font could be Sans 10 or Sans Bold Italic 10.

Here are examples of several font families:

Usage example output:

sans 0 sans NORMAL NORMAL
Roboto, Bold 0 Roboto NORMAL NORMAL
DejaVu Sans, Oblique 0 DejaVu Sans NORMAL OBLIQUE
Noto Mono, Regular 0 Noto Mono NORMAL NORMAL

Usage example:

local pango = require("lgi").Pango
local fonts = {
    "sans",
    "Roboto, Bold",
    "DejaVu Sans, Oblique",
    "Noto Mono, Regular"
}

for _, font in ipairs(fonts) do
    local w = wibox.widget {
        font   = font,
        text   = "The quick brown fox jumps over the lazy dog!",
        widget = wibox.widget.textbox,
    }

    -- Use the low level Pango API to validate the font was parsed properly.
    local desc = pango.FontDescription.from_string(w.font)
    print(
        string.format(
            "%s %d %s %s %s",
            w.font,
            desc:get_size(),
            desc:get_family(),
            desc:get_variant(),
            desc:get_style()
         )
    )
end

The font size is a number at the end of the font description string:

for _, font in ipairs { "sans 8", "sans 10", "sans 12", "sans 14" } do
    local w = wibox.widget {
        font   = font,
        text   = "The quick brown fox jumps over the lazy dog!",
        widget = wibox.widget.textbox,
    }
end

Constraints:

Default value	: beautiful.font
Type description:
string	: A Pango font description.
string	: An XFT string, such as "--dejavu sans mono-medium-r-normal---80-----iso10646-1".

Click to display more

Emit signals:

• property::font When the font value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value font The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.font	The default font.
beautiful.font

🔗 line_spacing_factor number or nil · Inherited from wibox.widget.textbox · 1 signal

Set the distance between the lines.

Constraints:

Default value	: nil
Type description:
nil	: Automatic (most probably 1.0).
Unit	: Distance between lines as a ratio of the line height. 1.0 means no spacing. Less than 1.0 will squash the lines and more than 1.0 will move them further apart.
Negative allowed	: false

Usage:

for _, spacing in ipairs {0.0, 0.1, 0.5, 0.9, 1, 1.5, 2.0, 2.5} do
    local text = "This text has a line\nspacing of "..tostring(spacing).. "\nunits."

    widget{
        text                = text,
        font                = "sans 10",
        line_spacing_factor = spacing,
        widget              = wibox.widget.textbox,
    }
end

Please note that the Pango version (one of AwesomeWM dependency) must be at
least 1.44 for this to work.

Click to display more

Emit signals:

• property::line_spacing_factor When the line_spacing_factor value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value line_spacing_factor The new value affected to the property.

🔗 justify boolean · Inherited from wibox.widget.textbox · 1 signal

Justify the text when there is more space.

Constraints:

Default value	: false
Valid values	: true or false.

Usage:

local lorem_ipsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed "..
    "do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad "..
    "minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex "..
    "ea commodo consequat."

widget{
    text    = lorem_ipsum,
    justify = false,
    widget  = wibox.widget.textbox,
}

widget{
    text    = lorem_ipsum,
    justify = true,
    widget  = wibox.widget.textbox,
}

Click to display more

Emit signals:

• property::justify When the justify value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value justify The new value affected to the property.

🔗 indent number · Inherited from wibox.widget.textbox · 1 signal

How to indent text with multiple lines.

Note that this does nothing if align == "center".

Constraints:

Default value	: 0.0
Unit	: points
Negative allowed	: true

Usage:

local lorem_ipsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed "..
    "do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad "..
    "minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex "..
    "ea commodo consequat."
for _, indent in ipairs { -10, 0, 10 } do
    widget{
        text   = lorem_ipsum,
        indent = indent,
        widget = wibox.widget.textbox,
    }
end

Click to display more

Emit signals:

• property::indent When the indent value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value indent The new value affected to the property.

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

🔗 :get_preferred_size (s) -> (number, number) · Inherited from wibox.widget.textbox

Get the preferred size of a textbox.

This returns the size that the textbox would use if infinite space were available.

Parameters:

Name		Type(s)	Description
s		integer or screen	The screen on which the textbox will be displayed.

Returns:

1. number The preferred width.
2. number The preferred height.

🔗 :get_height_for_width (width, s) -> number · Inherited from wibox.widget.textbox

Get the preferred height of a textbox at a given width.

This returns the height that the textbox would use when it is limited to the given width.

Parameters:

Name		Type(s)	Description
width		number	The available width.
s		integer or screen	The screen on which the textbox will be displayed.

Returns:

number The needed height.

🔗 :get_preferred_size_at_dpi (dpi) -> (number, number) · Inherited from wibox.widget.textbox

Get the preferred size of a textbox.

This returns the size that the textbox would use if infinite space were available.

Parameters:

Name		Type(s)	Description
dpi		number	The DPI value to render at.

Returns:

1. number The preferred width.
2. number The preferred height.

🔗 :get_height_for_width_at_dpi (width, dpi) -> number · Inherited from wibox.widget.textbox

Get the preferred height of a textbox at a given width.

This returns the height that the textbox would use when it is limited to the given width.

Parameters:

Name		Type(s)	Description
width		number	The available width.
dpi		number	The DPI value to render at.

Returns:

number The needed height.

🔗 :set_markup_silently (text) -> boolean or (boolean, string) · Inherited from wibox.widget.textbox

Set the text of the textbox.(with Pango markup).

Parameters:

Name		Type(s)	Description
text		string	The text to set. This can contain pango markup (e.g. <b>bold</b>). You can use gears.string.escape to escape parts of it.

Returns:

boolean true

Or

1. boolean false
2. string Error message explaining why the markup was invalid.

🔗 :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.

Deprecated object properties

🔗 align string · Inherited from wibox.widget.textbox · 1 signal

The horizontal text alignment.

Renamed to halign for consistency with other APIs.

Click to display more

Emit signals:

• property::align When the align value changes.
• self wibox.widget.textbox The object which changed (useful when connecting many object to the same callback).
• new_value align The new value affected to the property.

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