xmonad-contrib-0.11.2: Third party extensions for xmonad

Portabilityunportable
Stabilityunstable
Maintaineraudunskaugen@gmail.com
Safe HaskellNone

XMonad.Layout.Fullscreen

Contents

Description

Hooks for sending messages about fullscreen windows to layouts, and a few example layout modifier that implement fullscreen windows.

Synopsis

Usage:

Provides a ManageHook and an EventHook that sends layout messages with information about fullscreening windows. This allows layouts to make their own decisions about what they should to with a window that requests fullscreen.

The module also includes a few layout modifiers as an illustration of how such layouts should behave.

To use this module, add fullscreenEventHook and fullscreenManageHook to your config, i.e.

 xmonad defaultconfig { handleEventHook = fullscreenEventHook,
                        manageHook = fullscreenManageHook,
                        layoutHook = myLayouts }

Now you can use layouts that respect fullscreen, for example the provided fullscreenFull:

 myLayouts = fullscreenFull someLayout

fullscreenFull :: LayoutClass l a => l a -> ModifiedLayout FullscreenFull l aSource

Layout modifier that makes fullscreened window fill the entire screen.

fullscreenFocus :: LayoutClass l a => l a -> ModifiedLayout FullscreenFocus l aSource

Layout modifier that makes the fullscreened window fill the entire screen only if it is currently focused.

fullscreenFullRect :: LayoutClass l a => RationalRect -> l a -> ModifiedLayout FullscreenFull l aSource

As above, but the fullscreened window will fill the specified rectangle instead of the entire screen.

fullscreenFocusRect :: LayoutClass l a => RationalRect -> l a -> ModifiedLayout FullscreenFocus l aSource

As above, but the fullscreened window will fill the specified rectangle instead of the entire screen.

fullscreenFloat :: LayoutClass l a => l a -> ModifiedLayout FullscreenFloat l aSource

Hackish layout modifier that makes floating fullscreened windows fill the entire screen.

fullscreenFloatRect :: LayoutClass l a => RationalRect -> l a -> ModifiedLayout FullscreenFloat l aSource

As above, but the fullscreened window will fill the specified rectangle instead of the entire screen.

fullscreenEventHook :: Event -> X AllSource

The event hook required for the layout modifiers to work

fullscreenManageHook :: ManageHookSource

Manage hook that sets the fullscreen property for windows that are initially fullscreen

fullscreenManageHookWith :: Query Bool -> ManageHookSource

A version of fullscreenManageHook that lets you specify your own query to decide whether a window should be fullscreen.

data FullscreenMessage Source

Messages that control the fullscreen state of the window. AddFullscreen and RemoveFullscreen are sent to all layouts when a window wants or no longer wants to be fullscreen. FullscreenChanged is sent to the current layout after one of the above have been sent.

Types for reference