]>
Dogcows Code - chaz/openbox/blob - scripts/builtins.py
1 ###########################################################################
2 ### Functions that can be used as callbacks for mouse/keyboard bindings ###
3 ###########################################################################
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_atoms().net_wm_state
, data
.client
.window(), add
,
10 Property_atoms().net_wm_state_above
)
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_atoms().net_wm_state
, data
.client
.window(), add
,
17 Property_atoms().net_wm_state_below
)
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_atoms().net_wm_state
, data
.client
.window(), add
,
24 Property_atoms().net_wm_state_shaded
)
27 """Iconifies the window on which the event occured"""
28 if not data
.client
: return
29 send_client_msg(display
.screenInfo(data
.screen
).rootWindow(),
30 Property_atoms().wm_change_state
,
31 data
.client
.window(), 3) # IconicState
34 """Un-iconifies the window on which the event occured, but does not focus
35 if. If you want to focus the window too, it is recommended that you
36 use the activate() function."""
37 if not data
.client
: return
38 send_client_msg(display
.screenInfo(data
.screen
).rootWindow(),
39 Property_atoms().wm_change_state
,
40 data
.client
.window(), 1) # NormalState
43 """Closes the window on which the event occured"""
44 if not data
.client
: return
45 send_client_msg(display
.screenInfo(data
.screen
).rootWindow(),
46 Property_atoms().net_close_window
, data
.client
.window(), 0)
49 """Focuses the window on which the event occured"""
50 if not data
.client
: return
51 # !normal windows dont get focus from window enter events
52 if data
.action
== EventEnterWindow
and not data
.client
.normal():
57 """Moves the window interactively. This should only be used with
59 if not data
.client
: return
61 # !normal windows dont get moved
62 if not data
.client
.normal(): return
64 dx
= data
.xroot
- data
.pressx
65 dy
= data
.yroot
- data
.pressy
66 data
.client
.move(data
.press_clientx
+ dx
, data
.press_clienty
+ dy
)
69 """Resizes the window interactively. This should only be used with
71 if not data
.client
: return
73 # !normal windows dont get moved
74 if not data
.client
.normal(): return
81 # pick a corner to anchor
82 if not (resize_nearest
or data
.context
== MC_Grip
):
83 corner
= Client
.TopLeft
85 x
= px
- data
.press_clientx
86 y
= py
- data
.press_clienty
87 if y
< data
.press_clientheight
/ 2:
88 if x
< data
.press_clientwidth
/ 2:
89 corner
= Client
.BottomRight
92 corner
= Client
.BottomLeft
95 if x
< data
.press_clientwidth
/ 2:
96 corner
= Client
.TopRight
99 corner
= Client
.TopLeft
101 data
.client
.resize(corner
,
102 data
.press_clientwidth
+ dx
,
103 data
.press_clientheight
+ dy
);
105 def restart(data
, other
= ""):
106 """Restarts openbox, optionally starting another window manager."""
107 openbox
.restart(other
)
110 """Raises the window on which the event occured"""
111 if not data
.client
: return
112 openbox
.screen(data
.screen
).raiseWindow(data
.client
)
115 """Lowers the window on which the event occured"""
116 if not data
.client
: return
117 openbox
.screen(data
.screen
).lowerWindow(data
.client
)
119 def toggle_shade(data
):
120 """Toggles the shade status of the window on which the event occured"""
124 """Shades the window on which the event occured"""
125 state_shaded(data
, 1)
128 """Unshades the window on which the event occured"""
129 state_shaded(data
, 0)
131 def change_desktop(data
, num
):
132 """Switches to a specified desktop"""
133 root
= display
.screenInfo(data
.screen
).rootWindow()
134 send_client_msg(root
, Property_atoms().net_current_desktop
, root
, num
)
136 def next_desktop(data
, no_wrap
=0):
137 """Switches to the next desktop, optionally (by default) cycling around to
138 the first when going past the last."""
139 screen
= openbox
.screen(data
.screen
)
141 n
= screen
.numDesktops()
146 change_desktop(data
, d
)
148 def prev_desktop(data
, no_wrap
=0):
149 """Switches to the previous desktop, optionally (by default) cycling around
150 to the last when going past the first."""
151 screen
= openbox
.screen(data
.screen
)
153 n
= screen
.numDesktops()
158 change_desktop(data
, d
)
160 def send_to_desktop(data
, num
):
161 """Sends a client to a specified desktop"""
162 if not data
.client
: return
163 send_client_msg(display
.screenInfo(data
.screen
).rootWindow(),
164 Property_atoms().net_wm_desktop
, data
.client
.window(), num
)
166 def toggle_all_desktops(data
):
167 """Toggles between sending a client to all desktops and to the current
169 if not data
.client
: return
170 if not data
.client
.desktop() == 0xffffffff:
171 send_to_desktop(data
, 0xffffffff)
173 send_to_desktop(data
, openbox
.screen(data
.screen
).desktop())
175 def send_to_all_desktops(data
):
176 """Sends a client to all desktops"""
177 if not data
.client
: return
178 send_to_desktop(data
, 0xffffffff)
180 def send_to_next_desktop(data
, no_wrap
=0, follow
=1):
181 """Sends a window to the next desktop, optionally (by default) cycling
182 around to the first when going past the last. Also optionally moving to
183 the new desktop after sending the window."""
184 if not data
.client
: return
185 screen
= openbox
.screen(data
.screen
)
187 n
= screen
.numDesktops()
192 send_to_desktop(data
, d
)
194 change_desktop(data
, d
)
196 def send_to_prev_desktop(data
, no_wrap
=0, follow
=1):
197 """Sends a window to the previous desktop, optionally (by default) cycling
198 around to the last when going past the first. Also optionally moving to
199 the new desktop after sending the window."""
200 if not data
.client
: return
201 screen
= openbox
.screen(data
.screen
)
203 n
= screen
.numDesktops()
208 send_to_desktop(data
, d
)
210 change_desktop(data
, d
)
212 #########################################
213 ### Convenience functions for scripts ###
214 #########################################
216 def execute(bin
, screen
= 0):
217 """Executes a command on the specified screen. It is recommended that you
218 use this call instead of a python system call. If the specified screen
219 is beyond your range of screens, the default is used instead."""
220 openbox
.execute(screen
, bin
)
222 def setup_click_focus(click_raise
= 1):
223 """Sets up for focusing windows by clicking on or in the window.
224 Optionally, clicking on or in a window can raise the window to the
225 front of its stacking layer."""
226 mbind("Left", MC_Titlebar
, MousePress
, focus
)
227 mbind("Left", MC_Handle
, MousePress
, focus
)
228 mbind("Left", MC_Grip
, MousePress
, focus
)
229 mbind("Left", MC_Window
, MousePress
, focus
)
231 mbind("Left", MC_Titlebar
, MousePress
, raise_win
)
232 mbind("Left", MC_Handle
, MousePress
, raise_win
)
233 mbind("Left", MC_Grip
, MousePress
, raise_win
)
234 mbind("Left", MC_Window
, MousePress
, raise_win
)
236 def setup_sloppy_focus(click_focus
= 1, click_raise
= 0):
237 """Sets up for focusing windows when the mouse pointer enters them.
238 Optionally, clicking on or in a window can focus it if your pointer
239 ends up inside a window without focus. Also, optionally, clicking on or
240 in a window can raise the window to the front of its stacking layer."""
241 ebind(EventEnterWindow
, focus
)
243 setup_click_focus(click_raise
)
245 def setup_window_clicks():
246 """Sets up the default bindings for various mouse buttons for various
249 * Alt-left drag anywhere on a window will move it
250 * Alt-right drag anywhere on a window will resize it
251 * Left drag on a window's titlebar/handle will move it
252 * Left drag on a window's handle grips will resize it
253 * Alt-left press anywhere on a window's will raise it to the front of
255 * Left press on a window's titlebar/handle will raise it to the front
256 of its stacking layer.
257 * Alt-middle click anywhere on a window's will lower it to the bottom
258 of its stacking layer.
259 * Middle click on a window's titlebar/handle will lower it to the
260 bottom of its stacking layer.
261 * Double-left click on a window's titlebar will toggle shading it
263 mbind("A-Left", MC_Frame
, MouseMotion
, move
)
264 mbind("Left", MC_Titlebar
, MouseMotion
, move
)
265 mbind("Left", MC_Handle
, MouseMotion
, move
)
267 mbind("A-Right", MC_Frame
, MouseMotion
, resize
)
268 mbind("Left", MC_Grip
, MouseMotion
, resize
)
270 mbind("Left", MC_Titlebar
, MousePress
, raise_win
)
271 mbind("Left", MC_Handle
, MousePress
, raise_win
)
272 mbind("A-Left", MC_Frame
, MousePress
, raise_win
)
273 mbind("A-Middle", MC_Frame
, MouseClick
, lower_win
)
274 mbind("Middle", MC_Titlebar
, MouseClick
, lower_win
)
275 mbind("Middle", MC_Handle
, MouseClick
, lower_win
)
277 mbind("Left", MC_Titlebar
, MouseDoubleClick
, toggle_shade
)
279 def setup_window_buttons():
280 """Sets up the default behaviors for the buttons in the window titlebar."""
281 mbind("Left", MC_AllDesktopsButton
, MouseClick
, toggle_all_desktops
)
282 mbind("Left", MC_CloseButton
, MouseClick
, close
)
283 mbind("Left", MC_IconifyButton
, MouseClick
, iconify
)
286 """Sets up the default behaviors for the mouse scroll wheel.
288 * scrolling on a window titlebar will shade/unshade it
289 * alt-scrolling anywhere will switch to the next/previous desktop
290 * control-alt-scrolling on a window will send it to the next/previous
291 desktop, and switch to the desktop with the window
293 mbind("Up", MC_Titlebar
, MouseClick
, shade
)
294 mbind("Down", MC_Titlebar
, MouseClick
, unshade
)
296 mbind("A-Up", MC_Frame
, MouseClick
, next_desktop
)
297 mbind("A-Up", MC_Root
, MouseClick
, next_desktop
)
298 mbind("A-Down", MC_Frame
, MouseClick
, prev_desktop
)
299 mbind("A-Down", MC_Root
, MouseClick
, prev_desktop
)
301 mbind("C-A-Up", MC_Frame
, MouseClick
, send_to_next_desktop
)
302 mbind("C-A-Down", MC_Frame
, MouseClick
, send_to_prev_desktop
)
304 def setup_fallback_focus():
305 """Sets up a focus fallback routine so that when no windows are focused,
306 the last window to have focus on the desktop will be focused."""
307 global ob_focus_fallback
# see focus.py
308 ob_focus_fallback
= 1
310 ############################################################################
311 ### Window placement algorithms, choose one of these and ebind it to the ###
312 ### EventPlaceWindow action. ###
313 ############################################################################
317 def placewindows_random(data
):
318 if not data
.client
: return
319 client_area
= data
.client
.area()
320 frame_size
= data
.client
.frame
.size()
321 screen
= display
.screenInfo(data
.screen
)
322 width
= screen
.width() - (client_area
.width() +
323 frame_size
.left
+ frame_size
.right
)
324 height
= screen
.height() - (client_area
.height() +
325 frame_size
.top
+ frame_size
.bottom
)
327 if not ob_rand
: ob_rand
= random
.Random()
328 x
= ob_rand
.randrange(0, width
-1)
329 y
= ob_rand
.randrange(0, height
-1)
330 data
.client
.move(x
, y
)
333 print "Loaded builtins.py"
This page took 0.052045 seconds and 5 git commands to generate.