openbox/plugins/mouse/mouserc
2003-03-31 22:59:56 +00:00

163 lines
7.3 KiB
Text

# Mouserc - Mouse bindings for Openbox
# Context : The place where the mouse click takes place
# * Titlebar - A client's titlebar (the top of the frame)
# * Handle - A client's handle (the bottom of the frame)
# * Client - A client (the actual window inside the frame, clicks in this
# context also get passed through to the client)
# * Frame - A client's entire frame (clicks in this context do not get passed
# through to the client)
# * Icon - A client's icon (in the titlebar)
# * AllDesktops - A client's omnipresent button (in the titlebar)
# * Iconify - A client's iconify button (in the titlebar)
# * Shade - A client's shade button (in the titlebar)
# * Maximize - A client's maximize button (in the titlebar)
# * Close - A client's close button (in the titlebar)
# * Root - The root window (the desktop background, these are often blocked
# by programs with desktop windows, and are not
# available on rootless X servers (like OSX))
# * TLCorner - The top-left corner of the frame (if supported by the
# engine)
# * TRCorner - The top-right corner of the frame (if supported by the
# engine)
# * BLCorner - The bottom-left corner of the frame (if supported by the
# engine)
# * BRCorner - The bottom-right corner of the frame (if supported by the
# engine)
# Other contexts may be created by engines.
# Event : The type of mouse action to bind
# * Press - A button is pressed
# * Release - A button is released
# * Click - A button is pressed and released
# * DoubleClick - A button is pressed and released twice quickly
# * Drag - A button is held and the mouse is moved
# Button : The mouse button which is performing the Event
# A string composed of [<modifier>-]<button>. A button can have 0 or more
# modifiers.
# Valid modifiers are Mod1 ('A' is an alias for this), Mod2, Mod3, Mod4 ('W'
# is an alias for this), and Mod5.
# Valid buttons are Left, Right, Middle, Up, Down, or any number > 0
# Action: The action to be performed then the Event occurs with the Button in
# the context.
#
# For all Events *except* for drag Events, these are valid:
# * Focus - Focus the client
# * Unfocus - Unfocus the client
# * Iconify - Iconify the client
# * Raise - Raise the client to the front
# * Lower - Lower the client to the back
# * FocusRaise - Focus the client and raise the client to the front
# * Close - Close the client
# * Kill - Kill the client forcefully
# * Shade - Shade (roll up) the client
# * Unshade - Unshade (roll down) the client
# * ToggleShade - Shade and unshade the client
# * ShadeLower - Shades the window if it's not shaded, and lower it
# if it was already shaded
# * UnshadeRaise - Unshades the window if it's shaded, and raise it
# if it was already unshaded
# * ToggleOmnipresent - Place the client on all desktops or the current one
# * MaximizeFull - Maximize the window horizontally and vertically
# * UnmaximizeFull - Restore the window horizontally and vertically
# * ToggleMaximizeFull - Maximize or restore the window horizontally and
# vertically
# * MaximizeHorz - Maximize the window horizontally
# * UnmaximizeHorz - Restore the window horizontally
# * ToggleMaximizeHorz - Maximize or restore the window horizontally
# * MaximizeVert - Maximize the window vertically
# * UnmaximizeVert - Restore the window vertically
# * ToggleMaximizeVert - Maximize or restore the window vertically
# * SendToNextDesktop - Sends the window to the next desktop
# * SendToNextDesktopWrap - Sends the window to the next desktop (wrapping
# around the first and last desktops)
# * SendToPreviousDesktop - Sends the window to the previous desktop
# * SendToPreviousDesktopWrap - Sends the window to the previous desktop
# (wrapping around the first and last desktops)
# * NextDesktop - Switches to the next desktop
# * NextDesktopWrap - Switches to the next desktop (wrapping around the first
# and last desktops)
# * PreviousDesktop - Switches to the previous desktop
# * PreviousDesktopWrap - Switches to the previous desktop (wrapping around
# the first and last desktops)
# * NextDesktopColumn - Switches to the desktop in the next column, based on
# the desktop layout set by a pager
# * NextDesktopColumnWrap - Switches to the desktop in the next column, based
# on the desktop layout set by a pager (wrapping
# around the first and last columns)
# * PreviousDesktopColumn - Switches to the desktop in the previous column,
# based on the desktop layout set by a pager
# * PreviousDesktopColumnWrap - Switches to the desktop in the previous
# column, based on the desktop layout set by a
# pager (wrapping around the first and last
# columns)
# * NextDesktopRow - Switches to the desktop in the next row, based on the
# desktop layout set by a pager
# * NextDesktopRowWrap - Switches to the desktop in the next row, based on the
# desktop layout set by a pager (wrapping around the
# first and last rows)
# * PreviousDesktopRow - Switches to the desktop in the previous row, based on
# the desktop layout set by a pager
# * PreviousDesktopRowWrap - Switches to the desktop in the previous row,
# based on the desktop layout set by a pager
# (wrapping around the first and last rows)
# * ToggleDecorations - Toggles all decorations around a window on and off
# * Restart - Restarts Openbox
# * Exit - Exits Openbox
#
# For drag Events only, these are valid:
# * Move - Move the client interactively, this can only be bound to the Drag
# Event
# * Resize - Resize the client interactively, this can only be bound to the
# Drag Event
# All options are case insensitive.
#Context Event Button Action
Titlebar Drag Left Move
Handle Drag Left Move
Frame Drag A-Left Move
BLCorner Drag Left Resize
BRCorner Drag Left Resize
Frame Drag A-Right Resize
Titlebar Click Left Raise
Titlebar Press Middle Lower
Handle Click Left Raise
Handle Press Middle Lower
Frame Click A-Left Raise
Frame Click A-Right Lower
Titlebar Press Left Focus
Handle Press Left Focus
BLCorner Press Left Focus
BRCorner Press Left Focus
Client Press Left Focus
Client Press Middle Focus
Titlebar DoubleClick Left ToggleShade
Titlebar Click Up Shade
Titlebar Click Down UnShade
Maximize Click Left ToggleMaximizeFull
Maximize Click Middle ToggleMaximizeVert
Maximize Click Right ToggleMaximizeHorz
Iconify Click Left Iconify
Icon DoubleClick Left Close
Close Click Left Close
Close Click Middle Kill
AllDesktops Click Left ToggleOmnipresent
Shade Click Left ToggleShade
Root Click Up NextDesktopWrap
Root Click Down PreviousDesktopWrap
Root Click A-Up NextDesktopWrap
Root Click A-Down PreviousDesktopWrap
Frame Click A-Up NextDesktopWrap
Frame Click A-Down PreviousDesktopWrap
Frame Click C-A-Up SendToNextDesktopWrap
Frame Click C-A-Down SendToPreviousDesktopWrap