1 ############################################################################
2 ### Functions that can be used as callbacks for mouse/keyboard bindings ###
3 ############################################################################
9 """For the state_* callbacks. Indicates the state should be removed from the
12 """For the state_* callbacks. Indicates the state should be add to the
15 """For the state_* callbacks. Indicates the state should be toggled on the
18 def state_above(data
, add
=StateAdd
):
19 """Toggles, adds or removes the 'above' state on a window.
20 The second paramater should one of: StateRemove, StateAdd, or
22 if not data
.client
: return
23 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
24 otk
.atoms
.net_wm_state
, data
.client
.window(),
25 add
, otk
.atoms
.net_wm_state_above
)
27 def state_below(data
, add
=StateAdd
):
28 """Toggles, adds or removes the 'below' state on a window.
29 The second paramater should one of: StateRemove, StateAdd, or
31 if not data
.client
: return
32 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
33 otk
.atoms
.net_wm_state
, data
.client
.window(),
34 add
, otk
.atoms
.net_wm_state_below
)
36 def state_shaded(data
, add
=StateAdd
):
37 """Toggles, adds or removes the 'shaded' state on a window.
38 The second paramater should one of: StateRemove, StateAdd, or
40 if not data
.client
: return
41 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
42 otk
.atoms
.net_wm_state
, data
.client
.window(),
43 add
, otk
.atoms
.net_wm_state_shaded
)
45 def state_maximize(data
, add
=StateAdd
):
46 """Toggles, adds or removes the horizontal and vertical 'maximized' state
47 on a window. The second paramater should one of: StateRemove, StateAdd,
49 if not data
.client
: return
50 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
51 otk
.atoms
.net_wm_state
, data
.client
.window(),
52 add
, otk
.atoms
.net_wm_state_maximized_horz
,
53 otk
.atoms
.net_wm_state_maximized_vert
)
55 def state_maximize_horz(data
, add
=StateAdd
):
56 """Toggles, adds or removes the horizontal 'maximized' state on a window.
57 The second paramater should one of: StateRemove, StateAdd, or
59 if not data
.client
: return
60 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
61 otk
.atoms
.net_wm_state
, data
.client
.window(),
62 add
, otk
.atoms
.net_wm_state_maximized_horz
)
64 def state_maximize_vert(data
, add
=StateAdd
):
65 """Toggles, adds or removes the vertical 'maximized' state on a window.
66 The second paramater should one of: StateRemove, StateAdd, or
68 if not data
.client
: return
69 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
70 otk
.atoms
.net_wm_state
, data
.client
.window(),
71 add
, otk
.atoms
.net_wm_state_maximized_vert
)
73 def state_skip_taskbar(data
, add
=StateAdd
):
74 """Toggles, adds or removes the 'skip_taskbar' state on a window.
75 The second paramater should one of: StateRemove, StateAdd, or
77 if not data
.client
: return
78 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
79 otk
.atoms
.net_wm_state
, data
.client
.window(),
80 add
, otk
.atoms
.net_wm_state_skip_taskbar
)
82 def state_skip_pager(data
, add
=StateAdd
):
83 """Toggles, adds or removes the 'skip_pager' state on a window.
84 The second paramater should one of: StateRemove, StateAdd, or
86 if not data
.client
: return
87 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
88 otk
.atoms
.net_wm_state
, data
.client
.window(),
89 add
, otk
.atoms
.net_wm_state_skip_pager
)
92 """Iconifies the window on which the event occured"""
93 if not data
.client
: return
94 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
95 otk
.atoms
.wm_change_state
,
96 data
.client
.window(), 3) # IconicState
99 """Un-iconifies the window on which the event occured, but does not focus
100 if. If you want to focus the window too, it is recommended that you
101 use the activate() function."""
102 if not data
.client
: return
103 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
104 otk
.atoms
.wm_change_state
,
105 data
.client
.window(), 1) # NormalState
108 """Closes the window on which the event occured"""
109 if not data
.client
: return
110 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
111 otk
.atoms
.net_close_window
,
112 data
.client
.window(), 0)
115 """Focuses the window on which the event occured"""
116 if not data
.client
: return
117 # !normal windows dont get focus from window enter events
118 if data
.action
== ob
.EventAction
.EnterWindow
and not data
.client
.normal():
123 """Raises the window on which the event occured"""
124 if not data
.client
: return
125 ob
.openbox
.screen(data
.screen
).raiseWindow(data
.client
)
128 """Lowers the window on which the event occured"""
129 if not data
.client
: return
130 ob
.openbox
.screen(data
.screen
).lowerWindow(data
.client
)
132 def toggle_maximize(data
):
133 """Toggles the maximized status of the window on which the event occured"""
134 state_maximize(data
, StateToggle
)
136 def toggle_maximize_horz(data
):
137 """Toggles the horizontal maximized status of the window on which the event
139 state_maximize_horz(data
, StateToggle
)
141 def toggle_maximize_vert(data
):
142 """Toggles the vertical maximized status of the window on which the event
144 state_maximize_vert(data
, StateToggle
)
147 """Maximizes the window on which the event occured"""
148 state_maximize(data
, StateAdd
)
150 def maximize_horz(data
):
151 """Horizontally maximizes the window on which the event occured"""
152 state_maximize_horz(data
, StateAdd
)
154 def maximize_vert(data
):
155 """Vertically maximizes the window on which the event occured"""
156 state_maximize_vert(data
, StateAdd
)
158 def unmaximize(data
):
159 """Unmaximizes the window on which the event occured"""
160 state_maximize(data
, StateRemove
)
162 def unmaximize_horz(data
):
163 """Horizontally unmaximizes the window on which the event occured"""
164 state_maximize_horz(data
, StateRemove
)
166 def unmaximize_vert(data
):
167 """Vertically unmaximizes the window on which the event occured"""
168 state_maximize_vert(data
, StateRemove
)
170 def toggle_shade(data
):
171 """Toggles the shade status of the window on which the event occured"""
172 state_shaded(data
, StateToggle
)
175 """Shades the window on which the event occured"""
176 state_shaded(data
, StateAdd
)
179 """Unshades the window on which the event occured"""
180 state_shaded(data
, StateRemove
)
182 def change_desktop(data
, num
):
183 """Switches to a specified desktop"""
184 root
= otk
.display
.screenInfo(data
.screen
).rootWindow()
185 ob
.send_client_msg(root
, otk
.atoms
.net_current_desktop
,
188 def next_desktop(data
, no_wrap
=0):
189 """Switches to the next desktop, optionally (by default) cycling around to
190 the first when going past the last."""
191 screen
= ob
.openbox
.screen(data
.screen
)
193 n
= screen
.numDesktops()
198 change_desktop(data
, d
)
200 def prev_desktop(data
, no_wrap
=0):
201 """Switches to the previous desktop, optionally (by default) cycling around
202 to the last when going past the first."""
203 screen
= ob
.openbox
.screen(data
.screen
)
205 n
= screen
.numDesktops()
210 change_desktop(data
, d
)
212 def send_to_desktop(data
, num
):
213 """Sends a client to a specified desktop"""
214 if not data
.client
: return
215 ob
.send_client_msg(otk
.display
.screenInfo(data
.screen
).rootWindow(),
216 otk
.atoms
.net_wm_desktop
,
217 data
.client
.window(),num
)
219 def toggle_all_desktops(data
):
220 """Toggles between sending a client to all desktops and to the current
222 if not data
.client
: return
223 if not data
.client
.desktop() == 0xffffffff:
224 send_to_desktop(data
, 0xffffffff)
226 send_to_desktop(data
, ob
.openbox
.screen(data
.screen
).desktop())
228 def send_to_all_desktops(data
):
229 """Sends a client to all desktops"""
230 if not data
.client
: return
231 send_to_desktop(data
, 0xffffffff)
233 def send_to_next_desktop(data
, no_wrap
=0, follow
=1):
234 """Sends a window to the next desktop, optionally (by default) cycling
235 around to the first when going past the last. Also optionally moving to
236 the new desktop after sending the window."""
237 if not data
.client
: return
238 screen
= ob
.openbox
.screen(data
.screen
)
240 n
= screen
.numDesktops()
245 send_to_desktop(data
, d
)
247 change_desktop(data
, d
)
249 def send_to_prev_desktop(data
, no_wrap
=0, follow
=1):
250 """Sends a window to the previous desktop, optionally (by default) cycling
251 around to the last when going past the first. Also optionally moving to
252 the new desktop after sending the window."""
253 if not data
.client
: return
254 screen
= ob
.openbox
.screen(data
.screen
)
256 n
= screen
.numDesktops()
261 send_to_desktop(data
, d
)
263 change_desktop(data
, d
)
265 def restart(data
=0, other
= ""):
266 """Restarts Openbox, optionally starting another window manager."""
267 ob
.openbox
.restart(other
)
271 ob
.openbox
.shutdown()
273 print "Loaded callbacks.py"