A group is a container for a bunch of windows, analogous to workspaces in other
window managers. Each client window managed by the window manager belongs to
exactly one group. The
groups config file variable should be initialized to
a list of
DGroup objects provide several options for group
configuration. Groups can be configured to show and hide themselves when
they're not empty, spawn applications for them when they start, automatically
acquire certain groups, and various other options.
from libqtile.config import Group, Match groups = [ Group("a"), Group("b"), Group("c", matches=[Match(wm_class=["Firefox"])]), ] # allow mod3+1 through mod3+0 to bind to groups; if you bind your groups # by hand in your config, you don't need to do this. from libqtile.dgroups import simple_key_binder dgroups_key_binder = simple_key_binder("mod3")
- class libqtile.config.Group(name: str, matches: Optional[list[libqtile.config.Match]] = None, exclusive=False, spawn: Optional[Union[str, list[str]]] = None, layout: Optional[str] = None, layouts: Optional[list] = None, persist=True, init=True, layout_opts=None, screen_affinity=None, position=9223372036854775807, label: Optional[str] = None)¶
Represents a "dynamic" group
These groups can spawn apps, only allow certain Matched windows to be on them, hide when they're not in use, etc. Groups are identified by their name.
- name: string
the name of this group
- matches: default ``None``
Matchobjects whose windows will be assigned to this group
- exclusive: boolean
when other apps are started in this group, should we allow them here or not?
- spawn: string or list of strings
this will be
exec()d when the group is created, you can pass either a program name or a list of programs to
- layout: string
the name of default layout for this group (e.g. 'max' or 'stack'). This is the name specified for a particular layout in config.py or if not defined it defaults in general the class name in all lower case.
- layouts: list
the group layouts list overriding global layouts. Use this to define a separate list of layouts for this particular group.
- persist: boolean
should this group stay alive with no member windows?
- init: boolean
is this group alive when qtile starts?
- position int
- label: string
the display name of the group. Use this to define a display name other than name of the group. If set to None, the display name is set to the name.
- libqtile.dgroups.simple_key_binder(mod, keynames=None)¶
Bind keys to mod+group position or to the keys specified as second argument
- class libqtile.config.Match(title=None, wm_class=None, role=None, wm_type=None, wm_instance_class=None, net_wm_pid=None, func: Callable[[base.WindowType], bool] | None = None, wid=None)¶
Match for dynamic groups or auto-floating windows.
It can match by title, wm_class, role, wm_type, wm_instance_class or net_wm_pid.
Matchsupports both regular expression objects (i.e. the result of
re.compile()) or strings (match as an "include"-match). If a window matches all specified values, it is considered a match.
matches against the WM_NAME atom (X11) or title (Wayland)
matches against the second string in WM_CLASS atom (X11) or app ID (Wayland)
matches against the WM_ROLE atom (X11 only)
matches against the WM_TYPE atom (X11 only)
matches against the first string in WM_CLASS atom (X11) or app ID (Wayland)
matches against the _NET_WM_PID atom (X11) or PID (Wayland) - (only int allowed for this rule)
delegate the match to the given function, which receives the tested client as argument and must return True if it matches, False otherwise
- class libqtile.config.Rule(match, group=None, float=False, intrusive=False, break_on_match=True)¶
How to act on a match
A Rule contains a list of Match objects, and a specification about what to do when any of them is matched.
Matchobject or a list of such associated with this
auto float this window?
override the group's exclusive setting?
Should we stop applying rules if this rule is matched?
ScratchPad and DropDown¶
ScratchPad is a special - by default invisible -
group which acts as a container for
configurations. A DropDown can be configured to spawn a defined process and
bind thats process' window to it. The associated window can then be shown and
hidden by the lazy command
(see Lazy objects) from the ScratchPad group.
Thus - for example - your favorite terminal emulator turns into a quake-like
terminal by the control of Qtile.
If the DropDown window turns visible it is placed as a floating window on top of the current group. If the DropDown is hidden, it is simply switched back to the ScratchPad group.
from libqtile.config import Group, ScratchPad, DropDown, Key from libqtile.command import lazy groups = [ ScratchPad("scratchpad", [ # define a drop down terminal. # it is placed in the upper third of screen by default. DropDown("term", "urxvt", opacity=0.8), # define another terminal exclusively for ``qtile shell` at different position DropDown("qtile shell", "urxvt -hold -e 'qtile shell'", x=0.05, y=0.4, width=0.9, height=0.6, opacity=0.9, on_focus_lost_hide=True) ]), Group("a"), ] keys = [ # toggle visibiliy of above defined DropDown named "term" Key(, 'F11', lazy.group['scratchpad'].dropdown_toggle('term')), Key(, 'F12', lazy.group['scratchpad'].dropdown_toggle('qtile shell')), ]
Note that if the window is set to not floating, it is detached from DropDown and ScratchPad, and a new process is spawned next time the DropDown is set visible.
Some programs run in a server-like mode where the spawned process does not
directly own the window that is created, which is instead created by a
background process. In this case, the window may not be correctly caught in the
scratchpad group. To work around this, you can pass a
to the corresponding
Dropdown. See below.
- class libqtile.config.ScratchPad(name, dropdowns=None, position=9223372036854775807, label='', single=False)¶
Represents a "ScratchPad" group
ScratchPad adds a (by default) invisible group to qtile. That group is used as a place for currently not visible windows spawned by a
- name: string
the name of this group
- dropdowns: default ``None``
list of DropDown objects
- position: int
- label: string
The display name of the ScratchPad group. Defaults to the empty string such that the group is hidden in
Only one of the window among the specified dropdowns will be visible at a time.
- class libqtile.config.DropDown(name, cmd, **config)¶
Configure a specified command and its associated window for the ScratchPad. That window can be shown and hidden using a configurable keystroke or any other scripted trigger.
Height of window as fraction of current screen.
config.Matchto identify the spawned window and move it to the scratchpad, instead of relying on the window's PID. This works around some programs that may not be caught by the window's PID if it does not match the PID of the spawned process.
Shall the window be hidden if focus is lost? If so, the DropDown is hidden if window focus or the group is changed.
Opacity of window as fraction. Zero is opaque.
Shall pointer warp to center of window on activation? This has only effect if any of the on_focus_lost_xxx configurations is True
Width of window as fraction of current screen width
X position of window as fraction of current screen width. 0 is the left most position.
Y position of window as fraction of current screen height. 0 is the top most position. To show the window at bottom, you have to configure a value < 1 and an appropriate height.