Screen objects

Screens are the display area that holds bars and an active group. Screen commands include changing the current group and changing the wallpaper.

Screens can access objects displayed on that screen e.g. bar, widgets, groups, layouts and windows.

class libqtile.config.Screen

API commands

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

lazy.screen.<command>()

qtile cmd-obj -o screen -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()	Returns a dictionary of info for this screen.
items(name)	Build a list of contained items for the given item class.
next_group([skip_empty, skip_managed, warp])	Switch to the next group
prev_group([skip_empty, skip_managed, warp])	Switch to the previous group
resize([x, y, w, h])
set_wallpaper(path[, mode])	Set the wallpaper to the given file.
toggle_group([group_name, warp])	Switch to the selected group or to the previously active one

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) → Task | None

Call a function with current object as argument

info() → dict[str, int]

Returns a dictionary of info for this screen.

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_group(skip_empty: bool = False, skip_managed: bool = False, warp: bool = True) → None

Switch to the next group

prev_group(skip_empty: bool = False, skip_managed: bool = False, warp: bool = True) → None

Switch to the previous group

resize(x: int | None = None, y: int | None = None, w: int | None = None, h: int | None = None) → None

set_wallpaper(path: str, mode: str | None = None) → None

Set the wallpaper to the given file.

toggle_group(group_name: str | None = None, warp: bool = True) → None

Switch to the selected group or to the previously active one