add send-tos with the mouse wheel
[mikachu/openbox.git] / plugins / mouse / mouserc
1 # Mouserc - Mouse bindings for Openbox
2
3 # Context : The place where the mouse click takes place
4 #  * Titlebar - A client's titlebar (the top of the frame)
5 #  * Handle - A client's handle (the bottom of the frame)
6 #  * Client - A client (the actual window inside the frame, clicks in this
7 #                       context also get passed through to the client)
8 #  * Frame - A client's entire frame (clicks in this context do not get passed
9 #                                     through to the client)
10 #  * Icon - A client's icon (in the titlebar)
11 #  * AllDesktops - A client's omnipresent button (in the titlebar)
12 #  * Iconify - A client's iconify button (in the titlebar)
13 #  * Maximize - A client's maximize button (in the titlebar)
14 #  * Close - A client's close button (in the titlebar)
15 #  * Root - The root window (the desktop background, these are often blocked
16 #                            by programs with desktop windows, and are not
17 #                            available on rootless X servers (like OSX))
18 #  * TLCorner - The top-left corner of the frame (if supported by the
19 #                                                 engine)
20 #  * TRCorner - The top-right corner of the frame (if supported by the
21 #                                                  engine)
22 #  * BLCorner - The bottom-left corner of the frame (if supported by the
23 #                                                    engine)
24 #  * BRCorner - The bottom-right corner of the frame (if supported by the
25 #                                                     engine)
26 #  Other contexts may be created by engines.
27
28 # Event : The type of mouse action to bind
29 #  * Press - A button is pressed
30 #  * Release - A button is released
31 #  * Click - A button is pressed and released
32 #  * DoubleClick - A button is pressed and released twice quickly
33 #  * Drag - A button is held and the mouse is moved
34
35 # Button : The mouse button which is performing the Event
36 #  A string composed of [<modifier>-]<button>. A button can have 0 or more
37 #  modifiers.
38 #  Valid modifiers are Mod1 ('A' is an alias for this), Mod2, Mod3, Mod4 ('W'
39 #  is an alias for this), and Mod5.
40 #  Valid buttons are Left, Right, Middle, Up, Down, or any number > 0
41
42 # Action: The action to be performed then the Event occurs with the Button in
43 #         the context.
44 #
45 #  For all Events *except* for drag Events, these are valid:
46 #  * Focus - Focus the client
47 #  * Unfocus - Unfocus the client
48 #  * Iconify - Iconify the client
49 #  * Raise - Raise the client to the front
50 #  * Lower - Lower the client to the back
51 #  * FocusRaise - Focus the client and raise the client to the front
52 #  * Close - Close the client
53 #  * Kill - Kill the client forcefully
54 #  * Shade - Shade (roll up) the client
55 #  * Unshade - Unshade (roll down) the client
56 #  * ToggleShade - Shade and unshade the client
57 #  * ToggleOmnipresent - Place the client on all desktops or the current one
58 #  * MaximizeFull - Maximize the window horizontally and vertically
59 #  * UnmaximizeFull - Restore the window horizontally and vertically
60 #  * ToggleMaximizeFull - Maximize or restore the window horizontally and
61 #                         vertically
62 #  * MaximizeHorz - Maximize the window horizontally
63 #  * UnmaximizeHorz - Restore the window horizontally
64 #  * ToggleMaximizeHorz - Maximize or restore the window horizontally
65 #  * MaximizeVert - Maximize the window vertically
66 #  * UnmaximizeVert - Restore the window vertically
67 #  * ToggleMaximizeVert - Maximize or restore the window vertically
68 #  * SendToNextDesktop - Sends the window to the next desktop
69 #  * SendToNextDesktopWrap - Sends the window to the next desktop (wrapping
70 #                            around the first and last desktops)
71 #  * SendToPreviousDesktop - Sends the window to the previous desktop
72 #  * SendToPreviousDesktopWrap - Sends the window to the previous desktop
73 #                                (wrapping around the first and last desktops)
74 #  * NextDesktop - Switches to the next desktop
75 #  * NextDesktopWrap - Switches to the next desktop (wrapping around the first
76 #                      and last desktops)
77 #  * PreviousDesktop - Switches to the previous desktop
78 #  * PreviousDesktopWrap - Switches to the previous desktop (wrapping around
79 #                          the first and last desktops)
80 #  * NextDesktopColumn - Switches to the desktop in the next column, based on
81 #                        the desktop layout set by a pager
82 #  * NextDesktopColumnWrap - Switches to the desktop in the next column, based
83 #                            on the desktop layout set by a pager (wrapping
84 #                            around the first and last columns)
85 #  * PreviousDesktopColumn - Switches to the desktop in the previous column,
86 #                            based on the desktop layout set by a pager
87 #  * PreviousDesktopColumnWrap - Switches to the desktop in the previous
88 #                                column, based on the desktop layout set by a
89 #                                pager (wrapping around the first and last
90 #                                columns)
91 #  * NextDesktopRow - Switches to the desktop in the next row, based on the
92 #                     desktop layout set by a pager
93 #  * NextDesktopRowWrap - Switches to the desktop in the next row, based on the
94 #                         desktop layout set by a pager (wrapping around the
95 #                         first and last rows)
96 #  * PreviousDesktopRow - Switches to the desktop in the previous row, based on
97 #                         the desktop layout set by a pager
98 #  * PreviousDesktopRowWrap - Switches to the desktop in the previous row,
99 #                             based on the desktop layout set by a pager
100 #                             (wrapping around the first and last rows)
101 #  * Restart - Restarts Openbox
102 #  * Exit - Exits Openbox
103 #
104 #  For drag Events only, these are valid:
105 #  * Move - Move the client interactively, this can only be bound to the Drag
106 #           Event
107 #  * Resize - Resize the client interactively, this can only be bound to the
108 #             Drag Event
109
110 # All options are case insensitive.
111
112 #Context        Event           Button  Action
113
114 Titlebar        Drag            Left    Move
115 Handle          Drag            Left    Move
116 Frame           Drag            A-Left  Move
117
118 BLCorner        Drag            Left    Resize
119 BRCorner        Drag            Left    Resize
120 Frame           Drag            A-Right Resize
121
122 Titlebar        Click           Left    Raise
123 Titlebar        Press           Middle  Lower
124 Handle          Click           Left    Raise
125 Handle          Press           Middle  Lower
126 Frame           Click           A-Left  Raise
127 Frame           Click           A-Right Lower
128
129 Titlebar        Press           Left    Focus
130 Handle          Press           Left    Focus
131 Client          Press           Left    Focus
132
133 Titlebar        DoubleClick     Left    ToggleShade
134 Titlebar        Click           Up      Shade
135 Titlebar        Click           Down    UnShade
136
137 Maximize        Click           Left    ToggleMaximizeFull
138 Maximize        Click           Middle  ToggleMaximizeVert
139 Maximize        Click           Right   ToggleMaximizeHorz
140 Iconify         Click           Left    Iconify
141 Icon            DoubleClick     Left    Close
142 Close           Click           Left    Close
143 Close           Click           Middle  Kill
144 AllDesktops     Click           Left    ToggleOmnipresent
145
146 Root            Click           Up      NextDesktopWrap
147 Root            Click           Down    PreviousDesktopWrap
148 Root            Click           A-Up    NextDesktopWrap
149 Root            Click           A-Down  PreviousDesktopWrap
150 Frame           Click           A-Up    NextDesktopWrap
151 Frame           Click           A-Down  PreviousDesktopWrap
152 Frame           Click           C-A-Up  SendToNextDesktopWrap
153 Frame           Click           C-A-Down SendToPreviousDesktopWrap