Layout objects

Layouts position windows according to their specific rules. Layout commands typically include moving windows around the layout and changing the size of windows.

Layouts can access the windows being displayed, the group holding the layout and the screen displaying the layout.

strict digraph layout {
bgcolor="transparent"
node [pos="0,0!", color="Gray", fillcolor="Gray", href="root.html", style="filled", label="root", fontname="regular"];
root;

node [pos="-1.94,-0.44!", color="Gray", fillcolor="Gray", href="bars.html", style="filled", label="bar", fontname="regular"];
bar;

node [pos="-1.56,1.24!", color="Gray", fillcolor="Gray", href="backend.html", style="filled", label="core", fontname="regular"];
core;

node [pos="1.56,1.24!", color="OrangeRed", fillcolor="Orange", href="groups.html", style="filled", label="group", fontname="regular"];
group;

node [pos="1.94,-0.44!", color="Goldenrod", fillcolor="Gold", href="layouts.html", style="filled", label="layout", fontname="bold"];
layout;

node [pos="0.86,-1.8!", color="DarkGreen", fillcolor="LimeGreen", href="screens.html", style="filled", label="screen", fontname="regular"];
screen;

node [pos="-0.86,-1.8!", color="Gray", fillcolor="Gray", href="widgets.html", style="filled", label="widget", fontname="regular"];
widget;

node [pos="0,2!", color="Red", fillcolor="Tomato", href="windows.html", style="filled", label="window", fontname="regular"];
window;

root -> bar [color="Gray"];
root -> group [color="Gray"];
root -> layout [color="Gray"];
root -> screen [color="Gray"];
root -> widget [color="Gray"];
root -> window [color="Gray"];
root -> core [color="Gray"];
bar -> screen [color="Gray", dir="both"];
bar -> widget [color="Gray", dir="both"];
group -> layout [dir="both"];
group -> window [color="Gray", dir="both"];
group -> screen [color="Gray", dir="both"];
layout -> window [dir="both"];
layout -> screen [dir="both"];
screen -> window [color="Gray", dir="both"];
screen -> widget [color="Gray", dir="both"];
}

Bsp

class libqtile.layout.bsp.Bsp[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

down()

eval(code)

Evaluates code in the same context as this function

flip_down()

flip_left()

flip_right()

flip_up()

function(function, *args, **kwargs)

Call a function with current object as argument

grow_down()

grow_left()

grow_right()

grow_up()

info()

Returns a dictionary of layout information

items(name)

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

left()

next()

normalize()

previous()

right()

shuffle_down()

shuffle_left()

shuffle_right()

shuffle_up()

toggle_split()

up()

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.

down()[source]
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.

flip_down()[source]
flip_left()[source]
flip_right()[source]
flip_up()[source]
function(function, *args, **kwargs) None

Call a function with current object as argument

grow_down()[source]
grow_left()[source]
grow_right()[source]
grow_up()[source]
info() dict[str, Any][source]

Returns a dictionary of layout information

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()[source]
next() None[source]
normalize()[source]
previous() None[source]
right()[source]
shuffle_down()[source]
shuffle_left()[source]
shuffle_right()[source]
shuffle_up()[source]
toggle_split()[source]
up()[source]

Columns

class libqtile.layout.columns.Columns[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

down()

eval(code)

Evaluates code in the same context as this function

function(function, *args, **kwargs)

Call a function with current object as argument

grow_down()

grow_left()

grow_right()

grow_up()

info()

Returns a dictionary of layout information

items(name)

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

left()

next()

normalize()

Give columns equal widths.

previous()

reset()

Resets column widths, respecting 'initial_ratio' value.

right()

shuffle_down()

shuffle_left()

shuffle_right()

shuffle_up()

swap_column_left()

swap_column_right()

toggle_split()

up()

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.

down()[source]
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_down()[source]
grow_left()[source]
grow_right()[source]
grow_up()[source]
info() dict[str, Any][source]

Returns a dictionary of layout information

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()[source]
next() None[source]
normalize()[source]

Give columns equal widths.

previous() None[source]
reset()[source]

Resets column widths, respecting 'initial_ratio' value.

right()[source]
shuffle_down()[source]
shuffle_left()[source]
shuffle_right()[source]
shuffle_up()[source]
swap_column_left()[source]
swap_column_right()[source]
toggle_split()[source]
up()[source]

Floating

class libqtile.layout.floating.Floating[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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 layout information

items(name)

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

next()

previous()

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() dict[str, Any][source]

Returns a dictionary of layout information

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[source]
previous() None[source]

Matrix

class libqtile.layout.matrix.Matrix[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -f <command>

The following commands are available for this object:

add()

Increase number of columns

commands()

Returns a list of possible commands for this object

delete()

Decrease number of columns

doc(name)

Returns the documentation for a specified command name

down()

Switch to the next window in current column

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 layout information

items(name)

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

left()

Switch to the next window on current row

next()

previous()

right()

Switch to the next window on current row

up()

Switch to the previous window in current column

Command documentation

add()[source]

Increase number of columns

commands() list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

delete()[source]

Decrease number of columns

doc(name) str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

down()[source]

Switch to the next window in current column

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() dict[str, Any][source]

Returns a dictionary of layout information

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()[source]

Switch to the next window on current row

next() None[source]
previous() None[source]
right()[source]

Switch to the next window on current row

up()[source]

Switch to the previous window in current column

Max

class libqtile.layout.max.Max[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

down()

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 layout information

items(name)

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

next()

previous()

up()

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.

down()[source]
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() dict[str, Any]

Returns a dictionary of layout information

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()
previous()
up()[source]

MonadTall

class libqtile.layout.xmonad.MonadTall[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

flip()

Flip the layout horizontally

function(function, *args, **kwargs)

Call a function with current object as argument

grow()

Grow current window

grow_main()

Grow main pane

info()

Returns a dictionary of layout information

items(name)

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

left()

Focus on the closest window to the left of the current window

maximize()

Grow the currently focused client to the max size

next()

normalize([redraw])

Evenly distribute screen-space among secondary clients

previous()

reset([ratio, redraw])

Reset Layout.

right()

Focus on the closest window to the right of the current window

set_ratio(ratio)

Directly set the main pane ratio

shrink()

Shrink current window

shrink_main()

Shrink main pane

shuffle_down()

Shuffle the client down the stack

shuffle_up()

Shuffle the client up the stack

swap(window1, window2)

Swap two windows

swap_left()

Swap current window with closest window to the left

swap_main()

Swap current window to main pane

swap_right()

Swap current window with closest window to the right

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.

flip()[source]

Flip the layout horizontally

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

Call a function with current object as argument

grow()[source]

Grow current window

Will grow the currently focused client reducing the size of those around it. Growing will stop when no other secondary clients can reduce their size any further.

grow_main()[source]

Grow main pane

Will grow the main pane, reducing the size of clients in the secondary pane.

info() dict[str, Any][source]

Returns a dictionary of layout information

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()[source]

Focus on the closest window to the left of the current window

maximize()[source]

Grow the currently focused client to the max size

next() None[source]
normalize(redraw=True)[source]

Evenly distribute screen-space among secondary clients

previous() None[source]
reset(ratio=None, redraw=True)[source]

Reset Layout.

right()[source]

Focus on the closest window to the right of the current window

set_ratio(ratio)[source]

Directly set the main pane ratio

shrink()[source]

Shrink current window

Will shrink the currently focused client reducing the size of those around it. Shrinking will stop when the client has reached the minimum size.

shrink_main()[source]

Shrink main pane

Will shrink the main pane, increasing the size of clients in the secondary pane.

shuffle_down()[source]

Shuffle the client down the stack

shuffle_up()[source]

Shuffle the client up the stack

swap(window1: Window, window2: Window) None[source]

Swap two windows

swap_left()[source]

Swap current window with closest window to the left

swap_main()[source]

Swap current window to main pane

swap_right()[source]

Swap current window with closest window to the right

MonadThreeCol

class libqtile.layout.xmonad.MonadThreeCol[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

flip()

Flip the layout horizontally

function(function, *args, **kwargs)

Call a function with current object as argument

grow()

Grow current window

grow_main()

Grow main pane

items(name)

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

left()

Focus on the closest window to the left of the current window

maximize()

Grow the currently focused client to the max size

next()

normalize([redraw])

Evenly distribute screen-space among secondary clients

previous()

reset([ratio, redraw])

Reset Layout.

right()

Focus on the closest window to the right of the current window

set_ratio(ratio)

Directly set the main pane ratio

shrink()

Shrink current window

shrink_main()

Shrink main pane

shuffle_down()

Shuffle the client down the stack

shuffle_up()

Shuffle the client up the stack

swap(window1, window2)

Swap two windows

swap_left()

Swap current window with closest window to the left

swap_main()

Swap current window to main pane

swap_right()

Swap current window with closest window to the right

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.

flip()

Flip the layout horizontally

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

Call a function with current object as argument

grow()

Grow current window

Will grow the currently focused client reducing the size of those around it. Growing will stop when no other secondary clients can reduce their size any further.

grow_main()

Grow main pane

Will grow the main pane, reducing the size of clients in the secondary pane.

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 on the closest window to the left of the current window

maximize()

Grow the currently focused client to the max size

next() None
normalize(redraw=True)[source]

Evenly distribute screen-space among secondary clients

previous() None
reset(ratio=None, redraw=True)

Reset Layout.

right()

Focus on the closest window to the right of the current window

set_ratio(ratio)

Directly set the main pane ratio

shrink()

Shrink current window

Will shrink the currently focused client reducing the size of those around it. Shrinking will stop when the client has reached the minimum size.

shrink_main()

Shrink main pane

Will shrink the main pane, increasing the size of clients in the secondary pane.

shuffle_down()

Shuffle the client down the stack

shuffle_up()

Shuffle the client up the stack

swap(window1: Window, window2: Window) None

Swap two windows

swap_left()

Swap current window with closest window to the left

swap_main()[source]

Swap current window to main pane

swap_right()

Swap current window with closest window to the right

MonadWide

class libqtile.layout.xmonad.MonadWide[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

flip()

Flip the layout horizontally

function(function, *args, **kwargs)

Call a function with current object as argument

grow()

Grow current window

grow_main()

Grow main pane

info()

Returns a dictionary of layout information

items(name)

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

left()

Focus on the closest window to the left of the current window

maximize()

Grow the currently focused client to the max size

next()

normalize([redraw])

Evenly distribute screen-space among secondary clients

previous()

reset([ratio, redraw])

Reset Layout.

right()

Focus on the closest window to the right of the current window

set_ratio(ratio)

Directly set the main pane ratio

shrink()

Shrink current window

shrink_main()

Shrink main pane

shuffle_down()

Shuffle the client down the stack

shuffle_up()

Shuffle the client up the stack

swap(window1, window2)

Swap two windows

swap_left()

Swap current window with closest window to the down

swap_main()

Swap current window to main pane

swap_right()

Swap current window with closest window to the up

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.

flip()

Flip the layout horizontally

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

Call a function with current object as argument

grow()

Grow current window

Will grow the currently focused client reducing the size of those around it. Growing will stop when no other secondary clients can reduce their size any further.

grow_main()

Grow main pane

Will grow the main pane, reducing the size of clients in the secondary pane.

info() dict[str, Any]

Returns a dictionary of layout information

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 on the closest window to the left of the current window

maximize()

Grow the currently focused client to the max size

next() None
normalize(redraw=True)

Evenly distribute screen-space among secondary clients

previous() None
reset(ratio=None, redraw=True)

Reset Layout.

right()

Focus on the closest window to the right of the current window

set_ratio(ratio)

Directly set the main pane ratio

shrink()

Shrink current window

Will shrink the currently focused client reducing the size of those around it. Shrinking will stop when the client has reached the minimum size.

shrink_main()

Shrink main pane

Will shrink the main pane, increasing the size of clients in the secondary pane.

shuffle_down()

Shuffle the client down the stack

shuffle_up()

Shuffle the client up the stack

swap(window1: Window, window2: Window) None

Swap two windows

swap_left()[source]

Swap current window with closest window to the down

swap_main()[source]

Swap current window to main pane

swap_right()[source]

Swap current window with closest window to the up

Plasma

class libqtile.layout.plasma.Plasma[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

down()

Focus window below.

eval(code)

Evaluates code in the same context as this function

function(function, *args, **kwargs)

Call a function with current object as argument

grow(x)

Grow size of current window.

grow_height(x)

Grow height of current window.

grow_width(x)

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)

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

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.

reset_size()

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

right()

Focus window to the right.

set_height(x)

Set height of current window.

set_size(x)

Change size of current window.

set_width(x)

Set width of current window.

up()

Focus window above.

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.

down()[source]

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)[source]

Grow size of current window.

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

grow_height(x: int)[source]

Grow height of current window.

grow_width(x: int)[source]

Grow width of current window.

info()[source]

Returns a dictionary of layout information

integrate_down()[source]

Integrate current window down.

integrate_left()[source]

Integrate current window left.

integrate_right()[source]

Integrate current window right.

integrate_up()[source]

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()[source]

Focus window to the left.

mode_horizontal()[source]

Next window will be added horizontally.

mode_horizontal_split()[source]

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

mode_vertical()[source]

Next window will be added vertically.

mode_vertical_split()[source]

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

move_down()[source]

Move current window down.

move_left()[source]

Move current window left.

move_right()[source]

Move current window right.

move_up()[source]

Move current window up.

next()[source]

Focus next window.

previous()[source]

Focus previous window.

recent()[source]

Focus most recently focused window.

(Toggles between the two latest active windows.)

reset_size()[source]

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

right()[source]

Focus window to the right.

set_height(x: int)[source]

Set height of current window.

set_size(x: int)[source]

Change size of current window.

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

set_width(x: int)[source]

Set width of current window.

up()[source]

Focus window above.

RatioTile

class libqtile.layout.ratiotile.RatioTile[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -f <command>

The following commands are available for this object:

commands()

Returns a list of possible commands for this object

decrease_ratio()

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_ratio()

info()

Returns a dictionary of layout information

items(name)

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

next()

previous()

shuffle_down()

shuffle_up()

Command documentation

commands() list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

decrease_ratio()[source]
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_ratio()[source]
info() dict[str, Any][source]

Returns a dictionary of layout information

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[source]
previous() None[source]
shuffle_down()[source]
shuffle_up()[source]

ScreenSplit

class libqtile.layout.screensplit.ScreenSplit[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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 layout information

items(name)

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

move_window_to_next_split()

Move current window to next split.

move_window_to_previous_split()

Move current window to previous split.

next()

Move to next client.

next_split()

Move to next split.

previous()

Move to previous client.

previous_split()

Move to previous client.

Command documentation

commands()[source]

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() dict[str, Any][source]

Returns a dictionary of layout information

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

move_window_to_next_split() None[source]

Move current window to next split.

move_window_to_previous_split() None[source]

Move current window to previous split.

next() None[source]

Move to next client.

next_split() None[source]

Move to next split.

previous() None[source]

Move to previous client.

previous_split() None[source]

Move to previous client.

Slice

class libqtile.layout.slice.Slice[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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 layout information

items(name)

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

move_to_slice()

Moves the current window to the slice.

next()

previous()

Command documentation

commands()[source]

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() dict[str, Any][source]

Returns a dictionary of layout information

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

move_to_slice()[source]

Moves the current window to the slice.

next() None[source]
previous() None[source]

Spiral

class libqtile.layout.spiral.Spiral[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -f <command>

The following commands are available for this object:

commands()

Returns a list of possible commands for this object

decrease_ratio()

Decrease spiral ratio.

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

grow_main()

Grow the main window.

increase_ratio()

Increase spiral ratio.

items(name)

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

next()

previous()

reset()

Reset ratios to values set in config.

set_master_ratio(ratio)

Set the ratio for the main window.

set_ratio(ratio)

Set the ratio for all windows.

shrink_main()

Shrink the main window.

shuffle_down()

shuffle_up()

Command documentation

commands() list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

decrease_ratio()[source]

Decrease spiral ratio.

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

grow_main()[source]

Grow the main window.

increase_ratio()[source]

Increase spiral ratio.

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[source]
previous() None[source]
reset()[source]

Reset ratios to values set in config.

set_master_ratio(ratio: float)[source]

Set the ratio for the main window.

set_ratio(ratio: float)[source]

Set the ratio for all windows.

shrink_main()[source]

Shrink the main window.

shuffle_down()[source]
shuffle_up()[source]

Stack

class libqtile.layout.stack.Stack[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -f <command>

The following commands are available for this object:

add()

Add another stack to the layout

client_to_next()

Send the current client to the next stack

client_to_previous()

Send the current client to the previous stack

client_to_stack(n)

Send the current client to stack n, where n is an integer offset.

commands()

Returns a list of possible commands for this object

delete()

Delete the current stack from the layout

doc(name)

Returns the documentation for a specified command name

down()

Switch to the next window in this stack

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 layout information

items(name)

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

next()

Focus next stack

previous()

Focus previous stack

rotate()

Rotate order of the stacks

shuffle_down()

Shuffle the order of this stack down

shuffle_up()

Shuffle the order of this stack up

toggle_split()

Toggle vertical split on the current stack

up()

Switch to the previous window in this stack

Command documentation

add()[source]

Add another stack to the layout

client_to_next()[source]

Send the current client to the next stack

client_to_previous()[source]

Send the current client to the previous stack

client_to_stack(n)[source]

Send the current client to stack n, where n is an integer offset. If is too large or less than 0, it is wrapped modulo the number of stacks.

commands() list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

delete()[source]

Delete the current stack from the layout

doc(name) str

Returns the documentation for a specified command name

Used by __qsh__ to provide online help.

down()[source]

Switch to the next window in this stack

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() dict[str, Any][source]

Returns a dictionary of layout information

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[source]

Focus next stack

previous() None[source]

Focus previous stack

rotate()[source]

Rotate order of the stacks

shuffle_down()[source]

Shuffle the order of this stack down

shuffle_up()[source]

Shuffle the order of this stack up

toggle_split()[source]

Toggle vertical split on the current stack

up()[source]

Switch to the previous window in this stack

Tile

class libqtile.layout.tile.Tile[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -f <command>

The following commands are available for this object:

commands()

Returns a list of possible commands for this object

decrease_nmaster()

decrease_ratio()

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_nmaster()

increase_ratio()

info()

Returns a dictionary of layout information

items(name)

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

next()

previous()

reset()

shuffle_down()

shuffle_up()

Command documentation

commands() list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

decrease_nmaster()[source]
decrease_ratio()[source]
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_nmaster()[source]
increase_ratio()[source]
info() dict[str, Any][source]

Returns a dictionary of layout information

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[source]
previous() None[source]
reset()[source]
shuffle_down()[source]
shuffle_up()[source]

TreeTab

class libqtile.layout.tree.TreeTab[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -f <command>

The following commands are available for this object:

add_section(name)

Add named section to tree

collapse_branch()

commands()

Returns a list of possible commands for this object

decrease_ratio()

del_section(name)

Remove named section from tree

doc(name)

Returns the documentation for a specified command name

eval(code)

Evaluates code in the same context as this function

expand_branch()

function(function, *args, **kwargs)

Call a function with current object as argument

increase_ratio()

info()

Returns a dictionary of layout information

items(name)

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

move_down()

move_left()

move_right()

move_up()

next()

Switch down in the window list

previous()

Switch up in the window list

section_down()

section_up()

sort_windows(sorter[, create_sections])

Sorts window to sections using sorter function

Command documentation

add_section(name)[source]

Add named section to tree

collapse_branch()[source]
commands() list[str]

Returns a list of possible commands for this object

Used by __qsh__ for command completion and online help

decrease_ratio()[source]
del_section(name)[source]

Remove named section from tree

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.

expand_branch()[source]
function(function, *args, **kwargs) None

Call a function with current object as argument

increase_ratio()[source]
info() dict[str, Any][source]

Returns a dictionary of layout information

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

move_down()[source]
move_left()[source]
move_right()[source]
move_up()[source]
next() None[source]

Switch down in the window list

previous() None[source]

Switch up in the window list

section_down()[source]
section_up()[source]
sort_windows(sorter, create_sections=True)[source]

Sorts window to sections using sorter function

Parameters:
sorter: function with single arg returning string

returns name of the section where window should be

create_sections:

if this parameter is True (default), if sorter returns unknown section name it will be created dynamically

VerticalTile

class libqtile.layout.verticaltile.VerticalTile[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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

grow()

info()

Returns a dictionary of layout information

items(name)

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

maximize()

next()

normalize()

previous()

shrink()

shuffle_down()

shuffle_up()

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

grow()[source]
info() dict[str, Any]

Returns a dictionary of layout information

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

maximize()[source]
next() None[source]
normalize()[source]
previous() None[source]
shrink()[source]
shuffle_down()[source]
shuffle_up()[source]

Zoomy

class libqtile.layout.zoomy.Zoomy[source]

API commands

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

lazy.layout.<command>()

qtile cmd-obj -o layout -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 layout information

items(name)

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

next()

previous()

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() dict[str, Any]

Returns a dictionary of layout information

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[source]
previous() None[source]