Source code for

# Copyright (c) 2012-2014 Tycho Andersen
# Copyright (c) 2013 xarvh
# Copyright (c) 2013 roger
# Copyright (c) 2013 Tao Sauvage
# Copyright (c) 2014 ramnes
# Copyright (c) 2014 Sean Vig
# Copyright (c) 2014 dequis
# Copyright (c) 2015 Dario Giovannetti
# Copyright (c) 2015 Alexander Lozovskoy
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

from __future__ import annotations

from typing import TYPE_CHECKING

from libqtile import hook, utils
from libqtile.backend.base import FloatStates
from libqtile.command.base import CommandObject, expose_command
from libqtile.log_utils import logger

    from libqtile.command.base import ItemT

[docs]class _Group(CommandObject): """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. A group is identified by its name but displayed in GroupBox widget by its label. """ def __init__(self, name, layout=None, label=None, screen_affinity=None): self.screen_affinity = screen_affinity = name self.label = name if label is None else label self.custom_layout = layout # will be set on _configure = [] self.tiled_windows = set() self.qtile = None self.layouts = [] self.floating_layout = None # self.focus_history lists the group's windows in the order they # received focus, from the oldest (first item) to the currently # focused window (last item); NB the list does *not* contain any # windows that never received focus; refer to for the # complete set self.focus_history = [] self.screen = None self.current_layout = None self.last_focused = None def _configure(self, layouts, floating_layout, qtile): self.screen = None self.current_layout = 0 self.focus_history = [] = [] self.qtile = qtile self.layouts = [i.clone(self) for i in layouts] self.floating_layout = floating_layout if self.custom_layout is not None: self.layout = self.custom_layout self.custom_layout = None @property def current_window(self): try: return self.focus_history[-1] except IndexError: # no window has focus return None @current_window.setter def current_window(self, win): try: self.focus_history.remove(win) except ValueError: # win has never received focus before pass self.focus_history.append(win) def _remove_from_focus_history(self, win): try: index = self.focus_history.index(win) except ValueError: # win has never received focus return False else: del self.focus_history[index] # return True if win was the last item (i.e. it was current_window) return index == len(self.focus_history) @property def layout(self): return self.layouts[self.current_layout] @layout.setter def layout(self, layout): """ Parameters ========== layout : a string with matching the name of a Layout object. """ for index, obj in enumerate(self.layouts): if == layout: self.current_layout = index"layout_change", self.layouts[self.current_layout], self) self.layout_all() return logger.error("No such layout: %s", layout) def use_layout(self, index): assert -len(self.layouts) <= index < len(self.layouts), "layout index out of bounds" self.layout.hide() self.current_layout = index % len(self.layouts)"layout_change", self.layouts[self.current_layout], self) self.layout_all() screen_rect = self.screen.get_rect() def use_next_layout(self): self.use_layout((self.current_layout + 1) % (len(self.layouts))) def use_previous_layout(self): self.use_layout((self.current_layout - 1) % (len(self.layouts))) def layout_all(self, warp=False): """Layout the floating layer, then the current layout. If we have have a current_window give it focus, optionally moving warp to it. """ if self.screen and with self.qtile.core.masked(): normal = [x for x in if not x.floating] floating = [x for x in if x.floating and not x.minimized] screen_rect = self.screen.get_rect() if normal: try: self.layout.layout(normal, screen_rect) except Exception: logger.exception("Exception in layout %s", if floating: self.floating_layout.layout(floating, screen_rect) if self.current_window and self.screen == self.qtile.current_screen: self.current_window.focus(warp) else: # Screen has lost focus so we reset record of focused window so # focus will warp when screen is focused again self.last_focused = None def set_screen(self, screen, warp=True): """Set this group's screen to screen""" if screen == self.screen: return self.screen = screen if self.screen: # move all floating guys offset to new screen self.floating_layout.to_screen(self, self.screen) self.layout_all(warp=warp and self.qtile.config.cursor_warp) screen_rect = self.screen.get_rect() else: self.hide() def hide(self): self.screen = None with self.qtile.core.masked(): for i in i.hide() self.layout.hide() def focus(self, win, warp=True, force=False): """Focus the given window If win is in the group, blur any windows and call ``focus`` on the layout (in case it wants to track anything), fire focus_change hook and invoke layout_all. Parameters ========== win : Window to focus warp : Warp pointer to win. This should basically always be True, unless the focus event is coming from something like EnterNotify, where the user is actively using the mouse, or on full screen layouts where only one window is "maximized" at a time, and it doesn't make sense for the mouse to automatically move. """ if self.qtile._drag and not force: # don't change focus while dragging windows (unless forced) return if win: if win not in return # ignore focus events if window is the current window if win is self.last_focused: warp = False self.current_window = win self.last_focused = self.current_window if win.floating: for layout in self.layouts: layout.blur() self.floating_layout.focus(win) else: self.floating_layout.blur() for layout in self.layouts: layout.focus(win)"focus_change") self.layout_all(warp)
[docs] @expose_command() def info(self): """Returns a dictionary of info for this group""" return dict(, label=self.label, if self.current_window else None, tiled_windows={ for i in self.tiled_windows}, windows=[ for i in], focus_history=[ for i in self.focus_history],, layouts=[ for i in self.layouts],, screen=self.screen.index if self.screen else None, )
def add(self, win, focus=True, force=False):"group_window_add", self, win) if win not in = self if self.qtile.config.auto_fullscreen and win.wants_to_fullscreen: win._float_state = FloatStates.FULLSCREEN elif self.floating_layout.match(win) and not win.fullscreen: win._float_state = FloatStates.FLOATING if self.qtile.config.floats_kept_above: win.keep_above(enable=True) if win.floating and not win.fullscreen: self.floating_layout.add_client(win) if not win.floating or win.fullscreen: self.tiled_windows.add(win) for i in self.layouts: i.add_client(win) if focus: self.focus(win, warp=True, force=force) def remove(self, win, force=False): hadfocus = self._remove_from_focus_history(win) = None if win.floating: nextfocus = self.floating_layout.remove(win) nextfocus = ( nextfocus or self.current_window or self.layout.focus_first() or self.floating_layout.focus_first(group=self) ) # Remove from the tiled layouts if it was not floating or fullscreen if not win.floating or win.fullscreen: for i in self.layouts: if i is self.layout: nextfocus = i.remove(win) else: i.remove(win) nextfocus = ( nextfocus or self.floating_layout.focus_first(group=self) or self.current_window or self.layout.focus_first() ) if win in self.tiled_windows: self.tiled_windows.remove(win) # a notification may not have focus if hadfocus: self.focus(nextfocus, warp=True, force=force) # no next focus window means focus changed to nothing if not nextfocus:"focus_change") elif self.screen: self.layout_all() def mark_floating(self, win, floating): if floating: if win in self.floating_layout.find_clients(self): # already floating pass else: # Remove from the tiled windows list if the window is not fullscreen if not win.fullscreen: self.tiled_windows.remove(win) # Remove the window from the layout if it is not fullscreen for i in self.layouts: i.remove(win) if win is self.current_window: i.blur() self.floating_layout.add_client(win) if win is self.current_window: self.floating_layout.focus(win) else: self.floating_layout.remove(win) self.floating_layout.blur() # A window that was fullscreen should only be added if it was not a tiled window if win not in self.tiled_windows: for i in self.layouts: i.add_client(win) self.tiled_windows.add(win) if win is self.current_window: for i in self.layouts: i.focus(win) self.layout_all() def _items(self, name) -> ItemT: if name == "layout": return True, list(range(len(self.layouts))) if name == "screen" and self.screen is not None: return True, [] if name == "window": return self.current_window is not None, [i.wid for i in] return None def _select(self, name, sel): if name == "layout": if sel is None: return self.layout return utils.lget(self.layouts, sel) if name == "screen": return self.screen if name == "window": if sel is None: return self.current_window for i in if i.wid == sel: return i raise RuntimeError("Invalid selection: {}".format(name))
[docs] @expose_command() def setlayout(self, layout): self.layout = layout
[docs] @expose_command() def toscreen(self, screen=None, toggle=False): """Pull a group to a specified screen. Parameters ========== screen : Screen offset. If not specified, we assume the current screen. toggle : If this group is already on the screen, then the group is toggled with last used Examples ======== Pull group to the current screen:: toscreen() Pull group to screen 0:: toscreen(0) """ if screen is None: screen = self.qtile.current_screen else: screen = self.qtile.screens[screen] if == self: if toggle: screen.toggle_group(self) else: screen.set_group(self)
def _get_group(self, direction, skip_empty=False, skip_managed=False): """Find a group walking the groups list in the specified direction Parameters ========== skip_empty : skips the empty groups skip_managed : skips the groups that have a screen """ def match(group): from libqtile import scratchpad if group is self: return True if skip_empty and not return False if skip_managed and group.screen: return False if isinstance(group, scratchpad.ScratchPad): return False return True groups = [group for group in self.qtile.groups if match(group)] index = (groups.index(self) + direction) % len(groups) return groups[index] def get_previous_group(self, skip_empty=False, skip_managed=False): return self._get_group(-1, skip_empty, skip_managed) def get_next_group(self, skip_empty=False, skip_managed=False): return self._get_group(1, skip_empty, skip_managed)
[docs] @expose_command() def unminimize_all(self): """Unminimise all windows in this group""" for win in win.minimized = False self.layout_all()
[docs] @expose_command() def next_window(self): """ Focus the next window in group. Method cycles _all_ windows in group regardless if tiled in current layout or floating. Cycling of tiled and floating windows is not mixed. The cycling order depends on the current Layout. """ if not return if self.current_window.floating: nxt = ( self.floating_layout.focus_next(self.current_window) or self.layout.focus_first() or self.floating_layout.focus_first(group=self) ) else: nxt = ( self.layout.focus_next(self.current_window) or self.floating_layout.focus_first(group=self) or self.layout.focus_first() ) self.focus(nxt, True)
[docs] @expose_command() def prev_window(self): """ Focus the previous window in group. Method cycles _all_ windows in group regardless if tiled in current layout or floating. Cycling of tiled and floating windows is not mixed. The cycling order depends on the current Layout. """ if not return if self.current_window.floating: nxt = ( self.floating_layout.focus_previous(self.current_window) or self.layout.focus_last() or self.floating_layout.focus_last(group=self) ) else: nxt = ( self.layout.focus_previous(self.current_window) or self.floating_layout.focus_last(group=self) or self.layout.focus_last() ) self.focus(nxt, True)
[docs] @expose_command() def focus_back(self): """ Focus the window that had focus before the current one got it. Repeated calls to this function would basically continuously switch between the last two focused windows. Do nothing if less than 2 windows ever received focus. """ try: win = self.focus_history[-2] except IndexError: pass else: self.focus(win)
[docs] @expose_command() def focus_by_name(self, name): """ Focus the first window with the given name. Do nothing if the name is not found. """ for win in if == name: self.focus(win) break
[docs] @expose_command() def info_by_name(self, name): """ Get the info for the first window with the given name without giving it focus. Do nothing if the name is not found. """ for win in if == name: return
[docs] @expose_command() def focus_by_index(self, index: int) -> None: """ Change to the window at the specified index in the current group. """ windows = if index < 0 or index > len(windows) - 1: return self.focus(windows[index])
[docs] @expose_command() def swap_window_order(self, new_location: int) -> None: """ Change the order of the current window within the current group. """ if new_location < 0 or new_location > len( - 1: return windows = current_window_index = windows.index(self.current_window) windows[current_window_index], windows[new_location] = ( windows[new_location], windows[current_window_index], )
[docs] @expose_command() def switch_groups(self, name): """Switch position of current group with name""" self.qtile.switch_groups(, name)
[docs] @expose_command() def set_label(self, label): """ Set the display name of current group to be used in GroupBox widget. If label is None, the name of the group is used as display name. If label is the empty string, the group is invisible in GroupBox. """ self.label = label if label is not None else"changegroup")
def __repr__(self): return "<group.Group (%r)>" %