Debian Codegraph @

doc/scripting/lib.scripting.Window-class.html

raw
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <title>lib.scripting.Window</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35 </table>
36 <table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 Package&nbsp;lib ::
41 <a href="lib.scripting-module.html">Module&nbsp;scripting</a> ::
42 Class&nbsp;Window
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="lib.scripting.Window-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57 </table>
58 <!-- ==================== CLASS DESCRIPTION ==================== -->
59 <h1 class="epydoc">Class Window</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Window">source&nbsp;code</a></span></p>
60 <p>Basic window management using wmctrl</p>
61 <p>Note: in all cases where a window title is required (with the
62 exception of wait_for_focus()), two special values of window title are
63 permitted:</p>
64 <p>:ACTIVE: - select the currently active window :SELECT: - select the
65 desired window by clicking on it</p>
66
67 <!-- ==================== INSTANCE METHODS ==================== -->
68 <a name="section-InstanceMethods"></a>
69 <table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71 <tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Instance Methods</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-InstanceMethods"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83 </tr>
84 <tr>
85 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <table width="100%" cellpadding="0" cellspacing="0" border="0">
89 <tr>
90 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
91 <span class="summary-sig-arg">mediator</span>)</span></td>
92 <td align="right" valign="top">
93 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.__init__">source&nbsp;code</a></span>
94
95 </td>
96 </tr>
97 </table>
98
99 </td>
100 </tr>
101 <tr>
102 <td width="15%" align="right" valign="top" class="summary">
103 <span class="summary-type">boolean</span>
104 </td><td class="summary">
105 <table width="100%" cellpadding="0" cellspacing="0" border="0">
106 <tr>
107 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#wait_for_focus" class="summary-sig-name">wait_for_focus</a>(<span class="summary-sig-arg">self</span>,
108 <span class="summary-sig-arg">title</span>,
109 <span class="summary-sig-arg">timeOut</span>=<span class="summary-sig-default">5</span>)</span><br />
110 Wait for window with the given title to have focus</td>
111 <td align="right" valign="top">
112 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_focus">source&nbsp;code</a></span>
113
114 </td>
115 </tr>
116 </table>
117
118 </td>
119 </tr>
120 <tr>
121 <td width="15%" align="right" valign="top" class="summary">
122 <span class="summary-type">boolean</span>
123 </td><td class="summary">
124 <table width="100%" cellpadding="0" cellspacing="0" border="0">
125 <tr>
126 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#wait_for_exist" class="summary-sig-name">wait_for_exist</a>(<span class="summary-sig-arg">self</span>,
127 <span class="summary-sig-arg">title</span>,
128 <span class="summary-sig-arg">timeOut</span>=<span class="summary-sig-default">5</span>)</span><br />
129 Wait for window with the given title to be created</td>
130 <td align="right" valign="top">
131 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_exist">source&nbsp;code</a></span>
132
133 </td>
134 </tr>
135 </table>
136
137 </td>
138 </tr>
139 <tr>
140 <td width="15%" align="right" valign="top" class="summary">
141 <span class="summary-type">&nbsp;</span>
142 </td><td class="summary">
143 <table width="100%" cellpadding="0" cellspacing="0" border="0">
144 <tr>
145 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#activate" class="summary-sig-name">activate</a>(<span class="summary-sig-arg">self</span>,
146 <span class="summary-sig-arg">title</span>,
147 <span class="summary-sig-arg">switchDesktop</span>=<span class="summary-sig-default">False</span>,
148 <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
149 Activate the specified window, giving it input focus</td>
150 <td align="right" valign="top">
151 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.activate">source&nbsp;code</a></span>
152
153 </td>
154 </tr>
155 </table>
156
157 </td>
158 </tr>
159 <tr>
160 <td width="15%" align="right" valign="top" class="summary">
161 <span class="summary-type">&nbsp;</span>
162 </td><td class="summary">
163 <table width="100%" cellpadding="0" cellspacing="0" border="0">
164 <tr>
165 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#close" class="summary-sig-name">close</a>(<span class="summary-sig-arg">self</span>,
166 <span class="summary-sig-arg">title</span>,
167 <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
168 Close the specified window gracefully</td>
169 <td align="right" valign="top">
170 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.close">source&nbsp;code</a></span>
171
172 </td>
173 </tr>
174 </table>
175
176 </td>
177 </tr>
178 <tr>
179 <td width="15%" align="right" valign="top" class="summary">
180 <span class="summary-type">&nbsp;</span>
181 </td><td class="summary">
182 <table width="100%" cellpadding="0" cellspacing="0" border="0">
183 <tr>
184 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#resize_move" class="summary-sig-name">resize_move</a>(<span class="summary-sig-arg">self</span>,
185 <span class="summary-sig-arg">title</span>,
186 <span class="summary-sig-arg">xOrigin</span>=<span class="summary-sig-default">-1</span>,
187 <span class="summary-sig-arg">yOrigin</span>=<span class="summary-sig-default">-1</span>,
188 <span class="summary-sig-arg">width</span>=<span class="summary-sig-default">-1</span>,
189 <span class="summary-sig-arg">height</span>=<span class="summary-sig-default">-1</span>,
190 <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
191 Resize and/or move the specified window</td>
192 <td align="right" valign="top">
193 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.resize_move">source&nbsp;code</a></span>
194
195 </td>
196 </tr>
197 </table>
198
199 </td>
200 </tr>
201 <tr>
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <table width="100%" cellpadding="0" cellspacing="0" border="0">
206 <tr>
207 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#move_to_desktop" class="summary-sig-name">move_to_desktop</a>(<span class="summary-sig-arg">self</span>,
208 <span class="summary-sig-arg">title</span>,
209 <span class="summary-sig-arg">deskNum</span>,
210 <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
211 Move the specified window to the given desktop</td>
212 <td align="right" valign="top">
213 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.move_to_desktop">source&nbsp;code</a></span>
214
215 </td>
216 </tr>
217 </table>
218
219 </td>
220 </tr>
221 <tr>
222 <td width="15%" align="right" valign="top" class="summary">
223 <span class="summary-type">&nbsp;</span>
224 </td><td class="summary">
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr>
227 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#switch_desktop" class="summary-sig-name">switch_desktop</a>(<span class="summary-sig-arg">self</span>,
228 <span class="summary-sig-arg">deskNum</span>)</span><br />
229 Switch to the specified desktop</td>
230 <td align="right" valign="top">
231 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.switch_desktop">source&nbsp;code</a></span>
232
233 </td>
234 </tr>
235 </table>
236
237 </td>
238 </tr>
239 <tr>
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type">&nbsp;</span>
242 </td><td class="summary">
243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
244 <tr>
245 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#set_property" class="summary-sig-name">set_property</a>(<span class="summary-sig-arg">self</span>,
246 <span class="summary-sig-arg">title</span>,
247 <span class="summary-sig-arg">action</span>,
248 <span class="summary-sig-arg">prop</span>,
249 <span class="summary-sig-arg">matchClass</span>=<span class="summary-sig-default">False</span>)</span><br />
250 Set a property on the given window using the specified action</td>
251 <td align="right" valign="top">
252 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.set_property">source&nbsp;code</a></span>
253
254 </td>
255 </tr>
256 </table>
257
258 </td>
259 </tr>
260 <tr>
261 <td width="15%" align="right" valign="top" class="summary">
262 <span class="summary-type"><code>tuple(int, int, int, int)</code></span>
263 </td><td class="summary">
264 <table width="100%" cellpadding="0" cellspacing="0" border="0">
265 <tr>
266 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#get_active_geometry" class="summary-sig-name">get_active_geometry</a>(<span class="summary-sig-arg">self</span>)</span><br />
267 Get the geometry of the currently active window</td>
268 <td align="right" valign="top">
269 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_geometry">source&nbsp;code</a></span>
270
271 </td>
272 </tr>
273 </table>
274
275 </td>
276 </tr>
277 <tr>
278 <td width="15%" align="right" valign="top" class="summary">
279 <span class="summary-type"><code>str</code></span>
280 </td><td class="summary">
281 <table width="100%" cellpadding="0" cellspacing="0" border="0">
282 <tr>
283 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#get_active_title" class="summary-sig-name">get_active_title</a>(<span class="summary-sig-arg">self</span>)</span><br />
284 Get the visible title of the currently active window</td>
285 <td align="right" valign="top">
286 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_title">source&nbsp;code</a></span>
287
288 </td>
289 </tr>
290 </table>
291
292 </td>
293 </tr>
294 <tr>
295 <td width="15%" align="right" valign="top" class="summary">
296 <span class="summary-type"><code>str</code></span>
297 </td><td class="summary">
298 <table width="100%" cellpadding="0" cellspacing="0" border="0">
299 <tr>
300 <td><span class="summary-sig"><a href="lib.scripting.Window-class.html#get_active_class" class="summary-sig-name">get_active_class</a>(<span class="summary-sig-arg">self</span>)</span><br />
301 Get the class of the currently active window</td>
302 <td align="right" valign="top">
303 <span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_class">source&nbsp;code</a></span>
304
305 </td>
306 </tr>
307 </table>
308
309 </td>
310 </tr>
311 <tr class="private">
312 <td width="15%" align="right" valign="top" class="summary">
313 <span class="summary-type">&nbsp;</span>
314 </td><td class="summary">
315 <table width="100%" cellpadding="0" cellspacing="0" border="0">
316 <tr>
317 <td><span class="summary-sig"><a name="_run_wmctrl"></a><span class="summary-sig-name">_run_wmctrl</span>(<span class="summary-sig-arg">self</span>,
318 <span class="summary-sig-arg">args</span>)</span></td>
319 <td align="right" valign="top">
320 <span class="codelink"><a href="lib.scripting-pysrc.html#Window._run_wmctrl">source&nbsp;code</a></span>
321
322 </td>
323 </tr>
324 </table>
325
326 </td>
327 </tr>
328 </table>
329 <!-- ==================== METHOD DETAILS ==================== -->
330 <a name="section-MethodDetails"></a>
331 <table class="details" border="1" cellpadding="3"
332 cellspacing="0" width="100%" bgcolor="white">
333 <tr bgcolor="#70b0f0" class="table-header">
334 <td colspan="2" class="table-header">
335 <table border="0" cellpadding="0" cellspacing="0" width="100%">
336 <tr valign="top">
337 <td align="left"><span class="table-header">Method Details</span></td>
338 <td align="right" valign="top"
339 ><span class="options">[<a href="#section-MethodDetails"
340 class="privatelink" onclick="toggle_private();"
341 >hide private</a>]</span></td>
342 </tr>
343 </table>
344 </td>
345 </tr>
346 </table>
347 <a name="wait_for_focus"></a>
348 <div>
349 <table class="details" border="1" cellpadding="3"
350 cellspacing="0" width="100%" bgcolor="white">
351 <tr><td>
352 <table width="100%" cellpadding="0" cellspacing="0" border="0">
353 <tr valign="top"><td>
354 <h3 class="epydoc"><span class="sig"><span class="sig-name">wait_for_focus</span>(<span class="sig-arg">self</span>,
355 <span class="sig-arg">title</span>,
356 <span class="sig-arg">timeOut</span>=<span class="sig-default">5</span>)</span>
357 </h3>
358 </td><td align="right" valign="top"
359 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_focus">source&nbsp;code</a></span>&nbsp;
360 </td>
361 </tr></table>
362
363 <p>Wait for window with the given title to have focus</p>
364 <p>Usage: <code>window.wait_for_focus(title, timeOut=5)</code></p>
365 <p>If the window becomes active, returns True. Otherwise, returns False
366 if the window has not become active by the time the timeout has
367 elapsed.</p>
368 <dl class="fields">
369 <dt>Parameters:</dt>
370 <dd><ul class="nomargin-top">
371 <li><strong class="pname"><code>title</code></strong> - title to match against (as a regular expression)</li>
372 <li><strong class="pname"><code>timeOut</code></strong> - period (seconds) to wait before giving up</li>
373 </ul></dd>
374 <dt>Returns: boolean</dt>
375 </dl>
376 </td></tr></table>
377 </div>
378 <a name="wait_for_exist"></a>
379 <div>
380 <table class="details" border="1" cellpadding="3"
381 cellspacing="0" width="100%" bgcolor="white">
382 <tr><td>
383 <table width="100%" cellpadding="0" cellspacing="0" border="0">
384 <tr valign="top"><td>
385 <h3 class="epydoc"><span class="sig"><span class="sig-name">wait_for_exist</span>(<span class="sig-arg">self</span>,
386 <span class="sig-arg">title</span>,
387 <span class="sig-arg">timeOut</span>=<span class="sig-default">5</span>)</span>
388 </h3>
389 </td><td align="right" valign="top"
390 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.wait_for_exist">source&nbsp;code</a></span>&nbsp;
391 </td>
392 </tr></table>
393
394 <p>Wait for window with the given title to be created</p>
395 <p>Usage: <code>window.wait_for_exist(title, timeOut=5)</code></p>
396 <p>If the window is in existence, returns True. Otherwise, returns False
397 if the window has not been created by the time the timeout has
398 elapsed.</p>
399 <dl class="fields">
400 <dt>Parameters:</dt>
401 <dd><ul class="nomargin-top">
402 <li><strong class="pname"><code>title</code></strong> - title to match against (as a regular expression)</li>
403 <li><strong class="pname"><code>timeOut</code></strong> - period (seconds) to wait before giving up</li>
404 </ul></dd>
405 <dt>Returns: boolean</dt>
406 </dl>
407 </td></tr></table>
408 </div>
409 <a name="activate"></a>
410 <div>
411 <table class="details" border="1" cellpadding="3"
412 cellspacing="0" width="100%" bgcolor="white">
413 <tr><td>
414 <table width="100%" cellpadding="0" cellspacing="0" border="0">
415 <tr valign="top"><td>
416 <h3 class="epydoc"><span class="sig"><span class="sig-name">activate</span>(<span class="sig-arg">self</span>,
417 <span class="sig-arg">title</span>,
418 <span class="sig-arg">switchDesktop</span>=<span class="sig-default">False</span>,
419 <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
420 </h3>
421 </td><td align="right" valign="top"
422 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.activate">source&nbsp;code</a></span>&nbsp;
423 </td>
424 </tr></table>
425
426 <p>Activate the specified window, giving it input focus</p>
427 <p>Usage: <code>window.activate(title, switchDesktop=False,
428 matchClass=False)</code></p>
429 <p>If switchDesktop is False (default), the window will be moved to the
430 current desktop and activated. Otherwise, switch to the window's current
431 desktop and activate it there.</p>
432 <dl class="fields">
433 <dt>Parameters:</dt>
434 <dd><ul class="nomargin-top">
435 <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring
436 match)</li>
437 <li><strong class="pname"><code>switchDesktop</code></strong> - whether or not to switch to the window's current desktop</li>
438 <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
439 </ul></dd>
440 </dl>
441 </td></tr></table>
442 </div>
443 <a name="close"></a>
444 <div>
445 <table class="details" border="1" cellpadding="3"
446 cellspacing="0" width="100%" bgcolor="white">
447 <tr><td>
448 <table width="100%" cellpadding="0" cellspacing="0" border="0">
449 <tr valign="top"><td>
450 <h3 class="epydoc"><span class="sig"><span class="sig-name">close</span>(<span class="sig-arg">self</span>,
451 <span class="sig-arg">title</span>,
452 <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
453 </h3>
454 </td><td align="right" valign="top"
455 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.close">source&nbsp;code</a></span>&nbsp;
456 </td>
457 </tr></table>
458
459 <p>Close the specified window gracefully</p>
460 <p>Usage: <code>window.close(title, matchClass=False)</code></p>
461 <dl class="fields">
462 <dt>Parameters:</dt>
463 <dd><ul class="nomargin-top">
464 <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring
465 match)</li>
466 <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
467 </ul></dd>
468 </dl>
469 </td></tr></table>
470 </div>
471 <a name="resize_move"></a>
472 <div>
473 <table class="details" border="1" cellpadding="3"
474 cellspacing="0" width="100%" bgcolor="white">
475 <tr><td>
476 <table width="100%" cellpadding="0" cellspacing="0" border="0">
477 <tr valign="top"><td>
478 <h3 class="epydoc"><span class="sig"><span class="sig-name">resize_move</span>(<span class="sig-arg">self</span>,
479 <span class="sig-arg">title</span>,
480 <span class="sig-arg">xOrigin</span>=<span class="sig-default">-1</span>,
481 <span class="sig-arg">yOrigin</span>=<span class="sig-default">-1</span>,
482 <span class="sig-arg">width</span>=<span class="sig-default">-1</span>,
483 <span class="sig-arg">height</span>=<span class="sig-default">-1</span>,
484 <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
485 </h3>
486 </td><td align="right" valign="top"
487 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.resize_move">source&nbsp;code</a></span>&nbsp;
488 </td>
489 </tr></table>
490
491 <p>Resize and/or move the specified window</p>
492 <p>Usage: <code>window.close(title, xOrigin=-1, yOrigin=-1, width=-1,
493 height=-1, matchClass=False)</code></p>
494 <p>Leaving and of the position/dimension values as the default (-1) will
495 cause that value to be left unmodified.</p>
496 <dl class="fields">
497 <dt>Parameters:</dt>
498 <dd><ul class="nomargin-top">
499 <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring
500 match)</li>
501 <li><strong class="pname"><code>xOrigin</code></strong> - new x origin of the window (upper left corner)</li>
502 <li><strong class="pname"><code>yOrigin</code></strong> - new y origin of the window (upper left corner)</li>
503 <li><strong class="pname"><code>width</code></strong> - new width of the window</li>
504 <li><strong class="pname"><code>height</code></strong> - new height of the window</li>
505 <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
506 </ul></dd>
507 </dl>
508 </td></tr></table>
509 </div>
510 <a name="move_to_desktop"></a>
511 <div>
512 <table class="details" border="1" cellpadding="3"
513 cellspacing="0" width="100%" bgcolor="white">
514 <tr><td>
515 <table width="100%" cellpadding="0" cellspacing="0" border="0">
516 <tr valign="top"><td>
517 <h3 class="epydoc"><span class="sig"><span class="sig-name">move_to_desktop</span>(<span class="sig-arg">self</span>,
518 <span class="sig-arg">title</span>,
519 <span class="sig-arg">deskNum</span>,
520 <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
521 </h3>
522 </td><td align="right" valign="top"
523 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.move_to_desktop">source&nbsp;code</a></span>&nbsp;
524 </td>
525 </tr></table>
526
527 <p>Move the specified window to the given desktop</p>
528 <p>Usage: <code>window.move_to_desktop(title, deskNum,
529 matchClass=False)</code></p>
530 <dl class="fields">
531 <dt>Parameters:</dt>
532 <dd><ul class="nomargin-top">
533 <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring
534 match)</li>
535 <li><strong class="pname"><code>deskNum</code></strong> - desktop to move the window to (note: zero based)</li>
536 <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
537 </ul></dd>
538 </dl>
539 </td></tr></table>
540 </div>
541 <a name="switch_desktop"></a>
542 <div>
543 <table class="details" border="1" cellpadding="3"
544 cellspacing="0" width="100%" bgcolor="white">
545 <tr><td>
546 <table width="100%" cellpadding="0" cellspacing="0" border="0">
547 <tr valign="top"><td>
548 <h3 class="epydoc"><span class="sig"><span class="sig-name">switch_desktop</span>(<span class="sig-arg">self</span>,
549 <span class="sig-arg">deskNum</span>)</span>
550 </h3>
551 </td><td align="right" valign="top"
552 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.switch_desktop">source&nbsp;code</a></span>&nbsp;
553 </td>
554 </tr></table>
555
556 <p>Switch to the specified desktop</p>
557 <p>Usage: <code>window.switch_desktop(deskNum)</code></p>
558 <dl class="fields">
559 <dt>Parameters:</dt>
560 <dd><ul class="nomargin-top">
561 <li><strong class="pname"><code>deskNum</code></strong> - desktop to switch to (note: zero based)</li>
562 </ul></dd>
563 </dl>
564 </td></tr></table>
565 </div>
566 <a name="set_property"></a>
567 <div>
568 <table class="details" border="1" cellpadding="3"
569 cellspacing="0" width="100%" bgcolor="white">
570 <tr><td>
571 <table width="100%" cellpadding="0" cellspacing="0" border="0">
572 <tr valign="top"><td>
573 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_property</span>(<span class="sig-arg">self</span>,
574 <span class="sig-arg">title</span>,
575 <span class="sig-arg">action</span>,
576 <span class="sig-arg">prop</span>,
577 <span class="sig-arg">matchClass</span>=<span class="sig-default">False</span>)</span>
578 </h3>
579 </td><td align="right" valign="top"
580 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.set_property">source&nbsp;code</a></span>&nbsp;
581 </td>
582 </tr></table>
583
584 <p>Set a property on the given window using the specified action</p>
585 <p>Usage: <code>window.set_property(title, action, prop,
586 matchClass=False)</code></p>
587 <p>Allowable actions: <code>add, remove, toggle</code> Allowable
588 properties: <code>modal, sticky, maximized_vert, maximized_horz, shaded,
589 skip_taskbar, skip_pager, hidden, fullscreen, above</code></p>
590 <dl class="fields">
591 <dt>Parameters:</dt>
592 <dd><ul class="nomargin-top">
593 <li><strong class="pname"><code>title</code></strong> - window title to match against (as case-insensitive substring
594 match)</li>
595 <li><strong class="pname"><code>action</code></strong> - one of the actions listed above</li>
596 <li><strong class="pname"><code>prop</code></strong> - one of the properties listed above</li>
597 <li><strong class="pname"><code>matchClass</code></strong> - if True, match on the window class instead of the title</li>
598 </ul></dd>
599 </dl>
600 </td></tr></table>
601 </div>
602 <a name="get_active_geometry"></a>
603 <div>
604 <table class="details" border="1" cellpadding="3"
605 cellspacing="0" width="100%" bgcolor="white">
606 <tr><td>
607 <table width="100%" cellpadding="0" cellspacing="0" border="0">
608 <tr valign="top"><td>
609 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_active_geometry</span>(<span class="sig-arg">self</span>)</span>
610 </h3>
611 </td><td align="right" valign="top"
612 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_geometry">source&nbsp;code</a></span>&nbsp;
613 </td>
614 </tr></table>
615
616 <p>Get the geometry of the currently active window</p>
617 <p>Usage: <code>window.get_active_geometry()</code></p>
618 <dl class="fields">
619 <dt>Returns: <code>tuple(int, int, int, int)</code></dt>
620 <dd>a 4-tuple containing the x-origin, y-origin, width and height of
621 the window (in pixels)</dd>
622 </dl>
623 </td></tr></table>
624 </div>
625 <a name="get_active_title"></a>
626 <div>
627 <table class="details" border="1" cellpadding="3"
628 cellspacing="0" width="100%" bgcolor="white">
629 <tr><td>
630 <table width="100%" cellpadding="0" cellspacing="0" border="0">
631 <tr valign="top"><td>
632 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_active_title</span>(<span class="sig-arg">self</span>)</span>
633 </h3>
634 </td><td align="right" valign="top"
635 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_title">source&nbsp;code</a></span>&nbsp;
636 </td>
637 </tr></table>
638
639 <p>Get the visible title of the currently active window</p>
640 <p>Usage: <code>window.get_active_title()</code></p>
641 <dl class="fields">
642 <dt>Returns: <code>str</code></dt>
643 <dd>the visible title of the currentle active window</dd>
644 </dl>
645 </td></tr></table>
646 </div>
647 <a name="get_active_class"></a>
648 <div>
649 <table class="details" border="1" cellpadding="3"
650 cellspacing="0" width="100%" bgcolor="white">
651 <tr><td>
652 <table width="100%" cellpadding="0" cellspacing="0" border="0">
653 <tr valign="top"><td>
654 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_active_class</span>(<span class="sig-arg">self</span>)</span>
655 </h3>
656 </td><td align="right" valign="top"
657 ><span class="codelink"><a href="lib.scripting-pysrc.html#Window.get_active_class">source&nbsp;code</a></span>&nbsp;
658 </td>
659 </tr></table>
660
661 <p>Get the class of the currently active window</p>
662 <p>Usage: <code>window.get_active_class()</code></p>
663 <dl class="fields">
664 <dt>Returns: <code>str</code></dt>
665 <dd>the class of the currentle active window</dd>
666 </dl>
667 </td></tr></table>
668 </div>
669 <br />
670 <!-- ==================== NAVIGATION BAR ==================== -->
671 <table class="navbar" border="0" width="100%" cellpadding="0"
672 bgcolor="#a0c0ff" cellspacing="0">
673 <tr valign="middle">
674 <!-- Home link -->
675 <th>&nbsp;&nbsp;&nbsp;<a
676 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
677
678 <!-- Tree link -->
679 <th>&nbsp;&nbsp;&nbsp;<a
680 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
681
682 <!-- Index link -->
683 <th>&nbsp;&nbsp;&nbsp;<a
684 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
685
686 <!-- Help link -->
687 <th>&nbsp;&nbsp;&nbsp;<a
688 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
689
690 <th class="navbar" width="100%"></th>
691 </tr>
692 </table>
693 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
694 <tr>
695 <td align="left" class="footer">
696 Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
697 </td>
698 <td align="right" class="footer">
699 <a target="mainFrame" href="http://epydoc.sourceforge.net"
700 >http://epydoc.sourceforge.net</a>
701 </td>
702 </tr>
703 </table>
704
705 <script type="text/javascript">
706 <!--
707 // Private objects are initially displayed (because if
708 // javascript is turned off then we want them to be
709 // visible); but by default, we want to hide them. So hide
710 // them unless we have a cookie that says to show them.
711 checkCookie();
712 // -->
713 </script>
714 </body>
715 </html>