twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-05-19 11:30:22 -07:00
Code Issues Packages Projects Releases Wiki Activity

Improvements in documentation

Browse Source
This commit is contained in:
Marco Túlio Gontijo e Silva 2008-07-09 00:24:25 +00:00
parent 297e626fc7
commit 289b994646
1 changed files with 8 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
XMonad/Actions/Plane.hs
View File

@ -65,13 +65,12 @@ import XMonad.Util.Run
-- | Direction to go in the plane. -- | Direction to go in the plane.
data Direction = ToLeft | ToUp | ToRight | ToDown deriving Enum data Direction = ToLeft | ToUp | ToRight | ToDown deriving Enum
-- | Defines whether it's a finite or a circular organization of workspaces. -- | Defines the behaviour when you're trying to move out of the limits.
data Limits data Limits
= Finite -- ^ When you're at a edge of the plane, there's no way to move = Finite -- ^ Ignore the function call, and keep in the same workspace.
-- to the next region. | Circular -- ^ Get on the other side, like in the Snake game.
| Circular -- ^ If you try to move, you'll get to the other edge, on the | Linear -- ^ The plan comes as a row, so it goes to the next or prev if
-- other side. -- the workspaces were numbered.
| Linear -- ^ The plan comes as a row.
deriving Eq deriving Eq
-- | The number of lines in which the workspaces will be arranged. It's -- | The number of lines in which the workspaces will be arranged. It's
@ -82,26 +81,10 @@ data Lines
= GConf -- ^ Use @gconftool-2@ to find out the number of lines. = GConf -- ^ Use @gconftool-2@ to find out the number of lines.
| Lines Int -- ^ Specify the number of lines explicity. | Lines Int -- ^ Specify the number of lines explicity.
-- $navigating
--
-- There're two parameters that must be provided to navigate, and it's a good
-- idea to use them with the same values in each keybinding.
--
-- The first is the number of lines in which the workspaces are going to be
-- organized. It's possible to use a number of lines that is not a divisor
-- of the number of workspaces, but the results are better when using a
-- divisor. If it's not a divisor, the last line will have the remaining
-- workspaces.
--
-- The other one is 'Limits'.
-- | Shift a window to the next workspace in 'Direction'. Note that this will -- | Shift a window to the next workspace in 'Direction'. Note that this will
-- also move to the next workspace. -- also move to the next workspace. It's a good idea to use the same 'Lines'
planeShift -- and 'Limits' for all the bindings.
:: Lines planeShift :: Lines -> Limits -> Direction -> X ()
-> Limits
-> Direction
-> X ()
planeShift = plane shift' planeShift = plane shift'
shift' :: shift' ::