XMonad.Layout.Fullscreen

xmonad-contrib-0.11.4: Third party extensions for xmonad

Copyright | (c) 2010 Audun Skaugen
License | BSD-style (see xmonad/LICENSE)
Maintainer | audunskaugen@gmail.com
Stability | unstable
Portability | unportable
Safe Haskell | None
Language | Haskell98

XMonad.Layout.Fullscreen

Contents

- Usage:
- Types for reference

Description

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

Synopsis

- fullscreenFull :: LayoutClass l a => l a -> ModifiedLayout FullscreenFull l a
- fullscreenFocus :: LayoutClass l a => l a -> ModifiedLayout FullscreenFocus l a
- fullscreenFullRect :: LayoutClass l a => RationalRect -> l a -> ModifiedLayout FullscreenFull l a
- fullscreenFocusRect :: LayoutClass l a => RationalRect -> l a -> ModifiedLayout FullscreenFocus l a
- fullscreenFloat :: LayoutClass l a => l a -> ModifiedLayout FullscreenFloat l a
- fullscreenFloatRect :: LayoutClass l a => RationalRect -> l a -> ModifiedLayout FullscreenFloat l a
- fullscreenEventHook :: Event -> X All
- fullscreenManageHook :: ManageHook
- fullscreenManageHookWith :: Query Bool -> ManageHook
- data FullscreenMessage
  - = AddFullscreen Window
  - | RemoveFullscreen Window
  - | FullscreenChanged
- data FullscreenFloat a
- data FullscreenFocus a
- data FullscreenFull a

# 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 a

Layout modifier that makes fullscreened window fill the entire screen.

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

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 a

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 a

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 a

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

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

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

fullscreenEventHook :: Event -> X All

The event hook required for the layout modifiers to work

fullscreenManageHook :: ManageHook

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

fullscreenManageHookWith :: Query Bool -> ManageHook

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

data FullscreenMessage

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.

Constructors

AddFullscreen Window |
RemoveFullscreen Window |
FullscreenChanged |

Instances

Message FullscreenMessage |

# Types for reference

data FullscreenFloat a

Instances

LayoutModifier FullscreenFloat Window |
(Ord a, Read a) => Read (FullscreenFloat a) |
Show a => Show (FullscreenFloat a) |

data FullscreenFocus a

Instances

LayoutModifier FullscreenFocus Window |
Read a => Read (FullscreenFocus a) |
Show a => Show (FullscreenFocus a) |

data FullscreenFull a

Instances

LayoutModifier FullscreenFull Window |
Read a => Read (FullscreenFull a) |
Show a => Show (FullscreenFull a) |