Widget objects

Widgets are small scripts that are used to provide content or add functionality to the bar. Some widgets will expose commands in order for functionality to be triggered indirectly (e.g. via a keypress).

Widgets can access the parent bar and screen via the command graph.

AGroupBox

class libqtile.widget.groupbox.AGroupBox

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["agroupbox"].<command>()

qtile cmd-obj -o widget agroupbox -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Backlight

class libqtile.widget.backlight.Backlight

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["backlight"].<command>()

qtile cmd-obj -o widget backlight -f <command>

The following commands are available for this object:

change_backlight(direction[, step])
commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

change_backlight(direction, step=None)

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Battery

class libqtile.widget.battery.Battery

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["battery"].<command>()

qtile cmd-obj -o widget battery -f <command>

The following commands are available for this object:

charge_dynamically()
charge_to_full()
commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

charge_dynamically()

charge_to_full()

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

BatteryIcon

class libqtile.widget.battery.BatteryIcon

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["batteryicon"].<command>()

qtile cmd-obj -o widget batteryicon -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

Bluetooth

class libqtile.widget.bluetooth.Bluetooth

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["bluetooth"].<command>()

qtile cmd-obj -o widget bluetooth -f <command>

The following commands are available for this object:

click()	Perform default action on visible item.
commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
scroll_down()	Scroll down to next item.
scroll_up()	Scroll up to next item.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

click()

Perform default action on visible item.

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

scroll_down()

Scroll down to next item.

scroll_up()

Scroll up to next item.

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CPU

class libqtile.widget.cpu.CPU

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["cpu"].<command>()

qtile cmd-obj -o widget cpu -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CPUGraph

class libqtile.widget.graph.CPUGraph

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["cpugraph"].<command>()

qtile cmd-obj -o widget cpugraph -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

Canto

class libqtile.widget.canto.Canto

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["canto"].<command>()

qtile cmd-obj -o widget canto -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CapsNumLockIndicator

class libqtile.widget.caps_num_lock_indicator.CapsNumLockIndicator

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["capsnumlockindicator"].<command>()

qtile cmd-obj -o widget capsnumlockindicator -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CheckUpdates

class libqtile.widget.check_updates.CheckUpdates

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["checkupdates"].<command>()

qtile cmd-obj -o widget checkupdates -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Chord

class libqtile.widget.chord.Chord

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["chord"].<command>()

qtile cmd-obj -o widget chord -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Clipboard

class libqtile.widget.clipboard.Clipboard

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["clipboard"].<command>()

qtile cmd-obj -o widget clipboard -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Clock

class libqtile.widget.clock.Clock

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["clock"].<command>()

qtile cmd-obj -o widget clock -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
update_timezone([timezone])	Force the clock to update timezone information.
use_system_timezone()	Force clock to use system timezone.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

update_timezone(timezone: str | tzinfo | None = None)

Force the clock to update timezone information.

If the method is called with no arguments then the widget will reload the timzeone set on the computer (e.g. via timedatectl set-timezone ..). This will have no effect if you have previously set a timezone value.

Alternatively, you can pass a timezone string (e.g. "Europe/Lisbon") to change the specified timezone. Setting this to an empty string will cause the clock to rely on the system timezone.

use_system_timezone()

Force clock to use system timezone.

Cmus

class libqtile.widget.cmus.Cmus

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["cmus"].<command>()

qtile cmd-obj -o widget cmus -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Countdown

class libqtile.widget.countdown.Countdown

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["countdown"].<command>()

qtile cmd-obj -o widget countdown -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CryptoTicker

class libqtile.widget.crypto_ticker.CryptoTicker

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["cryptoticker"].<command>()

qtile cmd-obj -o widget cryptoticker -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CurrentLayout

class libqtile.widget.currentlayout.CurrentLayout

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["currentlayout"].<command>()

qtile cmd-obj -o widget currentlayout -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CurrentLayoutIcon

class libqtile.widget.currentlayout.CurrentLayoutIcon

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["currentlayouticon"].<command>()

qtile cmd-obj -o widget currentlayouticon -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

CurrentScreen

class libqtile.widget.currentscreen.CurrentScreen

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["currentscreen"].<command>()

qtile cmd-obj -o widget currentscreen -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

DF

class libqtile.widget.df.DF

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["df"].<command>()

qtile cmd-obj -o widget df -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

DoNotDisturb

class libqtile.widget.do_not_disturb.DoNotDisturb

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["donotdisturb"].<command>()

qtile cmd-obj -o widget donotdisturb -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

GenPollCommand

class libqtile.widget.generic_poll_text.GenPollCommand

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["genpollcommand"].<command>()

qtile cmd-obj -o widget genpollcommand -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

GenPollText

class libqtile.widget.generic_poll_text.GenPollText

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["genpolltext"].<command>()

qtile cmd-obj -o widget genpolltext -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

GenPollUrl

class libqtile.widget.generic_poll_text.GenPollUrl

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["genpollurl"].<command>()

qtile cmd-obj -o widget genpollurl -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

GmailChecker

class libqtile.widget.gmail_checker.GmailChecker

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["gmailchecker"].<command>()

qtile cmd-obj -o widget gmailchecker -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

GroupBox

class libqtile.widget.groupbox.GroupBox

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["groupbox"].<command>()

qtile cmd-obj -o widget groupbox -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

HDDBusyGraph

class libqtile.widget.graph.HDDBusyGraph

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["hddbusygraph"].<command>()

qtile cmd-obj -o widget hddbusygraph -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

HDDGraph

class libqtile.widget.graph.HDDGraph

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["hddgraph"].<command>()

qtile cmd-obj -o widget hddgraph -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

IdleRPG

class libqtile.widget.idlerpg.IdleRPG

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["idlerpg"].<command>()

qtile cmd-obj -o widget idlerpg -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Image

class libqtile.widget.image.Image

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["image"].<command>()

qtile cmd-obj -o widget image -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
update(filename)

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

update(filename)

ImapWidget

class libqtile.widget.imapwidget.ImapWidget

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["imapwidget"].<command>()

qtile cmd-obj -o widget imapwidget -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

KeyboardKbdd

class libqtile.widget.keyboardkbdd.KeyboardKbdd

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["keyboardkbdd"].<command>()

qtile cmd-obj -o widget keyboardkbdd -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

KeyboardLayout

class libqtile.widget.keyboardlayout.KeyboardLayout

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["keyboardlayout"].<command>()

qtile cmd-obj -o widget keyboardlayout -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
next_keyboard()	set the next layout in the list of configured keyboard layouts as new current layout in use
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

next_keyboard()

set the next layout in the list of configured keyboard layouts as new current layout in use

If the current keyboard layout is not in the list, it will set as new layout the first one in the list.

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

KhalCalendar

class libqtile.widget.khal_calendar.KhalCalendar

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["khalcalendar"].<command>()

qtile cmd-obj -o widget khalcalendar -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

LaunchBar

class libqtile.widget.launchbar.LaunchBar

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["launchbar"].<command>()

qtile cmd-obj -o widget launchbar -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

Load

class libqtile.widget.load.Load

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["load"].<command>()

qtile cmd-obj -o widget load -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
next_load()
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

next_load()

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Maildir

class libqtile.widget.maildir.Maildir

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["maildir"].<command>()

qtile cmd-obj -o widget maildir -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Memory

class libqtile.widget.memory.Memory

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["memory"].<command>()

qtile cmd-obj -o widget memory -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

MemoryGraph

class libqtile.widget.graph.MemoryGraph

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["memorygraph"].<command>()

qtile cmd-obj -o widget memorygraph -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

Mirror

class libqtile.widget.base.Mirror

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["mirror"].<command>()

qtile cmd-obj -o widget mirror -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

Moc

class libqtile.widget.moc.Moc

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["moc"].<command>()

qtile cmd-obj -o widget moc -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Mpd2

class libqtile.widget.mpd2widget.Mpd2

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["mpd2"].<command>()

qtile cmd-obj -o widget mpd2 -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Mpris2

class libqtile.widget.mpris2widget.Mpris2

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["mpris2"].<command>()

qtile cmd-obj -o widget mpris2 -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	What's the current state of the widget?
items(name)	Build a list of contained items for the given item class.
next()	Play the next track.
play_pause()	Toggle the playback status.
previous()	Play the previous track.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
stop()	Stop playback.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

What's the current state of the widget?

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

next() → None

Play the next track.

play_pause() → None

Toggle the playback status.

previous() → None

Play the previous track.

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

stop() → None

Stop playback.

Net

class libqtile.widget.net.Net

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["net"].<command>()

qtile cmd-obj -o widget net -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

NetGraph

class libqtile.widget.graph.NetGraph

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["netgraph"].<command>()

qtile cmd-obj -o widget netgraph -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

Notify

class libqtile.widget.notify.Notify

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["notify"].<command>()

qtile cmd-obj -o widget notify -f <command>

The following commands are available for this object:

clear([reason])	Clear the notification
commands()	Returns a list of possible commands for this object
display()
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
invoke()	Invoke the notification's default action
items(name)	Build a list of contained items for the given item class.
next()
prev()	Show previous notification.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
toggle()	Toggle showing/clearing the notification

Command documentation

clear(reason=2)

Clear the notification

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

display()

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

invoke()

Invoke the notification's default action

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

next()

prev()

Show previous notification.

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

toggle()

Toggle showing/clearing the notification

NvidiaSensors

class libqtile.widget.nvidia_sensors.NvidiaSensors

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["nvidiasensors"].<command>()

qtile cmd-obj -o widget nvidiasensors -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

OpenWeather

class libqtile.widget.open_weather.OpenWeather

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["openweather"].<command>()

qtile cmd-obj -o widget openweather -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Pomodoro

class libqtile.widget.pomodoro.Pomodoro

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["pomodoro"].<command>()

qtile cmd-obj -o widget pomodoro -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
toggle_active()
toggle_break()

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

toggle_active()

toggle_break()

Prompt

class libqtile.widget.prompt.Prompt

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["prompt"].<command>()

qtile cmd-obj -o widget prompt -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
exec_general(prompt, object_name, cmd_name)	Execute a cmd of any object.
fake_keypress(key)
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Returns a dictionary of info for this object
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

exec_general(prompt, object_name, cmd_name, selector=None, completer=None)

Execute a cmd of any object. For example layout, group, window, widget , etc with a string that is obtained from start_input.

Parameters:

prompt

Text displayed at the prompt.

object_name

Name of a object in Qtile. This string has to be 'layout', 'widget', 'bar', 'window' or 'screen'.

cmd_name

Execution command of selected object using object_name and selector.

selector

This value select a specific object within a object list that is obtained by object_name. If this value is None, current object is selected. e.g. current layout, current window and current screen.

completer:

Completer to use.

config example:

Key([alt, 'shift'], 'a',

lazy.widget['prompt'].exec_general(

'section(add)', 'layout', 'add_section'))

fake_keypress(key: str) → None

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Returns a dictionary of info for this object

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

PulseVolume

class libqtile.widget.pulse_volume.PulseVolume

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["pulsevolume"].<command>()

qtile cmd-obj -o widget pulsevolume -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
decrease_vol([value])	Decrease volume.
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
increase_vol([value])	Increase volume.
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
mute()	Mute the sound device.
run_app()
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

decrease_vol(value=None)

Decrease volume.

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

increase_vol(value=None)

Increase volume.

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

mute()

Mute the sound device.

run_app()

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

QuickExit

class libqtile.widget.quick_exit.QuickExit

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["quickexit"].<command>()

qtile cmd-obj -o widget quickexit -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
trigger()

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

trigger()

ScreenSplit

class libqtile.widget.screensplit.ScreenSplit

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["screensplit"].<command>()

qtile cmd-obj -o widget screensplit -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
get()	Retrieve the text in a TextBox widget
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
update(text)	Update the widget text.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

get()

Retrieve the text in a TextBox widget

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

update(text)

Update the widget text.

Sep

class libqtile.widget.sep.Sep

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["sep"].<command>()

qtile cmd-obj -o widget sep -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

She

class libqtile.widget.she.She

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["she"].<command>()

qtile cmd-obj -o widget she -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Spacer

class libqtile.widget.spacer.Spacer

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["spacer"].<command>()

qtile cmd-obj -o widget spacer -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

StatusNotifier

class libqtile.widget.statusnotifier.StatusNotifier

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["statusnotifier"].<command>()

qtile cmd-obj -o widget statusnotifier -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

StockTicker

class libqtile.widget.stock_ticker.StockTicker

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["stockticker"].<command>()

qtile cmd-obj -o widget stockticker -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

SwapGraph

class libqtile.widget.graph.SwapGraph

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["swapgraph"].<command>()

qtile cmd-obj -o widget swapgraph -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

Systray

class libqtile.widget.systray.Systray

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["systray"].<command>()

qtile cmd-obj -o widget systray -f <command>

The following commands are available for this object:

_window_mask
commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
focus([warp])	Focuses the window.
function(function, *args, **kwargs)	Call a function with current object as argument
get_hints()	Returns the X11 hints (WM_HINTS and WM_SIZE_HINTS) for this window.
inspect()	Tells you more than you ever wanted to know about a window
items(name)	Build a list of contained items for the given item class.
keep_above([enable])
keep_below([enable])
kill()
move_down([force])
move_to_bottom([force])
move_to_top([force])
move_up([force])
place(x, y, width, height, borderwidth, ...)	Places the window at the specified location with the given size.

Command documentation

_window_mask(**kwargs)

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.__int__(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal. >>> int('0b100', base=0) 4

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

focus(warp: bool = True) → None

Focuses the window.

function(function, *args, **kwargs) → None

Call a function with current object as argument

get_hints()

Returns the X11 hints (WM_HINTS and WM_SIZE_HINTS) for this window.

inspect()

Tells you more than you ever wanted to know about a window

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

keep_above(enable: bool | None = None)

keep_below(enable: bool | None = None)

kill()

move_down(force=False)

move_to_bottom(force=False)

move_to_top(force=False)

move_up(force=False)

place(x, y, width, height, borderwidth, bordercolor, above=False, margin=None, respect_hints=False)

Places the window at the specified location with the given size.

Parameters:

x: int

y: int

width: int

height: int

borderwidth: int

bordercolor: string

above: bool, optional

margin: int or list, optional

space around window as int or list of ints [N E S W]

above: bool, optional

If True, the geometry will be adjusted to respect hints provided by the client.

TaskList

class libqtile.widget.tasklist.TaskList

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["tasklist"].<command>()

qtile cmd-obj -o widget tasklist -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

TextBox

class libqtile.widget.textbox.TextBox

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["textbox"].<command>()

qtile cmd-obj -o widget textbox -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
get()	Retrieve the text in a TextBox widget
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
update(text)	Update the widget text.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

get()

Retrieve the text in a TextBox widget

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

update(text)

Update the widget text.

ThermalSensor

class libqtile.widget.sensors.ThermalSensor

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["thermalsensor"].<command>()

qtile cmd-obj -o widget thermalsensor -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

ThermalZone

class libqtile.widget.thermal_zone.ThermalZone

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["thermalzone"].<command>()

qtile cmd-obj -o widget thermalzone -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Volume

class libqtile.widget.volume.Volume

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["volume"].<command>()

qtile cmd-obj -o widget volume -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
decrease_vol()
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
increase_vol()
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
mute()
run_app()
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

decrease_vol()

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

increase_vol()

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

mute()

run_app()

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Wallpaper

class libqtile.widget.wallpaper.Wallpaper

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["wallpaper"].<command>()

qtile cmd-obj -o widget wallpaper -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

WidgetBox

class libqtile.widget.widgetbox.WidgetBox

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["widgetbox"].<command>()

qtile cmd-obj -o widget widgetbox -f <command>

The following commands are available for this object:

close()	Close the widgetbox.
commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
open()	Open the widgetbox.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.
toggle()	Toggle box state

Command documentation

close()

Close the widgetbox.

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

open()

Open the widgetbox.

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

toggle()

Toggle box state

WindowCount

class libqtile.widget.window_count.WindowCount

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["windowcount"].<command>()

qtile cmd-obj -o widget windowcount -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
get()	Retrieve the current text.
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

get()

Retrieve the current text.

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

WindowName

class libqtile.widget.windowname.WindowName

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["windowname"].<command>()

qtile cmd-obj -o widget windowname -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

WindowTabs

class libqtile.widget.windowtabs.WindowTabs

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["windowtabs"].<command>()

qtile cmd-obj -o widget windowtabs -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Wlan

class libqtile.widget.wlan.Wlan

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["wlan"].<command>()

qtile cmd-obj -o widget wlan -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.

Wttr

class libqtile.widget.wttr.Wttr

API commands

To access commands on this object via the command graph, use one of the following options:

lazy.widget["wttr"].<command>()

qtile cmd-obj -o widget wttr -f <command>

The following commands are available for this object:

commands()	Returns a list of possible commands for this object
doc(name)	Returns the documentation for a specified command name
eval(code)	Evaluates code in the same context as this function
force_update()	Immediately poll the widget.
function(function, *args, **kwargs)	Call a function with current object as argument
info()	Info for this object.
items(name)	Build a list of contained items for the given item class.
set_font([font, fontsize, fontshadow])	Change the font used by this widget.

Command documentation

commands() → list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

doc(name) → str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

eval(code: str) → tuple[bool, str | None]

Evaluates code in the same context as this function

Return value is tuple (success, result), success being a boolean and result being a string representing the return value of eval, or None if exec was used instead.

force_update()

Immediately poll the widget. Existing timers are unaffected.

function(function, *args, **kwargs) → None

Call a function with current object as argument

info()

Info for this object.

items(name: str) → tuple[bool, list[str | int] | None]

Build a list of contained items for the given item class.

Exposing this allows __qsh__ to navigate the command graph.

Returns a tuple (root, items) for the specified item class, where:

root: True if this class accepts a "naked" specification without an item seletion (e.g. "layout" defaults to current layout), and False if it does not (e.g. no default "widget").

items: a list of contained items

set_font(font=UNSPECIFIED, fontsize=UNSPECIFIED, fontshadow=UNSPECIFIED)

Change the font used by this widget. If font is None, the current font is used.