awesome-dovetail

Contents

• Functions

Modules

• awesome-dovetail

Module awesome-dovetail

A tiling layout featuring two visible tiled clients.

Info:

• Copyright: 2019-2020 James Reed
• Author: James Reed <jcrd@tuta.io>

Functions

get_tag (s)	Override this function to change how dovetail determines the current tag.
layout (layout)	Check if a layout is a dovetail layout.
layout.right ()	Horizontally tiled layout with stack on the right.
layout.left ()	Horizontally tiled layout with stack on the left.
layout.bottom ()	Vertically tiled layout with stack on the bottom.
layout.top ()	Vertically tiled layout with stack on the top.
focus.byidx (i)	Focus a client in the stack by its relative index.
focus.other ()	If the master client is focused, focus the visible client in the stack, and vice versa.
master.demote (no_swap)	Swap master client with top stack, focusing stack.
master.promote (no_swap)	Swap top stack client with master, focusing master.
master.cycle ()	Send master client to bottom of stack and replace with top stack client, maintaining focus.

Functions

get_tag (s)

Override this function to change how dovetail determines the current tag. The function takes the current screen.

Parameters:

• s The current screen.

Usage:

dovetail.get_tag = custom_get_tag

layout (layout)

Check if a layout is a dovetail layout.

Parameters:

• layout The layout or the current layout if nil.

Returns:

true if layout is a dovetail layout.

layout.right ()

Horizontally tiled layout with stack on the right.

layout.left ()

Horizontally tiled layout with stack on the left.

layout.bottom ()

Vertically tiled layout with stack on the bottom.

layout.top ()

Vertically tiled layout with stack on the top.

focus.byidx (i)

Focus a client in the stack by its relative index.

Parameters:

• i The index.

Returns:

true if conditions were met to search for a client. If false, a fallback focus.byidx method should be used.

focus.other ()

If the master client is focused, focus the visible client in the stack, and vice versa.

master.demote (no_swap)

Swap master client with top stack, focusing stack.

Parameters:

• no_swap If true, only swaps if master client is focused.

master.promote (no_swap)

Swap top stack client with master, focusing master.

Parameters:

• no_swap If true, only swaps if top stack client is focused.

master.cycle ()

Send master client to bottom of stack and replace with top stack client, maintaining focus.