### Functions that can be used as callbacks for mouse/keyboard bindings ###
###########################################################################
+def state_above(data, add=2):
+ """Toggles, adds or removes the 'above' state on a window."""
+ if not data.client: return
+ send_client_msg(OBDisplay_screenInfo(data.screen).rootWindow(),
+ OBProperty.net_wm_state, data.client.window(), add,
+ openbox.property().atom(OBProperty.net_wm_state_above))
+
+def state_below(data, add=2):
+ """Toggles, adds or removes the 'below' state on a window."""
+ if not data.client: return
+ send_client_msg(OBDisplay_screenInfo(data.screen).rootWindow(),
+ OBProperty.net_wm_state, data.client.window(), add,
+ openbox.property().atom(OBProperty.net_wm_state_below))
+
+def state_shaded(data, add=2):
+ """Toggles, adds or removes the 'shaded' state on a window."""
+ if not data.client: return
+ send_client_msg(OBDisplay_screenInfo(data.screen).rootWindow(),
+ OBProperty.net_wm_state, data.client.window(), add,
+ openbox.property().atom(OBProperty.net_wm_state_shaded))
+
def close(data):
"""Closes the window on which the event occured"""
- client = Openbox_findClient(openbox, data.window())
- if client: OBClient_close(client)
+ if not data.client: return
+ send_client_msg(OBDisplay_screenInfo(data.screen).rootWindow(),
+ OBProperty.net_close_window, data.client.window(), 0)
def focus(data):
"""Focuses the window on which the event occured"""
- client = Openbox_findClient(openbox, data.window())
- if not client: return
- type = OBClient_type(client)
- # these types of windows dont get focus from window enter events
- if data.action() == EventEnterWindow:
- if (type == OBClient_Type_Dock or \
- type == OBClient_Type_Desktop):
- return
- OBClient_focus(client)
+ if not data.client: return
+ # !normal windows dont get focus from window enter events
+ if data.action == EventEnterWindow and not data.client.normal():
+ return
+ data.client.focus()
def move(data):
"""Moves the window interactively. This should only be used with
MouseMotion events"""
- client = Openbox_findClient(openbox, data.window())
- if not client: return
+ if not data.client: return
+
+ # !normal windows dont get moved
+ if not data.client.normal(): return
- dx = data.xroot() - data.pressx()
- dy = data.yroot() - data.pressy()
- OBClient_move(client, data.press_clientx() + dx, data.press_clienty() + dy)
+ dx = data.xroot - data.pressx
+ dy = data.yroot - data.pressy
+ data.client.move(data.press_clientx + dx, data.press_clienty + dy)
def resize(data):
"""Resizes the window interactively. This should only be used with
MouseMotion events"""
- client = Openbox_findClient(openbox, data.window())
- if not client: return
+ if not data.client: return
- px = data.pressx()
- py = data.pressy()
- dx = data.xroot() - px
- dy = data.yroot() - py
+ # !normal windows dont get moved
+ if not data.client.normal(): return
+
+ px = data.pressx
+ py = data.pressy
+ dx = data.xroot - px
+ dy = data.yroot - py
# pick a corner to anchor
- if not (resize_nearest or data.context() == MC_Grip):
- corner = OBClient_TopLeft
+ if not (resize_nearest or data.context == MC_Grip):
+ corner = OBClient.TopLeft
else:
- x = px - data.press_clientx()
- y = py - data.press_clienty()
- if y < data.press_clientheight() / 2:
- if x < data.press_clientwidth() / 2:
- corner = OBClient_BottomRight
+ x = px - data.press_clientx
+ y = py - data.press_clienty
+ if y < data.press_clientheight / 2:
+ if x < data.press_clientwidth / 2:
+ corner = OBClient.BottomRight
dx *= -1
else:
- corner = OBClient_BottomLeft
+ corner = OBClient.BottomLeft
dy *= -1
else:
- if x < data.press_clientwidth() / 2:
- corner = OBClient_TopRight
+ if x < data.press_clientwidth / 2:
+ corner = OBClient.TopRight
dx *= -1
else:
- corner = OBClient_TopLeft
-
- OBClient_resize(client, corner,
- data.press_clientwidth() + dx,
- data.press_clientheight() + dy);
+ corner = OBClient.TopLeft
-def restart(data):
- Openbox_restart(openbox, "")
+ data.client.resize(corner,
+ data.press_clientwidth + dx,
+ data.press_clientheight + dy);
-def toggle_shade(data):
- print "toggle_shade"
+def restart(data, other = ""):
+ """Restarts openbox, optionally starting another window manager."""
+ openbox.restart(other)
def raise_win(data):
- client = Openbox_findClient(openbox, data.window())
- if not client: return
- screen = Openbox_screen(openbox, OBClient_screen(client))
- OBScreen_restack(screen, 1, client)
+ """Raises the window on which the event occured"""
+ if not data.client: return
+ openbox.screen(data.screen).restack(1, data.client)
def lower_win(data):
- client = Openbox_findClient(openbox, data.window())
- if not client: return
- screen = Openbox_screen(openbox, OBClient_screen(client))
- OBScreen_restack(screen, 0, client)
+ """Lowers the window on which the event occured"""
+ if not data.client: return
+ openbox.screen(data.screen).restack(0, data.client)
def toggle_shade(data):
- client = Openbox_findClient(openbox, data.window())
- if not client: return
- print "toggle_shade"
- OBClient_shade(client, not OBClient_shaded(client))
+ """Toggles the shade status of the window on which the event occured"""
+ state_shaded(data)
def shade(data):
- client = Openbox_findClient(openbox, data.window())
- if not client: return
- OBClient_shade(client, 1)
+ """Shades the window on which the event occured"""
+ state_shaded(data, 1)
def unshade(data):
- client = Openbox_findClient(openbox, data.window())
- if not client: return
- OBClient_shade(client, 0)
+ """Unshades the window on which the event occured"""
+ state_shaded(data, 0)
+
+def change_desktop(data, num):
+ """Switches to a specified desktop"""
+ root = OBDisplay_screenInfo(data.screen).rootWindow()
+ send_client_msg(root, OBProperty.net_current_desktop, root, num)
+
+def next_desktop(data, no_wrap=0):
+ """Switches to the next desktop, optionally (by default) cycling around to
+ the first when going past the last."""
+ screen = openbox.screen(data.screen)
+ d = screen.desktop()
+ n = screen.numDesktops()
+ if (d < (n-1)):
+ d = d + 1
+ elif not no_wrap:
+ d = 0
+ change_desktop(data, d)
+
+def prev_desktop(data, no_wrap=0):
+ """Switches to the previous desktop, optionally (by default) cycling around
+ to the last when going past the first."""
+ screen = openbox.screen(data.screen)
+ d = screen.desktop()
+ n = screen.numDesktops()
+ if (d > 0):
+ d = d - 1
+ elif not no_wrap:
+ d = n - 1
+ change_desktop(data, d)
+
+def send_to_desktop(data, num):
+ """Sends a client to a specified desktop"""
+ if not data.client: return
+ send_client_msg(OBDisplay_screenInfo(data.screen).rootWindow(),
+ OBProperty.net_wm_desktop, data.client.window(), num)
+
+def send_to_next_desktop(data, no_wrap=0, follow=1):
+ """Sends a window to the next desktop, optionally (by default) cycling
+ around to the first when going past the last. Also optionally moving to
+ the new desktop after sending the window."""
+ if not data.client: return
+ screen = openbox.screen(data.screen)
+ d = screen.desktop()
+ n = screen.numDesktops()
+ if (d < (n-1)):
+ d = d + 1
+ elif not no_wrap:
+ d = 0
+ send_to_desktop(data, d)
+ if follow:
+ change_desktop(data, d)
+def send_to_prev_desktop(data, no_wrap=0, follow=1):
+ """Sends a window to the previous desktop, optionally (by default) cycling
+ around to the last when going past the first. Also optionally moving to
+ the new desktop after sending the window."""
+ if not data.client: return
+ screen = openbox.screen(data.screen)
+ d = screen.desktop()
+ n = screen.numDesktops()
+ if (d > 0):
+ d = d - 1
+ elif not no_wrap:
+ d = n - 1
+ send_to_desktop(data, d)
+ if follow:
+ change_desktop(data, d)
+
#########################################
### Convenience functions for scripts ###
#########################################
def execute(bin, screen = 0):
- Openbox_execute(openbox, screen, bin)
+ """Executes a command on the specified screen. It is recommended that you
+ use this call instead of a python system call. If the specified screen
+ is beyond your range of screens, the default is used instead."""
+ openbox.execute(screen, bin)
+
+def setup_click_focus(click_raise = 1):
+ """Sets up for focusing windows by clicking on or in the window.
+ Optionally, clicking on or in a window can raise the window to the
+ front of its stacking layer."""
+ mbind("1", MC_Titlebar, MousePress, focus)
+ mbind("1", MC_Handle, MousePress, focus)
+ mbind("1", MC_Grip, MousePress, focus)
+ mbind("1", MC_Window, MousePress, focus)
+ if click_raise:
+ mbind("1", MC_Titlebar, MousePress, raise_win)
+ mbind("1", MC_Handle, MousePress, raise_win)
+ mbind("1", MC_Grip, MousePress, raise_win)
+ mbind("1", MC_Window, MousePress, raise_win)
+
+def setup_sloppy_focus(click_focus = 1, click_raise = 0):
+ """Sets up for focusing windows when the mouse pointer enters them.
+ Optionally, clicking on or in a window can focus it if your pointer
+ ends up inside a window without focus. Also, optionally, clicking on or
+ in a window can raise the window to the front of its stacking layer."""
+ ebind(EventEnterWindow, focus)
+ if click_focus:
+ setup_click_focus(click_raise)
+
+def setup_window_clicks():
+ """Sets up the default bindings for various mouse buttons for various
+ contexts.
+ This includes:
+ * Alt-left drag anywhere on a window will move it
+ * Alt-right drag anywhere on a window will resize it
+ * Left drag on a window's titlebar/handle will move it
+ * Left drag on a window's handle grips will resize it
+ * Alt-left press anywhere on a window's will raise it to the front of
+ its stacking layer.
+ * Left press on a window's titlebar/handle will raise it to the front
+ of its stacking layer.
+ * Alt-middle click anywhere on a window's will lower it to the bottom
+ of its stacking layer.
+ * Middle click on a window's titlebar/handle will lower it to the
+ bottom of its stacking layer.
+ * Double-left click on a window's titlebar will toggle shading it
+ """
+ mbind("A-1", MC_Frame, MouseMotion, move)
+ mbind("1", MC_Titlebar, MouseMotion, move)
+ mbind("1", MC_Handle, MouseMotion, move)
+
+ mbind("A-3", MC_Frame, MouseMotion, resize)
+ mbind("1", MC_Grip, MouseMotion, resize)
+
+ mbind("1", MC_Titlebar, MousePress, raise_win)
+ mbind("1", MC_Handle, MousePress, raise_win)
+ mbind("A-1", MC_Frame, MousePress, raise_win)
+ mbind("A-2", MC_Frame, MouseClick, lower_win)
+ mbind("2", MC_Titlebar, MouseClick, lower_win)
+ mbind("2", MC_Handle, MouseClick, lower_win)
+
+ mbind("1", MC_Titlebar, MouseDoubleClick, toggle_shade)
+
+def setup_window_buttons():
+ """Sets up the default behaviors for the buttons in the window titlebar."""
+ mbind("1", MC_CloseButton, MouseClick, close)
+
+def setup_scroll():
+ """Sets up the default behaviors for the mouse scroll wheel.
+ This includes:
+ * scrolling on a window titlebar will shade/unshade it
+ * alt-scrolling anywhere will switch to the next/previous desktop
+ * control-alt-scrolling on a window will send it to the next/previous
+ desktop, and switch to the desktop with the window
+ """
+ mbind("4", MC_Titlebar, MouseClick, shade)
+ mbind("5", MC_Titlebar, MouseClick, unshade)
+
+ mbind("A-4", MC_Frame, MouseClick, next_desktop)
+ mbind("A-4", MC_Root, MouseClick, next_desktop)
+ mbind("A-5", MC_Frame, MouseClick, prev_desktop)
+ mbind("A-5", MC_Root, MouseClick, prev_desktop)
+
+ mbind("C-A-4", MC_Frame, MouseClick, send_to_next_desktop)
+ mbind("C-A-5", MC_Frame, MouseClick, send_to_prev_desktop)
+
+def setup_fallback_focus():
+ """Sets up a focus fallback routine so that when no windows are focused,
+ the last window to have focus on the desktop will be focused."""
+ focus_stack = []
+ def focused(data):
+ #global focus_stack
+ if data.client:
+ window = data.client.window()
+ # add to front the stack
+ if window in focus_stack:
+ focus_stack.remove(window)
+ focus_stack.insert(0, window)
+ else:
+ # pass around focus
+ desktop = openbox.screen(data.screen).desktop()
+ l = len(focus_stack)
+ i = 0
+ while i < l:
+ w = focus_stack[i]
+ client = openbox.findClient(w)
+ if not client: # window is gone, remove it
+ focus_stack.pop(i)
+ l = l - 1
+ elif client.desktop() == desktop and \
+ client.normal() and client.focus():
+ break
+ else:
+ i = i + 1
+
+ ebind(EventFocus, focused)
+
+
+############################################################################
+### Window placement algorithms, choose one of these and ebind it to the ###
+### EventPlaceWindow action. ###
+############################################################################
+
+ob_rand = None
+import random
+def placewindows_random(data):
+ if not data.client: return
+ client_area = data.client.area()
+ screen = OBDisplay_screenInfo(data.screen)
+ width = screen.width() - client_area.width()
+ height = screen.height() - client_area.height()
+ global ob_rand
+ if not ob_rand: ob_rand = random.Random()
+ x = ob_rand.randrange(0, width-1)
+ y = ob_rand.randrange(0, height-1)
+ data.client.move(x, y)
+
print "Loaded builtins.py"
projects / chaz / openbox / blobdiff