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.
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_up
()function
(function, *args, **kwargs)Call a function with current object as argument
grow_up
()info
()Returns a dictionary of layout information
items
(name)Build a list of contained items for the given item class.
left
()next
()previous
()right
()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
- 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
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_up
()info
()Returns a dictionary of layout information
items
(name)Build a list of contained items for the given item class.
left
()next
()Give columns equal widths.
previous
()reset
()Resets column widths, respecting 'initial_ratio' value.
right
()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
- 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
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
- 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
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
- 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
- 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
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.
- 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()
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 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 pane
Shuffle the client down the stack
Shuffle the client up the stack
swap
(window1, window2)Swap two windows
Swap current window with closest window to the left
Swap current window to main pane
Swap current window with closest window to the right
Toggle auto maximize secondary window on focus.
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]
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.
- 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
- 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.
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 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 pane
Shuffle the client down the stack
Shuffle the client up the stack
swap
(window1, window2)Swap two windows
Swap current window with closest window to the left
Swap current window to main pane
Swap current window with closest window to the right
Toggle auto maximize secondary window on focus.
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
- 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_left()
Swap current window with closest window to the left
- swap_right()
Swap current window with closest window to the right
- toggle_auto_maximize()
Toggle auto maximize secondary window on focus.
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 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 pane
Shuffle the client down the stack
Shuffle the client up the stack
swap
(window1, window2)Swap two windows
Swap current window with closest window to the down
Swap current window to main pane
Swap current window with closest window to the up
Toggle auto maximize secondary window on focus.
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
- toggle_auto_maximize()
Toggle auto maximize secondary window on focus.
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 current window down.
Integrate current window left.
Integrate current window right.
Integrate current window up.
items
(name)Build a list of contained items for the given item class.
left
()Focus window to the left.
Next window will be added horizontally.
Next window will be added horizontally, splitting space of current window.
Next window will be added vertically.
Next window will be added vertically, splitting space of current window.
Move current window down.
Move current window left.
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 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.
- 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.)
- 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
- mode_horizontal_split()[source]
Next window will be added horizontally, splitting space of current window.
- mode_vertical_split()[source]
Next window will be added vertically, splitting space of current window.
- recent()[source]
Focus most recently focused window.
(Toggles between the two latest active windows.)
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
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
- 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
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 current window to next split.
Move current window to previous split.
next
()Move to next client.
Move to next split.
previous
()Move to previous client.
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
- 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
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.
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
- 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
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 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 the main window.
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 the main window.
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
- 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
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
Send the current client to the next stack
Send the current client to the previous stack
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 the order of this stack down
Shuffle the order of this stack up
Toggle vertical split on the current stack
up
()Switch to the previous window in this stack
Command documentation
- 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
- 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
- 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
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
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
()reset
()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
- 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
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
commands
()Returns a list of possible commands for this object
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
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_up
()next
()Switch down in the window list
previous
()Switch up in the window list
sort_windows
(sorter[, create_sections])Sorts window to sections using sorter function
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
- 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
- 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
()previous
()shrink
()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
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