Layouts

Plasma

class qtile_extras.layout._mods.Plasma(*args, **kwargs)

This is a modified version of the Plasma layout in the main qtile repo.

The change is to add new border_highlight_... parameters which can be used to highlight the add_mode for the current window. These values will benefit from the new window border decorations in qtile-extras i.e. single edges can now be highlighted.

To have this behaviour enabled by default, you should set highlight=True. Alternatively, the behaviour can be toggled with lazy.layout.toggle_highlight().

key	default	description
border_focus	'#00e891'	Focused window border color
border_focus_fixed	'#00e8dc'	Focused fixed-size window border color
border_highlight_horizontal	None	Border for focused window with horizontal add_mode.
border_highlight_horizontal_split	None	Border for focused window with horizontal add_mode.
border_highlight_vertical	None	Border for focused window with vertical add_mode.
border_highlight_vertical_split	None	Border for focused window with vertical split add_mode.
border_normal	'#333333'	Unfocused window border color
border_normal_fixed	'#333333'	Unfocused fixed-size window border color
border_width	1	Border width
border_width_single	0	Border width for single window
fair	False	When False effort will be made to preserve nodes with a fixed size. Set to True to enable new windows to take more space from fixed size nodes.
highlight	False	Highlights the add_mode for the layout.
margin	0	Layout margin
name	'Plasma'	Layout name

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.

down()

Focus window below.

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

grow(x: int)

Grow size of current window.

(It’s recommended to use grow_width()/grow_height() instead.)

grow_height(x: int)

Grow height of current window.

grow_width(x: int)

Grow width of current window.

info()

Returns a dictionary of layout information

integrate_down()

Integrate current window down.

integrate_left()

Integrate current window left.

integrate_right()

Integrate current window right.

integrate_up()

Integrate current window up.

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

left()

Focus window to the left.

mode_horizontal()

Next window will be added horizontally.

mode_horizontal_split()

Next window will be added horizontally, splitting space of current window.

mode_vertical()

Next window will be added vertically.

mode_vertical_split()

Next window will be added vertically, splitting space of current window.

move_down()

Move current window down.

move_left()

Move current window left.

move_right()

Move current window right.

move_up()

Move current window up.

next()

Focus next window.

previous()

Focus previous window.

recent()

Focus most recently focused window.

(Toggles between the two latest active windows.)

reset_size()

Reset size of current window to automatic (relative) sizing.

right()

Focus window to the right.

set_height(x: int)

Set height of current window.

set_size(x: int)

Change size of current window.

(It’s recommended to use width()/height() instead.)

set_width(x: int)

Set width of current window.

toggle_highlight()

Toggle window border highlighting.

up()

Focus window above.