dont use append, dont need to extend ustring!
[mikachu/openbox.git] / scripts / builtins.py
1 ###########################################################################
2 ### Functions that can be used as callbacks for mouse/keyboard bindings ###
3 ###########################################################################
4
5 def state_above(data, add=2):
6     """Toggles, adds or removes the 'above' state on a window."""
7     if not data.client: return
8     send_client_msg(Display_screenInfo(data.screen).rootWindow(),
9                     Property.net_wm_state, data.client.window(), add,
10                     openbox.property().atom(Property.net_wm_state_above))
11     
12 def state_below(data, add=2):
13     """Toggles, adds or removes the 'below' state on a window."""
14     if not data.client: return
15     send_client_msg(Display_screenInfo(data.screen).rootWindow(),
16                     Property.net_wm_state, data.client.window(), add,
17                     openbox.property().atom(Property.net_wm_state_below))
18     
19 def state_shaded(data, add=2):
20     """Toggles, adds or removes the 'shaded' state on a window."""
21     if not data.client: return
22     send_client_msg(Display_screenInfo(data.screen).rootWindow(),
23                     Property.net_wm_state, data.client.window(), add,
24                     openbox.property().atom(Property.net_wm_state_shaded))
25     
26 def close(data):
27     """Closes the window on which the event occured"""
28     if not data.client: return
29     send_client_msg(Display_screenInfo(data.screen).rootWindow(),
30                     Property.net_close_window, data.client.window(), 0)
31
32 def focus(data):
33     """Focuses the window on which the event occured"""
34     if not data.client: return
35     # !normal windows dont get focus from window enter events
36     if data.action == EventEnterWindow and not data.client.normal():
37         return
38     data.client.focus()
39
40 def move(data):
41     """Moves the window interactively. This should only be used with
42        MouseMotion events"""
43     if not data.client: return
44
45     # !normal windows dont get moved
46     if not data.client.normal(): return
47
48     dx = data.xroot - data.pressx
49     dy = data.yroot - data.pressy
50     data.client.move(data.press_clientx + dx, data.press_clienty + dy)
51
52 def resize(data):
53     """Resizes the window interactively. This should only be used with
54        MouseMotion events"""
55     if not data.client: return
56
57     # !normal windows dont get moved
58     if not data.client.normal(): return
59
60     px = data.pressx
61     py = data.pressy
62     dx = data.xroot - px
63     dy = data.yroot - py
64
65     # pick a corner to anchor
66     if not (resize_nearest or data.context == MC_Grip):
67         corner = Client.TopLeft
68     else:
69         x = px - data.press_clientx
70         y = py - data.press_clienty
71         if y < data.press_clientheight / 2:
72             if x < data.press_clientwidth / 2:
73                 corner = Client.BottomRight
74                 dx *= -1
75             else:
76                 corner = Client.BottomLeft
77             dy *= -1
78         else:
79             if x < data.press_clientwidth / 2:
80                 corner = Client.TopRight
81                 dx *= -1
82             else:
83                 corner = Client.TopLeft
84
85     data.client.resize(corner,
86                        data.press_clientwidth + dx,
87                        data.press_clientheight + dy);
88
89 def restart(data, other = ""):
90     """Restarts openbox, optionally starting another window manager."""
91     openbox.restart(other)
92
93 def raise_win(data):
94     """Raises the window on which the event occured"""
95     if not data.client: return
96     openbox.screen(data.screen).restack(1, data.client)
97
98 def lower_win(data):
99     """Lowers the window on which the event occured"""
100     if not data.client: return
101     openbox.screen(data.screen).restack(0, data.client)
102
103 def toggle_shade(data):
104     """Toggles the shade status of the window on which the event occured"""
105     state_shaded(data)
106
107 def shade(data):
108     """Shades the window on which the event occured"""
109     state_shaded(data, 1)
110
111 def unshade(data):
112     """Unshades the window on which the event occured"""
113     state_shaded(data, 0)
114
115 def change_desktop(data, num):
116     """Switches to a specified desktop"""
117     root = Display_screenInfo(data.screen).rootWindow()
118     send_client_msg(root, Property.net_current_desktop, root, num)
119
120 def next_desktop(data, no_wrap=0):
121     """Switches to the next desktop, optionally (by default) cycling around to
122        the first when going past the last."""
123     screen = openbox.screen(data.screen)
124     d = screen.desktop()
125     n = screen.numDesktops()
126     if (d < (n-1)):
127         d = d + 1
128     elif not no_wrap:
129         d = 0
130     change_desktop(data, d)
131     
132 def prev_desktop(data, no_wrap=0):
133     """Switches to the previous desktop, optionally (by default) cycling around
134        to the last when going past the first."""
135     screen = openbox.screen(data.screen)
136     d = screen.desktop()
137     n = screen.numDesktops()
138     if (d > 0):
139         d = d - 1
140     elif not no_wrap:
141         d = n - 1
142     change_desktop(data, d)
143
144 def send_to_all_desktops(data):
145     """Sends a client to all desktops"""
146     if not data.client: return
147     send_client_msg(Display_screenInfo(data.screen).rootWindow(),
148                     Property.net_wm_desktop, data.client.window(), 0xffffffff)
149     
150 def send_to_desktop(data, num):
151     """Sends a client to a specified desktop"""
152     if not data.client: return
153     send_client_msg(Display_screenInfo(data.screen).rootWindow(),
154                     Property.net_wm_desktop, data.client.window(), num)
155
156 def send_to_next_desktop(data, no_wrap=0, follow=1):
157     """Sends a window to the next desktop, optionally (by default) cycling
158        around to the first when going past the last. Also optionally moving to
159        the new desktop after sending the window."""
160     if not data.client: return
161     screen = openbox.screen(data.screen)
162     d = screen.desktop()
163     n = screen.numDesktops()
164     if (d < (n-1)):
165         d = d + 1
166     elif not no_wrap:
167         d = 0
168     send_to_desktop(data, d)
169     if follow:
170         change_desktop(data, d)
171     
172 def send_to_prev_desktop(data, no_wrap=0, follow=1):
173     """Sends a window to the previous desktop, optionally (by default) cycling
174        around to the last when going past the first. Also optionally moving to
175        the new desktop after sending the window."""
176     if not data.client: return
177     screen = openbox.screen(data.screen)
178     d = screen.desktop()
179     n = screen.numDesktops()
180     if (d > 0):
181         d = d - 1
182     elif not no_wrap:
183         d = n - 1
184     send_to_desktop(data, d)
185     if follow:
186         change_desktop(data, d)
187
188 #########################################
189 ### Convenience functions for scripts ###
190 #########################################
191
192 def execute(bin, screen = 0):
193     """Executes a command on the specified screen. It is recommended that you
194        use this call instead of a python system call. If the specified screen
195        is beyond your range of screens, the default is used instead."""
196     openbox.execute(screen, bin)
197
198 def setup_click_focus(click_raise = 1):
199     """Sets up for focusing windows by clicking on or in the window.
200        Optionally, clicking on or in a window can raise the window to the
201        front of its stacking layer."""
202     mbind("Left", MC_Titlebar, MousePress, focus)
203     mbind("Left", MC_Handle, MousePress, focus)
204     mbind("Left", MC_Grip, MousePress, focus)
205     mbind("Left", MC_Window, MousePress, focus)
206     if click_raise:
207         mbind("Left", MC_Titlebar, MousePress, raise_win)
208         mbind("Left", MC_Handle, MousePress, raise_win)
209         mbind("Left", MC_Grip, MousePress, raise_win)
210         mbind("Left", MC_Window, MousePress, raise_win)
211
212 def setup_sloppy_focus(click_focus = 1, click_raise = 0):
213     """Sets up for focusing windows when the mouse pointer enters them.
214        Optionally, clicking on or in a window can focus it if your pointer
215        ends up inside a window without focus. Also, optionally, clicking on or
216        in a window can raise the window to the front of its stacking layer."""
217     ebind(EventEnterWindow, focus)
218     if click_focus:
219         setup_click_focus(click_raise)
220
221 def setup_window_clicks():
222     """Sets up the default bindings for various mouse buttons for various
223        contexts.
224        This includes:
225         * Alt-left drag anywhere on a window will move it
226         * Alt-right drag anywhere on a window will resize it
227         * Left drag on a window's titlebar/handle will move it
228         * Left drag on a window's handle grips will resize it
229         * Alt-left press anywhere on a window's will raise it to the front of
230           its stacking layer.
231         * Left press on a window's titlebar/handle will raise it to the front
232           of its stacking layer.
233         * Alt-middle click anywhere on a window's will lower it to the bottom
234           of its stacking layer.
235         * Middle click on a window's titlebar/handle will lower it to the
236           bottom of its stacking layer.
237         * Double-left click on a window's titlebar will toggle shading it
238     """
239     mbind("A-Left", MC_Frame, MouseMotion, move)
240     mbind("Left", MC_Titlebar, MouseMotion, move)
241     mbind("Left", MC_Handle, MouseMotion, move)
242
243     mbind("A-Right", MC_Frame, MouseMotion, resize)
244     mbind("Left", MC_Grip, MouseMotion, resize)
245
246     mbind("Left", MC_Titlebar, MousePress, raise_win)
247     mbind("Left", MC_Handle, MousePress, raise_win)
248     mbind("A-Left", MC_Frame, MousePress, raise_win)
249     mbind("A-Middle", MC_Frame, MouseClick, lower_win)
250     mbind("Middle", MC_Titlebar, MouseClick, lower_win)
251     mbind("Middle", MC_Handle, MouseClick, lower_win)
252
253     mbind("Left", MC_Titlebar, MouseDoubleClick, toggle_shade)
254
255 def setup_window_buttons():
256     """Sets up the default behaviors for the buttons in the window titlebar."""
257     mbind("Left", MC_CloseButton, MouseClick, close)
258
259 def setup_scroll():
260     """Sets up the default behaviors for the mouse scroll wheel.
261        This includes:
262         * scrolling on a window titlebar will shade/unshade it
263         * alt-scrolling anywhere will switch to the next/previous desktop
264         * control-alt-scrolling on a window will send it to the next/previous
265           desktop, and switch to the desktop with the window
266     """
267     mbind("Up", MC_Titlebar, MouseClick, shade)
268     mbind("Down", MC_Titlebar, MouseClick, unshade)
269
270     mbind("A-Up", MC_Frame, MouseClick, next_desktop)
271     mbind("A-Up", MC_Root, MouseClick, next_desktop)
272     mbind("A-Down", MC_Frame, MouseClick, prev_desktop)
273     mbind("A-Down", MC_Root, MouseClick, prev_desktop)
274
275     mbind("C-A-Up", MC_Frame, MouseClick, send_to_next_desktop)
276     mbind("C-A-Down", MC_Frame, MouseClick, send_to_prev_desktop)
277
278 def setup_fallback_focus():
279     """Sets up a focus fallback routine so that when no windows are focused,
280        the last window to have focus on the desktop will be focused."""
281     focus_stack = []
282     def focused(data):
283         #global focus_stack
284         if data.client:
285             window = data.client.window()
286             # add to front the stack
287             if window in focus_stack:
288                 focus_stack.remove(window)
289             focus_stack.insert(0, window)
290         else:
291             # pass around focus
292             desktop = openbox.screen(data.screen).desktop()
293             l = len(focus_stack)
294             i = 0
295             while i < l:
296                 w = focus_stack[i]
297                 client = openbox.findClient(w)
298                 if not client: # window is gone, remove it
299                     focus_stack.pop(i)
300                     l = l - 1
301                 elif client.desktop() == desktop and \
302                          client.normal() and client.focus():
303                     break
304                 else:
305                     i = i + 1
306
307     ebind(EventFocus, focused)
308
309     
310 ############################################################################
311 ### Window placement algorithms, choose one of these and ebind it to the ###
312 ### EventPlaceWindow action.                                             ###
313 ############################################################################
314
315 ob_rand = None
316 import random
317 def placewindows_random(data):
318     if not data.client: return
319     client_area = data.client.area()
320     screen = Display_screenInfo(data.screen)
321     width = screen.width() - client_area.width()
322     height = screen.height() - client_area.height()
323     global ob_rand
324     if not ob_rand: ob_rand = random.Random()
325     x = ob_rand.randrange(0, width-1)
326     y = ob_rand.randrange(0, height-1)
327     data.client.move(x, y)
328
329
330 print "Loaded builtins.py"