xmonad-contrib-0.9.1: Third party extensions for xmonadSource codeContentsIndex
XMonad.Actions.FloatSnap
Portabilityunportable
Stabilityunstable
MaintainerAnders Engstrom <ankaan@gmail.com>
Contents
Usage
Description
Move and resize floating windows using other windows and the edge of the screen as guidelines.
Synopsis
data Direction2D
= U
| D
| R
| L
snapMove :: Direction2D -> Maybe Int -> Window -> X ()
snapGrow :: Direction2D -> Maybe Int -> Window -> X ()
snapShrink :: Direction2D -> Maybe Int -> Window -> X ()
snapMagicMove :: Maybe Int -> Maybe Int -> Window -> X ()
snapMagicResize :: [Direction2D] -> Maybe Int -> Maybe Int -> Window -> X ()
snapMagicMouseResize :: Rational -> Maybe Int -> Maybe Int -> Window -> X ()
Usage

You can use this module with the following in your ~/.xmonad/xmonad.hs:

    import XMonad.Actions.FloatSnap

Then add appropriate key bindings, for example:

        , ((modm,               xK_Left),  withFocused $ snapMove L Nothing)
        , ((modm,               xK_Right), withFocused $ snapMove R Nothing)
        , ((modm,               xK_Up),    withFocused $ snapMove U Nothing)
        , ((modm,               xK_Down),  withFocused $ snapMove D Nothing)
        , ((modm .|. shiftMask, xK_Left),  withFocused $ snapShrink R Nothing)
        , ((modm .|. shiftMask, xK_Right), withFocused $ snapGrow R Nothing)
        , ((modm .|. shiftMask, xK_Up),    withFocused $ snapShrink D Nothing)
        , ((modm .|. shiftMask, xK_Down),  withFocused $ snapGrow D Nothing)

For detailed instructions on editing your key bindings, see XMonad.Doc.Extending.

And possibly add an appropriate mouse binding, for example:

        , ((modm,               button1), (\w -> focus w >> mouseMoveWindow w >> snapMagicMove (Just 50) (Just 50) w))
        , ((modm .|. shiftMask, button1), (\w -> focus w >> mouseMoveWindow w >> snapMagicResize [L,R,U,D] (Just 50) (Just 50) w))
        , ((modm,               button3), (\w -> focus w >> mouseResizeWindow w >> snapMagicResize [R,D] (Just 50) (Just 50) w))

For detailed instructions on editing your mouse bindings, see XMonad.Doc.Extending.

Using these mouse bindings, it will not snap while moving, but allow you to click the window once after it has been moved or resized to snap it into place. Note that the order in which the commands are applied in the mouse bindings are important.

Interesting values for the distance to look for window in the orthogonal axis are Nothing (to snap against every window), Just 0 (to only snap against windows that we should collide with geometrically while moving) and Just 1 (to also snap against windows we brush against).

For snapMagicMove, snapMagicResize and snapMagicMouseResize, try instead setting it to the same as the maximum snapping distance.

When a value is specified it can be geometrically conceived as adding a border with the specified width around the window and then checking which windows it should collide with.

data Direction2D Source
Two-dimensional directions:
Constructors
UUp
DDown
RRight
LLeft
snapMoveSource
:: Direction2DWhat direction to move the window in.
-> Maybe IntThe distance in the orthogonal axis to look for windows to snap against. Use Nothing to snap against every window.
-> WindowThe window to move.
-> X ()
Move a window in the specified direction until it snaps against another window or the edge of the screen.
snapGrowSource
:: Direction2DWhat edge of the window to grow.
-> Maybe IntThe distance in the orthogonal axis to look for windows to snap against. Use Nothing to snap against every window.
-> WindowThe window to grow.
-> X ()
Grow the specified edge of a window until it snaps against another window or the edge of the screen.
snapShrinkSource
:: Direction2DWhat edge of the window to shrink.
-> Maybe IntThe distance in the orthogonal axis to look for windows to snap against. Use Nothing to snap against every window.
-> WindowThe window to shrink.
-> X ()
Shrink the specified edge of a window until it snaps against another window or the edge of the screen.
snapMagicMoveSource
:: Maybe IntThe distance in the orthogonal axis to look for windows to snap against. Use Nothing to snap against every window.
-> Maybe IntThe maximum distance to snap. Use Nothing to not impose any boundary.
-> WindowThe window to move.
-> X ()
Move a window by both axises in any direction to snap against the closest part of other windows or the edge of the screen.
snapMagicResizeSource
:: [Direction2D]The edges to snap.
-> Maybe IntThe distance in the orthogonal axis to look for windows to snap against. Use Nothing to snap against every window.
-> Maybe IntThe maximum distance to snap. Use Nothing to not impose any boundary.
-> WindowThe window to move and resize.
-> X ()
Resize the window by each edge independently to snap against the closest part of other windows or the edge of the screen.
snapMagicMouseResizeSource
:: RationalHow big the middle snap area of each axis should be.
-> Maybe IntThe distance in the orthogonal axis to look for windows to snap against. Use Nothing to snap against every window.
-> Maybe IntThe maximum distance to snap. Use Nothing to not impose any boundary.
-> WindowThe window to move and resize.
-> X ()
Resize the window by each edge independently to snap against the closest part of other windows or the edge of the screen. Use the location of the mouse over the window to decide which edges to snap. In corners, the two adjoining edges will be snapped, along the middle of an edge only that edge will be snapped. In the center of the window all edges will snap. Intended to be used together with XMonad.Actions.FlexibleResize or XMonad.Actions.FlexibleManipulate.
Produced by Haddock version 2.6.1