swallowmouse

Function	Expected argument	Default keybinding
swallowmouse	0 or 1	N/A

The swallowmouse function allows for one window to swallow another using the mouse.

Refer to the Swallow functionality for general information about window swallowing.

The general expected behaviour of this function is that you start off with a selected client, trigger the function via a button binding, then drag the mouse cursor to another window.

The behaviour depends on the argument passed to the function.

Argument	Outcome
0	The selected window is swallowed by the target window, i.e. target window remains
1	The target window is swallowed by the selected window, i.e. selected window remains

Which argument to use depends on what feels more natural and meets the user's expectations.

Here are some example button bindings:

    { ClkClientWin,  Super|Shift|Alt,  Button3,  swallowmouse,  {0} }, // selected window to be swallowed by target
    { ClkClientWin,  Super|Ctrl|Alt,   Button3,  swallowmouse,  {1} }, // target window to be swallowed by selected

Behaviour with marked clients

If either the selected or the target client is marked, then all marked clients will be swallowed by the designated client depending on the function argument.

If there are marked clients, but neither the selected nor the target client is marked, then swallowing occurs as normal and the marked clients remain marked.

---

There are no external commands for this function.

Also see the unswallow function.

Back to Functions > Window.