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