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 #  * ShadeLower - Shades the window if it's not shaded, and lower it
  58 #                 if it was already shaded
  59 #  * UnshadeRaise - Unshades the window if it's shaded, and raise it
  60 #                   if it was already unshaded
  61 #  * ToggleOmnipresent - Place the client on all desktops or the current one
  62 #  * MaximizeFull - Maximize the window horizontally and vertically
  63 #  * UnmaximizeFull - Restore the window horizontally and vertically
  64 #  * ToggleMaximizeFull - Maximize or restore the window horizontally and
  65 #                         vertically
  66 #  * MaximizeHorz - Maximize the window horizontally
  67 #  * UnmaximizeHorz - Restore the window horizontally
  68 #  * ToggleMaximizeHorz - Maximize or restore the window horizontally
  69 #  * MaximizeVert - Maximize the window vertically
  70 #  * UnmaximizeVert - Restore the window vertically
  71 #  * ToggleMaximizeVert - Maximize or restore the window vertically
  72 #  * SendToNextDesktop - Sends the window to the next desktop
  73 #  * SendToNextDesktopWrap - Sends the window to the next desktop (wrapping
  74 #                            around the first and last desktops)
  75 #  * SendToPreviousDesktop - Sends the window to the previous desktop
  76 #  * SendToPreviousDesktopWrap - Sends the window to the previous desktop
  77 #                                (wrapping around the first and last desktops)
  78 #  * NextDesktop - Switches to the next desktop
  79 #  * NextDesktopWrap - Switches to the next desktop (wrapping around the first
  80 #                      and last desktops)
  81 #  * PreviousDesktop - Switches to the previous desktop
  82 #  * PreviousDesktopWrap - Switches to the previous desktop (wrapping around
  83 #                          the first and last desktops)
  84 #  * NextDesktopColumn - Switches to the desktop in the next column, based on
  85 #                        the desktop layout set by a pager
  86 #  * NextDesktopColumnWrap - Switches to the desktop in the next column, based
  87 #                            on the desktop layout set by a pager (wrapping
  88 #                            around the first and last columns)
  89 #  * PreviousDesktopColumn - Switches to the desktop in the previous column,
  90 #                            based on the desktop layout set by a pager
  91 #  * PreviousDesktopColumnWrap - Switches to the desktop in the previous
  92 #                                column, based on the desktop layout set by a
  93 #                                pager (wrapping around the first and last
  94 #                                columns)
  95 #  * NextDesktopRow - Switches to the desktop in the next row, based on the
  96 #                     desktop layout set by a pager
  97 #  * NextDesktopRowWrap - Switches to the desktop in the next row, based on the
  98 #                         desktop layout set by a pager (wrapping around the
  99 #                         first and last rows)
 100 #  * PreviousDesktopRow - Switches to the desktop in the previous row, based on
 101 #                         the desktop layout set by a pager
 102 #  * PreviousDesktopRowWrap - Switches to the desktop in the previous row,
 103 #                             based on the desktop layout set by a pager
 104 #                             (wrapping around the first and last rows)
 105 #  * ToggleDecorations - Toggles all decorations around a window on and off
 106 #  * Restart - Restarts Openbox
 107 #  * Exit - Exits Openbox
 108 #
 109 #  For drag Events only, these are valid:
 110 #  * Move - Move the client interactively, this can only be bound to the Drag
 111 #           Event
 112 #  * Resize - Resize the client interactively, this can only be bound to the
 113 #             Drag Event
 114
 115 # All options are case insensitive.
 116
 117 #Context        Event           Button  Action
 118
 119 Titlebar        Drag            Left    Move
 120 Handle          Drag            Left    Move
 121 Frame           Drag            A-Left  Move
 122
 123 BLCorner        Drag            Left    Resize
 124 BRCorner        Drag            Left    Resize
 125 Frame           Drag            A-Right Resize
 126
 127 Titlebar        Click           Left    Raise
 128 Titlebar        Press           Middle  Lower
 129 Handle          Click           Left    Raise
 130 Handle          Press           Middle  Lower
 131 Frame           Click           A-Left  Raise
 132 Frame           Click           A-Right Lower
 133
 134 Titlebar        Press           Left    Focus
 135 Handle          Press           Left    Focus
 136 BLCorner        Press           Left    Focus
 137 BRCorner        Press           Left    Focus
 138 Client          Press           Left    Focus
 139 Client          Press           Middle  Focus
 140
 141 Titlebar        DoubleClick     Left    ToggleShade
 142 Titlebar        Click           Up      Shade
 143 Titlebar        Click           Down    UnShade
 144
 145 Maximize        Click           Left    ToggleMaximizeFull
 146 Maximize        Click           Middle  ToggleMaximizeVert
 147 Maximize        Click           Right   ToggleMaximizeHorz
 148 Iconify         Click           Left    Iconify
 149 Icon            DoubleClick     Left    Close
 150 Close           Click           Left    Close
 151 Close           Click           Middle  Kill
 152 AllDesktops     Click           Left    ToggleOmnipresent
 153
 154 Root            Click           Up      NextDesktopWrap
 155 Root            Click           Down    PreviousDesktopWrap
 156 Root            Click           A-Up    NextDesktopWrap
 157 Root            Click           A-Down  PreviousDesktopWrap
 158 Frame           Click           A-Up    NextDesktopWrap
 159 Frame           Click           A-Down  PreviousDesktopWrap
 160 Frame           Click           C-A-Up  SendToNextDesktopWrap
 161 Frame           Click           C-A-Down SendToPreviousDesktopWrap