56 | 56 |
<h1 class="epydoc">Source Code for <a href="lib.scripting-module.html">Module lib.scripting</a></h1>
|
57 | 57 |
<pre class="py-src">
|
58 | 58 |
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># -*- coding: utf-8 -*-</tt> </tt>
|
59 | |
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
|
59 |
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"> </tt>
|
60 | 60 |
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) 2009 Chris Dekter</tt> </tt>
|
61 | |
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
|
61 |
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"> </tt>
|
62 | 62 |
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># This program is free software; you can redistribute it and/or modify</tt> </tt>
|
63 | |
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># it under the terms of the GNU General Public License as published by</tt> </tt>
|
64 | |
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># the Free Software Foundation; either version 2 of the License, or</tt> </tt>
|
65 | |
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># (at your option) any later version.</tt> </tt>
|
66 | |
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
|
67 | |
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># This program is distributed in the hope that it will be useful, but</tt> </tt>
|
68 | |
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
|
69 | |
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</tt> </tt>
|
70 | |
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># General Public License for more details.</tt> </tt>
|
71 | |
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
|
72 | |
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># You should have received a copy of the GNU General Public License</tt> </tt>
|
73 | |
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># along with this program; if not, write to the Free Software</tt> </tt>
|
74 | |
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</tt> </tt>
|
75 | |
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
|
63 |
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"># it under the terms of the GNU General Public License as published by</tt> </tt>
|
|
64 |
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># the Free Software Foundation; either version 2 of the License, or</tt> </tt>
|
|
65 |
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"># (at your option) any later version.</tt> </tt>
|
|
66 |
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
|
|
67 |
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"># This program is distributed in the hope that it will be useful, but</tt> </tt>
|
|
68 |
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
|
|
69 |
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</tt> </tt>
|
|
70 |
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># General Public License for more details.</tt> </tt>
|
|
71 |
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
|
|
72 |
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-comment"># You should have received a copy of the GNU General Public License</tt> </tt>
|
|
73 |
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"># along with this program; if not, write to the Free Software</tt> </tt>
|
|
74 |
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment"># Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</tt> </tt>
|
|
75 |
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"> </tt>
|
76 | 76 |
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">subprocess</tt><tt class="py-op">,</tt> <tt class="py-name">threading</tt><tt class="py-op">,</tt> <tt class="py-name">time</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt> </tt>
|
77 | |
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">gtk</tt> </tt>
|
78 | |
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> </tt>
|
79 | |
<a name="Keyboard"></a><div id="Keyboard-def"><a name="L22"></a><tt class="py-lineno"> 22</tt> <a class="py-toggle" href="#" id="Keyboard-toggle" onclick="return toggle('Keyboard');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html">Keyboard</a><tt class="py-op">:</tt> </tt>
|
80 | |
</div><div id="Keyboard-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Keyboard-expanded"><a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
81 | |
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to the keyboard for event generation.</tt> </tt>
|
82 | |
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
83 | |
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
|
84 | |
<a name="Keyboard.__init__"></a><div id="Keyboard.__init__-def"><a name="L27"></a><tt class="py-lineno"> 27</tt> <a class="py-toggle" href="#" id="Keyboard.__init__-toggle" onclick="return toggle('Keyboard.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mediator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
85 | |
</div><div id="Keyboard.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Keyboard.__init__-expanded"><a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt> <tt class="py-op">=</tt> <tt class="py-name">mediator</tt> </tt>
|
86 | |
</div><a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> </tt>
|
87 | |
<a name="Keyboard.send_keys"></a><div id="Keyboard.send_keys-def"><a name="L30"></a><tt class="py-lineno"> 30</tt> <a class="py-toggle" href="#" id="Keyboard.send_keys-toggle" onclick="return toggle('Keyboard.send_keys');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#send_keys">send_keys</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">keyString</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
88 | |
</div><div id="Keyboard.send_keys-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Keyboard.send_keys-expanded"><a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
89 | |
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"> Send a sequence of keys via keyboard events</tt> </tt>
|
90 | |
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
91 | |
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.send_keys(keyString)}</tt> </tt>
|
92 | |
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
93 | |
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> @param keyString: string of keys (including special keys) to send</tt> </tt>
|
94 | |
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
95 | |
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">send_string</tt><tt class="py-op">(</tt><tt class="py-name">keyString</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
96 | |
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">flush</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
97 | |
</div><a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> </tt>
|
98 | |
<a name="Keyboard.send_key"></a><div id="Keyboard.send_key-def"><a name="L41"></a><tt class="py-lineno"> 41</tt> <a class="py-toggle" href="#" id="Keyboard.send_key-toggle" onclick="return toggle('Keyboard.send_key');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#send_key">send_key</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">repeat</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
99 | |
</div><div id="Keyboard.send_key-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Keyboard.send_key-expanded"><a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
100 | |
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> Send a keyboard event</tt> </tt>
|
101 | |
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
102 | |
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.send_key(key, repeat=1)}</tt> </tt>
|
103 | |
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
104 | |
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> @param key: they key to be sent (e.g. "s" or "<enter>")</tt> </tt>
|
105 | |
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> @param repeat: number of times to repeat the key event</tt> </tt>
|
106 | |
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
107 | |
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">repeat</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
108 | |
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method lib.scripting.Keyboard.send_key()=lib.scripting.Keyboard-class.html#send_key"><a title="lib.scripting.Keyboard.send_key" class="py-name" href="#" onclick="return doclink('link-0', 'send_key', 'link-0');">send_key</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
109 | |
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">flush</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
110 | |
</div></div><a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> </tt>
|
111 | |
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> </tt>
|
112 | |
<a name="Mouse"></a><div id="Mouse-def"><a name="L55"></a><tt class="py-lineno"> 55</tt> <a class="py-toggle" href="#" id="Mouse-toggle" onclick="return toggle('Mouse');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html">Mouse</a><tt class="py-op">:</tt> </tt>
|
113 | |
</div><div id="Mouse-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Mouse-expanded"><a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
114 | |
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to send mouse clicks</tt> </tt>
|
115 | |
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
116 | |
<a name="Mouse.__init__"></a><div id="Mouse.__init__-def"><a name="L59"></a><tt class="py-lineno"> 59</tt> <a class="py-toggle" href="#" id="Mouse.__init__-toggle" onclick="return toggle('Mouse.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mediator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
117 | |
</div><div id="Mouse.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Mouse.__init__-expanded"><a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt> <tt class="py-op">=</tt> <tt class="py-name">mediator</tt> </tt>
|
118 | |
</div><a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt>
|
119 | |
<a name="Mouse.click_relative"></a><div id="Mouse.click_relative-def"><a name="L62"></a><tt class="py-lineno"> 62</tt> <a class="py-toggle" href="#" id="Mouse.click_relative-toggle" onclick="return toggle('Mouse.click_relative');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#click_relative">click_relative</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">x</tt><tt class="py-op">,</tt> <tt class="py-param">y</tt><tt class="py-op">,</tt> <tt class="py-param">button</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
120 | |
</div><div id="Mouse.click_relative-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Mouse.click_relative-expanded"><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
121 | |
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> Send a mouse click relative to the active window</tt> </tt>
|
122 | |
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
123 | |
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.click_relative(x, y, button)}</tt> </tt>
|
124 | |
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
125 | |
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> @param x: x-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
126 | |
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> @param y: y-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
127 | |
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> @param button: mouse button to simulate (left=1, middle=2, right=3)</tt> </tt>
|
128 | |
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
129 | |
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">send_mouse_click</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">,</tt> <tt class="py-name">button</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
|
130 | |
</div><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> </tt>
|
131 | |
<a name="Mouse.click_absolute"></a><div id="Mouse.click_absolute-def"><a name="L74"></a><tt class="py-lineno"> 74</tt> <a class="py-toggle" href="#" id="Mouse.click_absolute-toggle" onclick="return toggle('Mouse.click_absolute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#click_absolute">click_absolute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">x</tt><tt class="py-op">,</tt> <tt class="py-param">y</tt><tt class="py-op">,</tt> <tt class="py-param">button</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
132 | |
</div><div id="Mouse.click_absolute-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Mouse.click_absolute-expanded"><a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
133 | |
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> Send a mouse click relative to the screen (absolute)</tt> </tt>
|
134 | |
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
135 | |
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.click_absolute(x, y, button)}</tt> </tt>
|
136 | |
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
137 | |
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> @param x: x-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
138 | |
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> @param y: y-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
139 | |
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> @param button: mouse button to simulate (left=1, middle=2, right=3)</tt> </tt>
|
140 | |
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
141 | |
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">send_mouse_click</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">,</tt> <tt class="py-name">button</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
|
142 | |
</div></div><a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt>
|
143 | |
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> </tt>
|
144 | |
<a name="Store"></a><div id="Store-def"><a name="L87"></a><tt class="py-lineno"> 87</tt> <a class="py-toggle" href="#" id="Store-toggle" onclick="return toggle('Store');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Store-class.html">Store</a><tt class="py-op">(</tt><tt class="py-base-class">dict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
145 | |
</div><div id="Store-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Store-expanded"><a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
146 | |
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> Allows persistent storage of values between invocations of the script.</tt> </tt>
|
147 | |
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
148 | |
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> </tt>
|
149 | |
<a name="Store.set_value"></a><div id="Store.set_value-def"><a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="Store.set_value-toggle" onclick="return toggle('Store.set_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#set_value">set_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
150 | |
</div><div id="Store.set_value-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Store.set_value-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
151 | |
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> Store a value</tt> </tt>
|
152 | |
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
153 | |
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.set_value(key, value)}</tt> </tt>
|
154 | |
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
155 | |
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
|
156 | |
</div><a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> </tt>
|
157 | |
<a name="Store.get_value"></a><div id="Store.get_value-def"><a name="L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="Store.get_value-toggle" onclick="return toggle('Store.get_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#get_value">get_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
158 | |
</div><div id="Store.get_value-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Store.get_value-expanded"><a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
159 | |
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> Get a value</tt> </tt>
|
160 | |
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
161 | |
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.get_value(key)}</tt> </tt>
|
162 | |
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
163 | |
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
|
164 | |
</div><a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> </tt>
|
165 | |
<a name="Store.remove_value"></a><div id="Store.remove_value-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="Store.remove_value-toggle" onclick="return toggle('Store.remove_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#remove_value">remove_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
166 | |
</div><div id="Store.remove_value-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Store.remove_value-expanded"><a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
167 | |
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> Remove a value</tt> </tt>
|
168 | |
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
169 | |
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.remove_value(key)}</tt> </tt>
|
170 | |
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
171 | |
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
|
172 | |
</div></div><a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> </tt>
|
173 | |
<a name="Dialog"></a><div id="Dialog-def"><a name="L116"></a><tt class="py-lineno">116</tt> <a class="py-toggle" href="#" id="Dialog-toggle" onclick="return toggle('Dialog');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html">Dialog</a><tt class="py-op">:</tt> </tt>
|
174 | |
</div><div id="Dialog-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Dialog-expanded"><a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
175 | |
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> Provides a simple interface for the display of some basic dialogs to collect information from the user.</tt> </tt>
|
176 | |
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
177 | |
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> </tt>
|
178 | |
<a name="Dialog.__runZenity"></a><div id="Dialog.__runZenity-def"><a name="L121"></a><tt class="py-lineno">121</tt> <a class="py-toggle" href="#" id="Dialog.__runZenity-toggle" onclick="return toggle('Dialog.__runZenity');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#__runZenity">__runZenity</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
179 | |
</div><div id="Dialog.__runZenity-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.__runZenity-expanded"><a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"zenity"</tt><tt class="py-op">,</tt> <tt class="py-string">"--title"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt> </tt>
|
180 | |
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-name">retCode</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
181 | |
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-comment"># Drop trailing newline</tt> </tt>
|
182 | |
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> </tt>
|
183 | |
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
|
184 | |
</div><a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> </tt>
|
185 | |
<a name="Dialog.input_dialog"></a><div id="Dialog.input_dialog-def"><a name="L128"></a><tt class="py-lineno">128</tt> <a class="py-toggle" href="#" id="Dialog.input_dialog-toggle" onclick="return toggle('Dialog.input_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#input_dialog">input_dialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Enter a value"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Enter a value"</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
186 | |
</div><div id="Dialog.input_dialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.input_dialog-expanded"><a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
187 | |
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> Show an input dialog</tt> </tt>
|
188 | |
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
189 | |
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.input_dialog(title="Enter a value", message="Enter a value", default="")}</tt> </tt>
|
190 | |
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
191 | |
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
192 | |
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the input box</tt> </tt>
|
193 | |
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value for the input box</tt> </tt>
|
194 | |
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
195 | |
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method lib.scripting.Dialog.__runZenity()=lib.scripting.Dialog-class.html#__runZenity"><a title="lib.scripting.Dialog.__runZenity" class="py-name" href="#" onclick="return doclink('link-1', '__runZenity', 'link-1');">__runZenity</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--entry"</tt><tt class="py-op">,</tt> <tt class="py-string">"--text"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-string">"--entry-text"</tt><tt class="py-op">,</tt> <tt class="py-name">default</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
196 | |
</div><a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> </tt>
|
197 | |
<a name="Dialog.password_dialog"></a><div id="Dialog.password_dialog-def"><a name="L140"></a><tt class="py-lineno">140</tt> <a class="py-toggle" href="#" id="Dialog.password_dialog-toggle" onclick="return toggle('Dialog.password_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#password_dialog">password_dialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Enter password"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Enter password"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
198 | |
</div><div id="Dialog.password_dialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.password_dialog-expanded"><a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
199 | |
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"><tt class="py-docstring"> Show a password input dialog</tt> </tt>
|
200 | |
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
201 | |
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.password_dialog(title="Enter password", message="Enter password")}</tt> </tt>
|
202 | |
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
203 | |
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
204 | |
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the password input box</tt> </tt>
|
205 | |
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
206 | |
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name"><a title="lib.scripting.Dialog.__runZenity" class="py-name" href="#" onclick="return doclink('link-2', '__runZenity', 'link-1');">__runZenity</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--entry"</tt><tt class="py-op">,</tt> <tt class="py-string">"--text"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-string">"--hide-text"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
207 | |
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> </tt>
|
208 | |
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> <tt class="py-comment">#def combo_menu(self, options, title="Choose an option", message="Choose an option"):</tt> </tt>
|
209 | |
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-string">"""</tt> </tt>
|
210 | |
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-string"> Show a combobox menu - not supported by zenity</tt> </tt>
|
211 | |
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
|
212 | |
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"><tt class="py-string"> Usage: C{dialog.combo_menu(options, title="Choose an option", message="Choose an option")}</tt> </tt>
|
213 | |
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
|
214 | |
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-string"> @param options: list of options (strings) for the dialog</tt> </tt>
|
215 | |
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-string"> @param title: window title for the dialog</tt> </tt>
|
216 | |
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-string"> @param message: message displayed above the combobox </tt> </tt>
|
217 | |
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
|
218 | |
</div><a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-comment">#return self.__runZenity(title, ["--combobox", message] + options)</tt> </tt>
|
219 | |
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
220 | |
<a name="Dialog.list_menu"></a><div id="Dialog.list_menu-def"><a name="L163"></a><tt class="py-lineno">163</tt> <a class="py-toggle" href="#" id="Dialog.list_menu-toggle" onclick="return toggle('Dialog.list_menu');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#list_menu">list_menu</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Choose a value"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Choose a value"</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
221 | |
</div><div id="Dialog.list_menu-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.list_menu-expanded"><a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
222 | |
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"><tt class="py-docstring"> Show a single-selection list menu</tt> </tt>
|
223 | |
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
224 | |
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.list_menu(options, title="Choose a value", message="Choose a value", default=None)}</tt> </tt>
|
225 | |
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
226 | |
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
|
227 | |
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
228 | |
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
|
229 | |
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value to be selected</tt> </tt>
|
230 | |
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
231 | |
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"> </tt>
|
232 | |
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> <tt class="py-name">choices</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
233 | |
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-comment">#optionNum = 0</tt> </tt>
|
234 | |
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt class="py-name">options</tt><tt class="py-op">:</tt> </tt>
|
235 | |
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">option</tt> <tt class="py-op">==</tt> <tt class="py-name">default</tt><tt class="py-op">:</tt> </tt>
|
236 | |
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"TRUE"</tt><tt class="py-op">)</tt> </tt>
|
237 | |
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
238 | |
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"FALSE"</tt><tt class="py-op">)</tt> </tt>
|
239 | |
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> </tt>
|
240 | |
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt class="py-comment">#choices.append(str(optionNum))</tt> </tt>
|
241 | |
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">option</tt><tt class="py-op">)</tt> </tt>
|
242 | |
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-comment">#optionNum += 1</tt> </tt>
|
243 | |
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
244 | |
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name"><a title="lib.scripting.Dialog.__runZenity" class="py-name" href="#" onclick="return doclink('link-3', '__runZenity', 'link-1');">__runZenity</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--list"</tt><tt class="py-op">,</tt> <tt class="py-string">"--radiolist"</tt><tt class="py-op">,</tt> <tt class="py-string">"--text"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-string">"--column"</tt><tt class="py-op">,</tt> <tt class="py-string">" "</tt><tt class="py-op">,</tt> <tt class="py-string">"--column"</tt><tt class="py-op">,</tt> <tt class="py-string">"Options"</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">choices</tt><tt class="py-op">)</tt> </tt>
|
245 | |
</div><a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> </tt>
|
246 | |
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-comment">#return retCode, choice </tt> </tt>
|
247 | |
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
248 | |
<a name="Dialog.list_menu_multi"></a><div id="Dialog.list_menu_multi-def"><a name="L191"></a><tt class="py-lineno">191</tt> <a class="py-toggle" href="#" id="Dialog.list_menu_multi-toggle" onclick="return toggle('Dialog.list_menu_multi');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#list_menu_multi">list_menu_multi</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Choose one or more values"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Choose one or more values"</tt><tt class="py-op">,</tt> <tt class="py-param">defaults</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
249 | |
</div><div id="Dialog.list_menu_multi-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.list_menu_multi-expanded"><a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
250 | |
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-docstring"> Show a multiple-selection list menu</tt> </tt>
|
251 | |
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
252 | |
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.list_menu_multi(options, title="Choose one or more values", message="Choose one or more values", defaults=[])}</tt> </tt>
|
253 | |
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
254 | |
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
|
255 | |
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
256 | |
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
|
257 | |
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-docstring"> @param defaults: list of default values to be selected</tt> </tt>
|
258 | |
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
259 | |
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> </tt>
|
260 | |
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-name">choices</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
261 | |
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> <tt class="py-comment">#optionNum = 0</tt> </tt>
|
262 | |
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt class="py-name">options</tt><tt class="py-op">:</tt> </tt>
|
263 | |
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt class="py-name">defaults</tt><tt class="py-op">:</tt> </tt>
|
264 | |
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"TRUE"</tt><tt class="py-op">)</tt> </tt>
|
265 | |
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
266 | |
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"FALSE"</tt><tt class="py-op">)</tt> </tt>
|
267 | |
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> </tt>
|
268 | |
<a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> <tt class="py-comment">#choices.append(str(optionNum))</tt> </tt>
|
269 | |
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">option</tt><tt class="py-op">)</tt> </tt>
|
270 | |
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-comment">#optionNum += 1</tt> </tt>
|
271 | |
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
272 | |
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="lib.scripting.Dialog.__runZenity" class="py-name" href="#" onclick="return doclink('link-4', '__runZenity', 'link-1');">__runZenity</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--list"</tt><tt class="py-op">,</tt> <tt class="py-string">"--checklist"</tt><tt class="py-op">,</tt> <tt class="py-string">"--text"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-string">"--column"</tt><tt class="py-op">,</tt> <tt class="py-string">" "</tt><tt class="py-op">,</tt> <tt class="py-string">"--column"</tt><tt class="py-op">,</tt> <tt class="py-string">"Options"</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">choices</tt><tt class="py-op">)</tt> </tt>
|
|
77 |
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-comment">#from PyQt4.QtGui import QClipboard, QApplication</tt> </tt>
|
|
78 |
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-comment">#import model</tt> </tt>
|
|
79 |
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"> </tt>
|
|
80 |
<a name="Keyboard"></a><div id="Keyboard-def"><a name="L23"></a><tt class="py-lineno"> 23</tt> <a class="py-toggle" href="#" id="Keyboard-toggle" onclick="return toggle('Keyboard');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html">Keyboard</a><tt class="py-op">:</tt> </tt>
|
|
81 |
</div><div id="Keyboard-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Keyboard-expanded"><a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
82 |
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to the keyboard for event generation.</tt> </tt>
|
|
83 |
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
84 |
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"> </tt>
|
|
85 |
<a name="Keyboard.__init__"></a><div id="Keyboard.__init__-def"><a name="L28"></a><tt class="py-lineno"> 28</tt> <a class="py-toggle" href="#" id="Keyboard.__init__-toggle" onclick="return toggle('Keyboard.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mediator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
86 |
</div><div id="Keyboard.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Keyboard.__init__-expanded"><a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt> <tt class="py-op">=</tt> <tt class="py-name">mediator</tt> </tt>
|
|
87 |
</div><a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> </tt>
|
|
88 |
<a name="Keyboard.send_keys"></a><div id="Keyboard.send_keys-def"><a name="L31"></a><tt class="py-lineno"> 31</tt> <a class="py-toggle" href="#" id="Keyboard.send_keys-toggle" onclick="return toggle('Keyboard.send_keys');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#send_keys">send_keys</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">keyString</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
89 |
</div><div id="Keyboard.send_keys-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Keyboard.send_keys-expanded"><a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
90 |
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> Send a sequence of keys via keyboard events</tt> </tt>
|
|
91 |
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
92 |
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.send_keys(keyString)}</tt> </tt>
|
|
93 |
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
94 |
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring"> @param keyString: string of keys (including special keys) to send</tt> </tt>
|
|
95 |
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
96 |
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">send_string</tt><tt class="py-op">(</tt><tt class="py-name">keyString</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
97 |
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">flush</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
98 |
</div><a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> </tt>
|
|
99 |
<a name="Keyboard.send_key"></a><div id="Keyboard.send_key-def"><a name="L42"></a><tt class="py-lineno"> 42</tt> <a class="py-toggle" href="#" id="Keyboard.send_key-toggle" onclick="return toggle('Keyboard.send_key');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#send_key">send_key</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">repeat</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
100 |
</div><div id="Keyboard.send_key-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Keyboard.send_key-expanded"><a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
101 |
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> Send a keyboard event</tt> </tt>
|
|
102 |
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
103 |
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.send_key(key, repeat=1)}</tt> </tt>
|
|
104 |
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
105 |
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> @param key: they key to be sent (e.g. "s" or "<enter>")</tt> </tt>
|
|
106 |
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> @param repeat: number of times to repeat the key event</tt> </tt>
|
|
107 |
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
108 |
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">repeat</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
109 |
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method lib.scripting.Keyboard.send_key()=lib.scripting.Keyboard-class.html#send_key"><a title="lib.scripting.Keyboard.send_key" class="py-name" href="#" onclick="return doclink('link-0', 'send_key', 'link-0');">send_key</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
110 |
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">flush</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
111 |
</div></div><a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> </tt>
|
|
112 |
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> </tt>
|
|
113 |
<a name="Mouse"></a><div id="Mouse-def"><a name="L56"></a><tt class="py-lineno"> 56</tt> <a class="py-toggle" href="#" id="Mouse-toggle" onclick="return toggle('Mouse');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html">Mouse</a><tt class="py-op">:</tt> </tt>
|
|
114 |
</div><div id="Mouse-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Mouse-expanded"><a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
115 |
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to send mouse clicks</tt> </tt>
|
|
116 |
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
117 |
<a name="Mouse.__init__"></a><div id="Mouse.__init__-def"><a name="L60"></a><tt class="py-lineno"> 60</tt> <a class="py-toggle" href="#" id="Mouse.__init__-toggle" onclick="return toggle('Mouse.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mediator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
118 |
</div><div id="Mouse.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Mouse.__init__-expanded"><a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt> <tt class="py-op">=</tt> <tt class="py-name">mediator</tt> </tt>
|
|
119 |
</div><a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> </tt>
|
|
120 |
<a name="Mouse.click_relative"></a><div id="Mouse.click_relative-def"><a name="L63"></a><tt class="py-lineno"> 63</tt> <a class="py-toggle" href="#" id="Mouse.click_relative-toggle" onclick="return toggle('Mouse.click_relative');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#click_relative">click_relative</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">x</tt><tt class="py-op">,</tt> <tt class="py-param">y</tt><tt class="py-op">,</tt> <tt class="py-param">button</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
121 |
</div><div id="Mouse.click_relative-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Mouse.click_relative-expanded"><a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
122 |
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> Send a mouse click relative to the active window</tt> </tt>
|
|
123 |
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
124 |
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.click_relative(x, y, button)}</tt> </tt>
|
|
125 |
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
126 |
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> @param x: x-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
|
127 |
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> @param y: y-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
|
128 |
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> @param button: mouse button to simulate (left=1, middle=2, right=3)</tt> </tt>
|
|
129 |
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
130 |
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">send_mouse_click</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">,</tt> <tt class="py-name">button</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
|
|
131 |
</div><a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> </tt>
|
|
132 |
<a name="Mouse.click_absolute"></a><div id="Mouse.click_absolute-def"><a name="L75"></a><tt class="py-lineno"> 75</tt> <a class="py-toggle" href="#" id="Mouse.click_absolute-toggle" onclick="return toggle('Mouse.click_absolute');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#click_absolute">click_absolute</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">x</tt><tt class="py-op">,</tt> <tt class="py-param">y</tt><tt class="py-op">,</tt> <tt class="py-param">button</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
133 |
</div><div id="Mouse.click_absolute-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Mouse.click_absolute-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
134 |
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> Send a mouse click relative to the screen (absolute)</tt> </tt>
|
|
135 |
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
136 |
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.click_absolute(x, y, button)}</tt> </tt>
|
|
137 |
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
138 |
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> @param x: x-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
|
139 |
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> @param y: y-coordinate in pixels, relative to upper left corner of window</tt> </tt>
|
|
140 |
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> @param button: mouse button to simulate (left=1, middle=2, right=3)</tt> </tt>
|
|
141 |
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
142 |
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">send_mouse_click</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">,</tt> <tt class="py-name">button</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
|
|
143 |
</div></div><a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> </tt>
|
|
144 |
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> </tt>
|
|
145 |
<a name="Store"></a><div id="Store-def"><a name="L88"></a><tt class="py-lineno"> 88</tt> <a class="py-toggle" href="#" id="Store-toggle" onclick="return toggle('Store');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Store-class.html">Store</a><tt class="py-op">(</tt><tt class="py-base-class">dict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
146 |
</div><div id="Store-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Store-expanded"><a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
147 |
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> Allows persistent storage of values between invocations of the script.</tt> </tt>
|
|
148 |
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
149 |
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> </tt>
|
|
150 |
<a name="Store.set_value"></a><div id="Store.set_value-def"><a name="L93"></a><tt class="py-lineno"> 93</tt> <a class="py-toggle" href="#" id="Store.set_value-toggle" onclick="return toggle('Store.set_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#set_value">set_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
151 |
</div><div id="Store.set_value-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Store.set_value-expanded"><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
152 |
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> Store a value</tt> </tt>
|
|
153 |
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
154 |
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.set_value(key, value)}</tt> </tt>
|
|
155 |
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
156 |
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
|
|
157 |
</div><a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> </tt>
|
|
158 |
<a name="Store.get_value"></a><div id="Store.get_value-def"><a name="L101"></a><tt class="py-lineno">101</tt> <a class="py-toggle" href="#" id="Store.get_value-toggle" onclick="return toggle('Store.get_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#get_value">get_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
159 |
</div><div id="Store.get_value-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Store.get_value-expanded"><a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
160 |
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> Get a value</tt> </tt>
|
|
161 |
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
162 |
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.get_value(key)}</tt> </tt>
|
|
163 |
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
164 |
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
|
|
165 |
</div><a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> </tt>
|
|
166 |
<a name="Store.remove_value"></a><div id="Store.remove_value-def"><a name="L109"></a><tt class="py-lineno">109</tt> <a class="py-toggle" href="#" id="Store.remove_value-toggle" onclick="return toggle('Store.remove_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#remove_value">remove_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
167 |
</div><div id="Store.remove_value-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Store.remove_value-expanded"><a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
168 |
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> Remove a value</tt> </tt>
|
|
169 |
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
170 |
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.remove_value(key)}</tt> </tt>
|
|
171 |
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
172 |
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
|
|
173 |
</div></div><a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> </tt>
|
|
174 |
<a name="Dialog"></a><div id="Dialog-def"><a name="L117"></a><tt class="py-lineno">117</tt> <a class="py-toggle" href="#" id="Dialog-toggle" onclick="return toggle('Dialog');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html">Dialog</a><tt class="py-op">:</tt> </tt>
|
|
175 |
</div><div id="Dialog-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Dialog-expanded"><a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
176 |
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> Provides a simple interface for the display of some basic dialogs to collect information from the user.</tt> </tt>
|
|
177 |
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
178 |
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> </tt>
|
|
179 |
<a name="Dialog.__runKdialog"></a><div id="Dialog.__runKdialog-def"><a name="L122"></a><tt class="py-lineno">122</tt> <a class="py-toggle" href="#" id="Dialog.__runKdialog-toggle" onclick="return toggle('Dialog.__runKdialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#__runKdialog">__runKdialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
180 |
</div><div id="Dialog.__runKdialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.__runKdialog-expanded"><a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"kdialog"</tt><tt class="py-op">,</tt> <tt class="py-string">"--title"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt> </tt>
|
|
181 |
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-name">retCode</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
182 |
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-comment"># Drop trailing newline</tt> </tt>
|
|
183 |
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> </tt>
|
|
184 |
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
|
|
185 |
</div><a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> </tt>
|
|
186 |
<a name="Dialog.input_dialog"></a><div id="Dialog.input_dialog-def"><a name="L129"></a><tt class="py-lineno">129</tt> <a class="py-toggle" href="#" id="Dialog.input_dialog-toggle" onclick="return toggle('Dialog.input_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#input_dialog">input_dialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Enter a value"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Enter a value"</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
187 |
</div><div id="Dialog.input_dialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.input_dialog-expanded"><a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
188 |
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> Show an input dialog</tt> </tt>
|
|
189 |
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
190 |
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.input_dialog(title="Enter a value", message="Enter a value", default="")}</tt> </tt>
|
|
191 |
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
192 |
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
193 |
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the input box</tt> </tt>
|
|
194 |
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value for the input box</tt> </tt>
|
|
195 |
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
196 |
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method lib.scripting.Dialog.__runKdialog()=lib.scripting.Dialog-class.html#__runKdialog"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-1', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--inputbox"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">,</tt> <tt class="py-name">default</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
197 |
</div><a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt>
|
|
198 |
<a name="Dialog.password_dialog"></a><div id="Dialog.password_dialog-def"><a name="L141"></a><tt class="py-lineno">141</tt> <a class="py-toggle" href="#" id="Dialog.password_dialog-toggle" onclick="return toggle('Dialog.password_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#password_dialog">password_dialog</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Enter password"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Enter password"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
199 |
</div><div id="Dialog.password_dialog-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.password_dialog-expanded"><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
200 |
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"> Show a password input dialog</tt> </tt>
|
|
201 |
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
202 |
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.password_dialog(title="Enter password", message="Enter password")}</tt> </tt>
|
|
203 |
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
204 |
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
205 |
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the password input box</tt> </tt>
|
|
206 |
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
207 |
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-2', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--password"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
208 |
</div><a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> </tt>
|
|
209 |
<a name="Dialog.combo_menu"></a><div id="Dialog.combo_menu-def"><a name="L152"></a><tt class="py-lineno">152</tt> <a class="py-toggle" href="#" id="Dialog.combo_menu-toggle" onclick="return toggle('Dialog.combo_menu');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#combo_menu">combo_menu</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Choose an option"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Choose an option"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
210 |
</div><div id="Dialog.combo_menu-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.combo_menu-expanded"><a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
211 |
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-docstring"> Show a combobox menu</tt> </tt>
|
|
212 |
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
213 |
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.combo_menu(options, title="Choose an option", message="Choose an option")}</tt> </tt>
|
|
214 |
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
215 |
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
|
|
216 |
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
217 |
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the combobox </tt> </tt>
|
|
218 |
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
219 |
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-3', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--combobox"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
|
|
220 |
</div><a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> </tt>
|
|
221 |
<a name="Dialog.list_menu"></a><div id="Dialog.list_menu-def"><a name="L164"></a><tt class="py-lineno">164</tt> <a class="py-toggle" href="#" id="Dialog.list_menu-toggle" onclick="return toggle('Dialog.list_menu');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#list_menu">list_menu</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Choose a value"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Choose a value"</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
222 |
</div><div id="Dialog.list_menu-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.list_menu-expanded"><a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
223 |
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> Show a single-selection list menu</tt> </tt>
|
|
224 |
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
225 |
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.list_menu(options, title="Choose a value", message="Choose a value", default=None)}</tt> </tt>
|
|
226 |
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
227 |
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
|
|
228 |
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
229 |
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
|
|
230 |
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value to be selected</tt> </tt>
|
|
231 |
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
232 |
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> </tt>
|
|
233 |
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-name">choices</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
|
234 |
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
|
|
235 |
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt class="py-name">options</tt><tt class="py-op">:</tt> </tt>
|
|
236 |
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">optionNum</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
237 |
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">option</tt><tt class="py-op">)</tt> </tt>
|
|
238 |
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">option</tt> <tt class="py-op">==</tt> <tt class="py-name">default</tt><tt class="py-op">:</tt> </tt>
|
|
239 |
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"on"</tt><tt class="py-op">)</tt> </tt>
|
|
240 |
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
241 |
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"off"</tt><tt class="py-op">)</tt> </tt>
|
|
242 |
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
|
|
243 |
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> </tt>
|
|
244 |
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-4', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--radiolist"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">choices</tt><tt class="py-op">)</tt> </tt>
|
|
245 |
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-name">choice</tt> <tt class="py-op">=</tt> <tt class="py-name">options</tt><tt class="py-op">[</tt><tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
|
|
246 |
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> </tt>
|
|
247 |
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">choice</tt> </tt>
|
|
248 |
</div><a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> </tt>
|
|
249 |
<a name="Dialog.list_menu_multi"></a><div id="Dialog.list_menu_multi-def"><a name="L192"></a><tt class="py-lineno">192</tt> <a class="py-toggle" href="#" id="Dialog.list_menu_multi-toggle" onclick="return toggle('Dialog.list_menu_multi');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#list_menu_multi">list_menu_multi</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Choose one or more values"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">"Choose one or more values"</tt><tt class="py-op">,</tt> <tt class="py-param">defaults</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
250 |
</div><div id="Dialog.list_menu_multi-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.list_menu_multi-expanded"><a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
251 |
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-docstring"> Show a multiple-selection list menu</tt> </tt>
|
|
252 |
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
253 |
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.list_menu_multi(options, title="Choose one or more values", message="Choose one or more values", defaults=[])}</tt> </tt>
|
|
254 |
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
255 |
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
|
|
256 |
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
257 |
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
|
|
258 |
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-docstring"> @param defaults: list of default values to be selected</tt> </tt>
|
|
259 |
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
260 |
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> </tt>
|
|
261 |
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> <tt class="py-name">choices</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
|
262 |
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
|
|
263 |
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt class="py-name">options</tt><tt class="py-op">:</tt> </tt>
|
|
264 |
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">optionNum</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
|
265 |
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">option</tt><tt class="py-op">)</tt> </tt>
|
|
266 |
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt class="py-name">defaults</tt><tt class="py-op">:</tt> </tt>
|
|
267 |
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"on"</tt><tt class="py-op">)</tt> </tt>
|
|
268 |
<a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
269 |
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"off"</tt><tt class="py-op">)</tt> </tt>
|
|
270 |
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
|
|
271 |
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> </tt>
|
|
272 |
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-5', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--separate-output"</tt><tt class="py-op">,</tt> <tt class="py-string">"--checklist"</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">choices</tt><tt class="py-op">)</tt> </tt>
|
273 | 273 |
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-name">results</tt> <tt class="py-op">=</tt> <tt class="py-name">output</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
274 | 274 |
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> </tt>
|
275 | 275 |
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-name">choices</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
|
276 | |
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">choice</tt> <tt class="py-keyword">in</tt> <tt class="py-name">results</tt><tt class="py-op">:</tt> </tt>
|
277 | |
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">choice</tt><tt class="py-op">)</tt> </tt>
|
|
276 |
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">index</tt> <tt class="py-keyword">in</tt> <tt class="py-name">results</tt><tt class="py-op">:</tt> </tt>
|
|
277 |
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">options</tt><tt class="py-op">[</tt><tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">index</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
278 | 278 |
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> </tt>
|
279 | 279 |
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">choices</tt> </tt>
|
280 | 280 |
</div><a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> </tt>
|
281 | |
<a name="Dialog.open_file"></a><div id="Dialog.open_file-def"><a name="L224"></a><tt class="py-lineno">224</tt> <a class="py-toggle" href="#" id="Dialog.open_file-toggle" onclick="return toggle('Dialog.open_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#open_file">open_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Open File"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
281 |
<a name="Dialog.open_file"></a><div id="Dialog.open_file-def"><a name="L224"></a><tt class="py-lineno">224</tt> <a class="py-toggle" href="#" id="Dialog.open_file-toggle" onclick="return toggle('Dialog.open_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#open_file">open_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Open File"</tt><tt class="py-op">,</tt> <tt class="py-param">initialDir</tt><tt class="py-op">=</tt><tt class="py-string">"~"</tt><tt class="py-op">,</tt> <tt class="py-param">fileTypes</tt><tt class="py-op">=</tt><tt class="py-string">"*|All Files"</tt><tt class="py-op">,</tt> <tt class="py-param">rememberAs</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
282 | 282 |
</div><div id="Dialog.open_file-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.open_file-expanded"><a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
283 | 283 |
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"><tt class="py-docstring"> Show an Open File dialog</tt> </tt>
|
284 | 284 |
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
285 | |
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.open_file(title="Open File")}</tt> </tt>
|
|
285 |
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.open_file(title="Open File", initialDir="~", fileTypes="*|All Files", rememberAs=None)}</tt> </tt>
|
286 | 286 |
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
287 | 287 |
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
288 | 288 |
<a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"><tt class="py-docstring"> @param initialDir: starting directory for the file dialog</tt> </tt>
|
289 | |
<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
290 | |
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"> <tt class="py-comment">#if rememberAs is not None:</tt> </tt>
|
291 | |
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># return self.__runZenity(title, ["--getopenfilename", initialDir, fileTypes, ":" + rememberAs])</tt> </tt>
|
292 | |
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#else:</tt> </tt>
|
293 | |
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="lib.scripting.Dialog.__runZenity" class="py-name" href="#" onclick="return doclink('link-5', '__runZenity', 'link-1');">__runZenity</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--file-selection"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
294 | |
</div><a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> </tt>
|
295 | |
<a name="Dialog.save_file"></a><div id="Dialog.save_file-def"><a name="L238"></a><tt class="py-lineno">238</tt> <a class="py-toggle" href="#" id="Dialog.save_file-toggle" onclick="return toggle('Dialog.save_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#save_file">save_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Save As"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
296 | |
</div><div id="Dialog.save_file-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.save_file-expanded"><a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
297 | |
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"> Show a Save As dialog</tt> </tt>
|
298 | |
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
299 | |
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.save_file(title="Save As")}</tt> </tt>
|
|
289 |
<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"><tt class="py-docstring"> @param fileTypes: file type filter expression</tt> </tt>
|
|
290 |
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"> @param rememberAs: gives an ID to this file dialog, allowing it to open at the last used path next time</tt> </tt>
|
|
291 |
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
292 |
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rememberAs</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
|
293 |
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-6', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--getopenfilename"</tt><tt class="py-op">,</tt> <tt class="py-name">initialDir</tt><tt class="py-op">,</tt> <tt class="py-name">fileTypes</tt><tt class="py-op">,</tt> <tt class="py-string">":"</tt> <tt class="py-op">+</tt> <tt class="py-name">rememberAs</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
294 |
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
295 |
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-7', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--getopenfilename"</tt><tt class="py-op">,</tt> <tt class="py-name">initialDir</tt><tt class="py-op">,</tt> <tt class="py-name">fileTypes</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
296 |
</div><a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"> </tt>
|
|
297 |
<a name="Dialog.save_file"></a><div id="Dialog.save_file-def"><a name="L240"></a><tt class="py-lineno">240</tt> <a class="py-toggle" href="#" id="Dialog.save_file-toggle" onclick="return toggle('Dialog.save_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#save_file">save_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Save As"</tt><tt class="py-op">,</tt> <tt class="py-param">initialDir</tt><tt class="py-op">=</tt><tt class="py-string">"~"</tt><tt class="py-op">,</tt> <tt class="py-param">fileTypes</tt><tt class="py-op">=</tt><tt class="py-string">"*|All Files"</tt><tt class="py-op">,</tt> <tt class="py-param">rememberAs</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
298 |
</div><div id="Dialog.save_file-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.save_file-expanded"><a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
299 |
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> Show a Save As dialog</tt> </tt>
|
300 | 300 |
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
301 | |
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
302 | |
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
303 | |
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-comment">#if rememberAs is not None:</tt> </tt>
|
304 | |
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># return self.__runZenity(title, ["--getsavefilename", initialDir, fileTypes, ":" + rememberAs])</tt> </tt>
|
305 | |
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#else:</tt> </tt>
|
306 | |
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="lib.scripting.Dialog.__runZenity" class="py-name" href="#" onclick="return doclink('link-6', '__runZenity', 'link-1');">__runZenity</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--file-selection"</tt><tt class="py-op">,</tt> <tt class="py-string">"--save"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
307 | |
</div><a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> </tt>
|
308 | |
<a name="Dialog.choose_directory"></a><div id="Dialog.choose_directory-def"><a name="L251"></a><tt class="py-lineno">251</tt> <a class="py-toggle" href="#" id="Dialog.choose_directory-toggle" onclick="return toggle('Dialog.choose_directory');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#choose_directory">choose_directory</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Select Directory"</tt><tt class="py-op">,</tt> <tt class="py-param">initialDir</tt><tt class="py-op">=</tt><tt class="py-string">"~"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
309 | |
</div><div id="Dialog.choose_directory-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.choose_directory-expanded"><a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
310 | |
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"><tt class="py-docstring"> Show a Directory Chooser dialog</tt> </tt>
|
311 | |
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
312 | |
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.choose_directory(title="Select Directory")}</tt> </tt>
|
313 | |
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
314 | |
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
315 | |
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
316 | |
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-comment">#if rememberAs is not None:</tt> </tt>
|
317 | |
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># return self.__runZenity(title, ["--getexistingdirectory", initialDir, ":" + rememberAs])</tt> </tt>
|
318 | |
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#else:</tt> </tt>
|
319 | |
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="lib.scripting.Dialog.__runZenity" class="py-name" href="#" onclick="return doclink('link-7', '__runZenity', 'link-1');">__runZenity</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--file-selection"</tt><tt class="py-op">,</tt> <tt class="py-string">"--directory"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
320 | |
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> </tt>
|
321 | |
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-comment">#def choose_colour(self, title="Select Colour"):</tt> </tt>
|
322 | |
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-string">"""</tt> </tt>
|
323 | |
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"><tt class="py-string"> Show a Colour Chooser dialog - not supported by zenity</tt> </tt>
|
324 | |
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
|
325 | |
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"><tt class="py-string"> Usage: C{dialog.choose_colour(title="Select Colour")}</tt> </tt>
|
326 | |
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
|
327 | |
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt class="py-string"> @param title: window title for the dialog</tt> </tt>
|
328 | |
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
|
329 | |
</div></div><a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> <tt class="py-comment">#return self.__runZenity(title, ["--getcolor"])</tt> </tt>
|
330 | |
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
331 | |
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> </tt>
|
332 | |
<a name="System"></a><div id="System-def"><a name="L275"></a><tt class="py-lineno">275</tt> <a class="py-toggle" href="#" id="System-toggle" onclick="return toggle('System');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.System-class.html">System</a><tt class="py-op">:</tt> </tt>
|
333 | |
</div><div id="System-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="System-expanded"><a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
334 | |
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"><tt class="py-docstring"> Simplified access to some system commands.</tt> </tt>
|
335 | |
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
336 | |
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> </tt>
|
337 | |
<a name="System.exec_command"></a><div id="System.exec_command-def"><a name="L280"></a><tt class="py-lineno">280</tt> <a class="py-toggle" href="#" id="System.exec_command-toggle" onclick="return toggle('System.exec_command');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.System-class.html#exec_command">exec_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">command</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
338 | |
</div><div id="System.exec_command-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="System.exec_command-expanded"><a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
339 | |
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"><tt class="py-docstring"> Execute a shell command</tt> </tt>
|
340 | |
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
341 | |
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{system.exec_command(command)}</tt> </tt>
|
342 | |
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
343 | |
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"><tt class="py-docstring"> @param command: command to be executed (including any arguments) - e.g. "ls -l"</tt> </tt>
|
344 | |
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"><tt class="py-docstring"> @raises subprocess.CalledProcessError: if the command returns a non-zero exit code</tt> </tt>
|
345 | |
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
346 | |
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-name">command</tt><tt class="py-op">,</tt> <tt class="py-name">shell</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">bufsize</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt> </tt>
|
347 | |
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> <tt class="py-name">retCode</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
348 | |
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
|
349 | |
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">retCode</tt> <tt class="py-op">!=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
|
350 | |
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">CalledProcessError</tt><tt class="py-op">(</tt><tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
|
351 | |
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
352 | |
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">output</tt> </tt>
|
353 | |
</div><a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> </tt>
|
354 | |
<a name="System.create_file"></a><div id="System.create_file-def"><a name="L297"></a><tt class="py-lineno">297</tt> <a class="py-toggle" href="#" id="System.create_file-toggle" onclick="return toggle('System.create_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.System-class.html#create_file">create_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fileName</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
355 | |
</div><div id="System.create_file-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="System.create_file-expanded"><a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
356 | |
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"><tt class="py-docstring"> Create a file with contents</tt> </tt>
|
357 | |
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
358 | |
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{system.create_file(fileName, contents="")}</tt> </tt>
|
359 | |
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
360 | |
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"><tt class="py-docstring"> @param fileName: full path to the file to be created</tt> </tt>
|
361 | |
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: contents to insert into the file</tt> </tt>
|
362 | |
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
363 | |
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">fileName</tt><tt class="py-op">,</tt> <tt class="py-string">"w"</tt><tt class="py-op">)</tt> </tt>
|
364 | |
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
365 | |
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method lib.scripting.Window.close()=lib.scripting.Window-class.html#close"><a title="lib.scripting.Window.close" class="py-name" href="#" onclick="return doclink('link-8', 'close', 'link-8');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
366 | |
</div></div><a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"> </tt>
|
367 | |
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"> </tt>
|
368 | |
<a name="Clipboard"></a><div id="Clipboard-def"><a name="L311"></a><tt class="py-lineno">311</tt> <a class="py-toggle" href="#" id="Clipboard-toggle" onclick="return toggle('Clipboard');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html">Clipboard</a><tt class="py-op">:</tt> </tt>
|
369 | |
</div><div id="Clipboard-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Clipboard-expanded"><a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
370 | |
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"><tt class="py-docstring"> Read/write access to the X selection and clipboard</tt> </tt>
|
371 | |
<a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
372 | |
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"> </tt>
|
373 | |
<a name="Clipboard.__init__"></a><div id="Clipboard.__init__-def"><a name="L316"></a><tt class="py-lineno">316</tt> <a class="py-toggle" href="#" id="Clipboard.__init__-toggle" onclick="return toggle('Clipboard.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">app</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
374 | |
</div><div id="Clipboard.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__init__-expanded"><a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt> <tt class="py-op">=</tt> <tt class="py-name">gtk</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Class lib.scripting.Clipboard=lib.scripting.Clipboard-class.html"><a title="lib.scripting.Clipboard" class="py-name" href="#" onclick="return doclink('link-9', 'Clipboard', 'link-9');">Clipboard</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
375 | |
<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">selection</tt> <tt class="py-op">=</tt> <tt class="py-name">gtk</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="lib.scripting.Clipboard" class="py-name" href="#" onclick="return doclink('link-10', 'Clipboard', 'link-9');">Clipboard</a></tt><tt class="py-op">(</tt><tt class="py-name">selection</tt><tt class="py-op">=</tt><tt class="py-string">"PRIMARY"</tt><tt class="py-op">)</tt> </tt>
|
376 | |
<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">app</tt> <tt class="py-op">=</tt> <tt class="py-name">app</tt> </tt>
|
377 | |
</div><a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"> </tt>
|
378 | |
<a name="Clipboard.fill_selection"></a><div id="Clipboard.fill_selection-def"><a name="L321"></a><tt class="py-lineno">321</tt> <a class="py-toggle" href="#" id="Clipboard.fill_selection-toggle" onclick="return toggle('Clipboard.fill_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#fill_selection">fill_selection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
379 | |
</div><div id="Clipboard.fill_selection-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.fill_selection-expanded"><a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
380 | |
<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the X selection</tt> </tt>
|
381 | |
<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
382 | |
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_selection(contents)}</tt> </tt>
|
383 | |
<a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
384 | |
<a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
|
385 | |
<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
386 | |
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"> <tt class="py-comment">#self.__execAsync(self.__fillSelection, contents)</tt> </tt>
|
387 | |
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method lib.scripting.Clipboard.__fillSelection()=lib.scripting.Clipboard-class.html#__fillSelection"><a title="lib.scripting.Clipboard.__fillSelection" class="py-name" href="#" onclick="return doclink('link-11', '__fillSelection', 'link-11');">__fillSelection</a></tt><tt class="py-op">(</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
388 | |
</div><a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"> </tt>
|
389 | |
<a name="Clipboard.__fillSelection"></a><div id="Clipboard.__fillSelection-def"><a name="L332"></a><tt class="py-lineno">332</tt> <a class="py-toggle" href="#" id="Clipboard.__fillSelection-toggle" onclick="return toggle('Clipboard.__fillSelection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__fillSelection">__fillSelection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
390 | |
</div><div id="Clipboard.__fillSelection-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__fillSelection-expanded"><a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">selection</tt><tt class="py-op">.</tt><tt class="py-name">set_text</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
391 | |
</div><a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"> <tt class="py-comment">#self.sem.release()</tt> </tt>
|
392 | |
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
393 | |
<a name="Clipboard.get_selection"></a><div id="Clipboard.get_selection-def"><a name="L336"></a><tt class="py-lineno">336</tt> <a class="py-toggle" href="#" id="Clipboard.get_selection-toggle" onclick="return toggle('Clipboard.get_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#get_selection">get_selection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
394 | |
</div><div id="Clipboard.get_selection-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.get_selection-expanded"><a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
395 | |
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the X selection</tt> </tt>
|
396 | |
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
397 | |
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_selection()}</tt> </tt>
|
398 | |
<a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
399 | |
<a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method lib.scripting.Clipboard.__execAsync()=lib.scripting.Clipboard-class.html#__execAsync"><a title="lib.scripting.Clipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-12', '__execAsync', 'link-12');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">selection</tt><tt class="py-op">.</tt><tt class="py-name">request_text</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Method lib.scripting.Clipboard.__receive()=lib.scripting.Clipboard-class.html#__receive"><a title="lib.scripting.Clipboard.__receive" class="py-name" href="#" onclick="return doclink('link-13', '__receive', 'link-13');">__receive</a></tt><tt class="py-op">)</tt> </tt>
|
400 | |
<a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt> </tt>
|
401 | |
</div><a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"> </tt>
|
402 | |
<a name="Clipboard.__receive"></a><div id="Clipboard.__receive-def"><a name="L345"></a><tt class="py-lineno">345</tt> <a class="py-toggle" href="#" id="Clipboard.__receive-toggle" onclick="return toggle('Clipboard.__receive');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__receive">__receive</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">cb</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
403 | |
</div><div id="Clipboard.__receive-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__receive-expanded"><a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</tt> <tt class="py-op">=</tt> <tt class="py-name">text</tt> </tt>
|
404 | |
<a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt><tt class="py-op">.</tt><tt class="py-name">release</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
405 | |
</div><a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"> </tt>
|
406 | |
<a name="Clipboard.fill_clipboard"></a><div id="Clipboard.fill_clipboard-def"><a name="L349"></a><tt class="py-lineno">349</tt> <a class="py-toggle" href="#" id="Clipboard.fill_clipboard-toggle" onclick="return toggle('Clipboard.fill_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#fill_clipboard">fill_clipboard</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
407 | |
</div><div id="Clipboard.fill_clipboard-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.fill_clipboard-expanded"><a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
408 | |
<a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the clipboard</tt> </tt>
|
409 | |
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
410 | |
<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_clipboard(contents)}</tt> </tt>
|
411 | |
<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
412 | |
<a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
|
413 | |
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
414 | |
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method lib.scripting.Clipboard.__fillClipboard()=lib.scripting.Clipboard-class.html#__fillClipboard"><a title="lib.scripting.Clipboard.__fillClipboard" class="py-name" href="#" onclick="return doclink('link-14', '__fillClipboard', 'link-14');">__fillClipboard</a></tt><tt class="py-op">(</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
415 | |
</div><a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> </tt>
|
416 | |
<a name="Clipboard.__fillClipboard"></a><div id="Clipboard.__fillClipboard-def"><a name="L359"></a><tt class="py-lineno">359</tt> <a class="py-toggle" href="#" id="Clipboard.__fillClipboard-toggle" onclick="return toggle('Clipboard.__fillClipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__fillClipboard">__fillClipboard</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
417 | |
</div><div id="Clipboard.__fillClipboard-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__fillClipboard-expanded"><a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt><tt class="py-op">.</tt><tt class="py-name">set_text</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
|
418 | |
</div><a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"> <tt class="py-comment">#self.sem.release() </tt> </tt>
|
419 | |
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
|
420 | |
<a name="Clipboard.get_clipboard"></a><div id="Clipboard.get_clipboard-def"><a name="L363"></a><tt class="py-lineno">363</tt> <a class="py-toggle" href="#" id="Clipboard.get_clipboard-toggle" onclick="return toggle('Clipboard.get_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#get_clipboard">get_clipboard</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
421 | |
</div><div id="Clipboard.get_clipboard-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.get_clipboard-expanded"><a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
422 | |
<a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the clipboard</tt> </tt>
|
423 | |
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
424 | |
<a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_clipboard()}</tt> </tt>
|
425 | |
<a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
426 | |
<a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="lib.scripting.Clipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-15', '__execAsync', 'link-12');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt><tt class="py-op">.</tt><tt class="py-name">request_text</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="lib.scripting.Clipboard.__receive" class="py-name" href="#" onclick="return doclink('link-16', '__receive', 'link-13');">__receive</a></tt><tt class="py-op">)</tt> </tt>
|
427 | |
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt> </tt>
|
428 | |
</div><a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"> </tt>
|
429 | |
<a name="Clipboard.__execAsync"></a><div id="Clipboard.__execAsync-def"><a name="L372"></a><tt class="py-lineno">372</tt> <a class="py-toggle" href="#" id="Clipboard.__execAsync-toggle" onclick="return toggle('Clipboard.__execAsync');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__execAsync">__execAsync</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
430 | |
</div><div id="Clipboard.__execAsync-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__execAsync-expanded"><a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Semaphore</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
|
431 | |
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"> <tt class="py-name">callback</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
|
432 | |
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt><tt class="py-op">.</tt><tt class="py-name">acquire</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
433 | |
</div></div><a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"> </tt>
|
434 | |
<a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"> </tt>
|
435 | |
<a name="Window"></a><div id="Window-def"><a name="L378"></a><tt class="py-lineno">378</tt> <a class="py-toggle" href="#" id="Window-toggle" onclick="return toggle('Window');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Window-class.html">Window</a><tt class="py-op">:</tt> </tt>
|
436 | |
</div><div id="Window-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Window-expanded"><a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
437 | |
<a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"><tt class="py-docstring"> Basic window management using wmctrl</tt> </tt>
|
438 | |
<a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
439 | |
<a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"><tt class="py-docstring"> Note: in all cases where a window title is required (with the exception of wait_for_focus()), </tt> </tt>
|
440 | |
<a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"><tt class="py-docstring"> two special values of window title are permitted:</tt> </tt>
|
441 | |
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
442 | |
<a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"><tt class="py-docstring"> :ACTIVE: - select the currently active window</tt> </tt>
|
443 | |
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"><tt class="py-docstring"> :SELECT: - select the desired window by clicking on it</tt> </tt>
|
444 | |
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
445 | |
<a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"> </tt>
|
446 | |
<a name="Window.__init__"></a><div id="Window.__init__-def"><a name="L389"></a><tt class="py-lineno">389</tt> <a class="py-toggle" href="#" id="Window.__init__-toggle" onclick="return toggle('Window.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mediator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
447 | |
</div><div id="Window.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.__init__-expanded"><a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt> <tt class="py-op">=</tt> <tt class="py-name">mediator</tt> </tt>
|
448 | |
</div><a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"> </tt>
|
449 | |
<a name="Window.wait_for_focus"></a><div id="Window.wait_for_focus-def"><a name="L392"></a><tt class="py-lineno">392</tt> <a class="py-toggle" href="#" id="Window.wait_for_focus-toggle" onclick="return toggle('Window.wait_for_focus');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#wait_for_focus">wait_for_focus</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">timeOut</tt><tt class="py-op">=</tt><tt class="py-number">5</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
450 | |
</div><div id="Window.wait_for_focus-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.wait_for_focus-expanded"><a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
451 | |
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"><tt class="py-docstring"> Wait for window with the given title to have focus</tt> </tt>
|
452 | |
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
453 | |
<a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.wait_for_focus(title, timeOut=5)}</tt> </tt>
|
454 | |
<a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
455 | |
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"><tt class="py-docstring"> If the window becomes active, returns True. Otherwise, returns False if</tt> </tt>
|
456 | |
<a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"><tt class="py-docstring"> the window has not become active by the time the timeout has elapsed.</tt> </tt>
|
457 | |
<a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
458 | |
<a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"><tt class="py-docstring"> @param title: title to match against (as a regular expression)</tt> </tt>
|
459 | |
<a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: period (seconds) to wait before giving up</tt> </tt>
|
460 | |
<a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
461 | |
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> <tt class="py-name">regex</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">)</tt> </tt>
|
462 | |
<a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
|
463 | |
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">waited</tt> <tt class="py-op"><</tt> <tt class="py-name">timeOut</tt><tt class="py-op">:</tt> </tt>
|
464 | |
<a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">regex</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">interface</tt><tt class="py-op">.</tt><tt class="py-name">get_window_title</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
465 | |
<a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
|
466 | |
<a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">sleep</tt><tt class="py-op">(</tt><tt class="py-number">0.3</tt><tt class="py-op">)</tt> </tt>
|
467 | |
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">+=</tt> <tt class="py-number">0.3</tt> </tt>
|
468 | |
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"> </tt>
|
469 | |
<a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
|
470 | |
</div><a name="L413"></a><tt class="py-lineno">413</tt> <tt class="py-line"> </tt>
|
471 | |
<a name="Window.wait_for_exist"></a><div id="Window.wait_for_exist-def"><a name="L414"></a><tt class="py-lineno">414</tt> <a class="py-toggle" href="#" id="Window.wait_for_exist-toggle" onclick="return toggle('Window.wait_for_exist');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#wait_for_exist">wait_for_exist</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">timeOut</tt><tt class="py-op">=</tt><tt class="py-number">5</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
472 | |
</div><div id="Window.wait_for_exist-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.wait_for_exist-expanded"><a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
473 | |
<a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"><tt class="py-docstring"> Wait for window with the given title to be created</tt> </tt>
|
474 | |
<a name="L417"></a><tt class="py-lineno">417</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
475 | |
<a name="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.wait_for_exist(title, timeOut=5)}</tt> </tt>
|
476 | |
<a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
477 | |
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"><tt class="py-docstring"> If the window is in existence, returns True. Otherwise, returns False if</tt> </tt>
|
478 | |
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"><tt class="py-docstring"> the window has not been created by the time the timeout has elapsed.</tt> </tt>
|
479 | |
<a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
480 | |
<a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"><tt class="py-docstring"> @param title: title to match against (as a regular expression)</tt> </tt>
|
481 | |
<a name="L424"></a><tt class="py-lineno">424</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: period (seconds) to wait before giving up</tt> </tt>
|
482 | |
<a name="L425"></a><tt class="py-lineno">425</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
483 | |
<a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"> <tt class="py-name">regex</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">)</tt> </tt>
|
484 | |
<a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
|
485 | |
<a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">waited</tt> <tt class="py-op"><</tt> <tt class="py-name">timeOut</tt><tt class="py-op">:</tt> </tt>
|
486 | |
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"> <tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Method lib.scripting.Window.__runWmctrl()=lib.scripting.Window-class.html#__runWmctrl"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-17', '__runWmctrl', 'link-17');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-l"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
487 | |
<a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">output</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
488 | |
<a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">regex</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">14</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
489 | |
<a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
|
490 | |
<a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"> </tt>
|
491 | |
<a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">sleep</tt><tt class="py-op">(</tt><tt class="py-number">0.3</tt><tt class="py-op">)</tt> </tt>
|
492 | |
<a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">+=</tt> <tt class="py-number">0.3</tt> </tt>
|
493 | |
<a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"> </tt>
|
494 | |
<a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
|
495 | |
</div><a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"> </tt>
|
496 | |
<a name="Window.activate"></a><div id="Window.activate-def"><a name="L439"></a><tt class="py-lineno">439</tt> <a class="py-toggle" href="#" id="Window.activate-toggle" onclick="return toggle('Window.activate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#activate">activate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">switchDesktop</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
497 | |
</div><div id="Window.activate-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.activate-expanded"><a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
498 | |
<a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"><tt class="py-docstring"> Activate the specified window, giving it input focus</tt> </tt>
|
499 | |
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
500 | |
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.activate(title, switchDesktop=False)}</tt> </tt>
|
501 | |
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
502 | |
<a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"><tt class="py-docstring"> If switchDesktop is False (default), the window will be moved to the current desktop</tt> </tt>
|
503 | |
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"><tt class="py-docstring"> and activated. Otherwise, switch to the window's current desktop and activate it there.</tt> </tt>
|
504 | |
<a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
505 | |
<a name="L448"></a><tt class="py-lineno">448</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
506 | |
<a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"><tt class="py-docstring"> @param switchDesktop: whether or not to switch to the window's current desktop</tt> </tt>
|
507 | |
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
508 | |
<a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">switchDesktop</tt><tt class="py-op">:</tt> </tt>
|
509 | |
<a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"-a"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt> </tt>
|
510 | |
<a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
511 | |
<a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"-R"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt> </tt>
|
512 | |
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-18', '__runWmctrl', 'link-17');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
|
513 | |
</div><a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"> </tt>
|
514 | |
<a name="Window.close"></a><div id="Window.close-def"><a name="L457"></a><tt class="py-lineno">457</tt> <a class="py-toggle" href="#" id="Window.close-toggle" onclick="return toggle('Window.close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#close">close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
515 | |
</div><div id="Window.close-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.close-expanded"><a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
516 | |
<a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"><tt class="py-docstring"> Close the specified window gracefully</tt> </tt>
|
517 | |
<a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
518 | |
<a name="L461"></a><tt class="py-lineno">461</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.close(title)}</tt> </tt>
|
519 | |
<a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
520 | |
<a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
521 | |
<a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
522 | |
<a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-19', '__runWmctrl', 'link-17');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-c"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
523 | |
</div><a name="L466"></a><tt class="py-lineno">466</tt> <tt class="py-line"> </tt>
|
524 | |
<a name="Window.resize_move"></a><div id="Window.resize_move-def"><a name="L467"></a><tt class="py-lineno">467</tt> <a class="py-toggle" href="#" id="Window.resize_move-toggle" onclick="return toggle('Window.resize_move');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#resize_move">resize_move</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">xOrigin</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">yOrigin</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">height</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
525 | |
</div><div id="Window.resize_move-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.resize_move-expanded"><a name="L468"></a><tt class="py-lineno">468</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
526 | |
<a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"><tt class="py-docstring"> Resize and/or move the specified window</tt> </tt>
|
527 | |
<a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
528 | |
<a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.close(title, xOrigin=-1, yOrigin=-1, width=-1, height=-1)}</tt> </tt>
|
529 | |
<a name="L472"></a><tt class="py-lineno">472</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
530 | |
<a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"><tt class="py-docstring"> Leaving and of the position/dimension values as the default (-1) will cause that</tt> </tt>
|
531 | |
<a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"><tt class="py-docstring"> value to be left unmodified.</tt> </tt>
|
532 | |
<a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
533 | |
<a name="L476"></a><tt class="py-lineno">476</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
534 | |
<a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"><tt class="py-docstring"> @param xOrigin: new x origin of the window (upper left corner)</tt> </tt>
|
535 | |
<a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"><tt class="py-docstring"> @param yOrigin: new y origin of the window (upper left corner)</tt> </tt>
|
536 | |
<a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"><tt class="py-docstring"> @param width: new width of the window</tt> </tt>
|
537 | |
<a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"><tt class="py-docstring"> @param height: new height of the window</tt> </tt>
|
538 | |
<a name="L481"></a><tt class="py-lineno">481</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
539 | |
<a name="L482"></a><tt class="py-lineno">482</tt> <tt class="py-line"> <tt class="py-name">mvArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"0"</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">xOrigin</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">yOrigin</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">height</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
|
540 | |
<a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-20', '__runWmctrl', 'link-17');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-r"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-string">"-e"</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">mvArgs</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
541 | |
</div><a name="L484"></a><tt class="py-lineno">484</tt> <tt class="py-line"> </tt>
|
542 | |
<a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"> </tt>
|
543 | |
<a name="Window.move_to_desktop"></a><div id="Window.move_to_desktop-def"><a name="L486"></a><tt class="py-lineno">486</tt> <a class="py-toggle" href="#" id="Window.move_to_desktop-toggle" onclick="return toggle('Window.move_to_desktop');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#move_to_desktop">move_to_desktop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
544 | |
</div><div id="Window.move_to_desktop-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.move_to_desktop-expanded"><a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
545 | |
<a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"><tt class="py-docstring"> Move the specified window to the given desktop</tt> </tt>
|
546 | |
<a name="L489"></a><tt class="py-lineno">489</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
547 | |
<a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.move_to_desktop(title, deskNum)}</tt> </tt>
|
548 | |
<a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
549 | |
<a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
550 | |
<a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"><tt class="py-docstring"> @param deskNum: desktop to move the window to (note: zero based)</tt> </tt>
|
551 | |
<a name="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
552 | |
<a name="L495"></a><tt class="py-lineno">495</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-21', '__runWmctrl', 'link-17');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-r"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-string">"-t"</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
553 | |
</div><a name="L496"></a><tt class="py-lineno">496</tt> <tt class="py-line"> </tt>
|
554 | |
<a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"> </tt>
|
555 | |
<a name="Window.switch_desktop"></a><div id="Window.switch_desktop-def"><a name="L498"></a><tt class="py-lineno">498</tt> <a class="py-toggle" href="#" id="Window.switch_desktop-toggle" onclick="return toggle('Window.switch_desktop');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#switch_desktop">switch_desktop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
556 | |
</div><div id="Window.switch_desktop-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.switch_desktop-expanded"><a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
557 | |
<a name="L500"></a><tt class="py-lineno">500</tt> <tt class="py-line"><tt class="py-docstring"> Switch to the specified desktop</tt> </tt>
|
558 | |
<a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
559 | |
<a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.switch_desktop(deskNum)}</tt> </tt>
|
560 | |
<a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
561 | |
<a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"><tt class="py-docstring"> @param deskNum: desktop to switch to (note: zero based)</tt> </tt>
|
562 | |
<a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
563 | |
<a name="L506"></a><tt class="py-lineno">506</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-22', '__runWmctrl', 'link-17');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-s"</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
564 | |
</div><a name="L507"></a><tt class="py-lineno">507</tt> <tt class="py-line"> </tt>
|
565 | |
<a name="Window.set_property"></a><div id="Window.set_property-def"><a name="L508"></a><tt class="py-lineno">508</tt> <a class="py-toggle" href="#" id="Window.set_property-toggle" onclick="return toggle('Window.set_property');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#set_property">set_property</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">action</tt><tt class="py-op">,</tt> <tt class="py-param">prop</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
566 | |
</div><div id="Window.set_property-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.set_property-expanded"><a name="L509"></a><tt class="py-lineno">509</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
567 | |
<a name="L510"></a><tt class="py-lineno">510</tt> <tt class="py-line"><tt class="py-docstring"> Set a property on the given window using the specified action</tt> </tt>
|
568 | |
<a name="L511"></a><tt class="py-lineno">511</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
569 | |
<a name="L512"></a><tt class="py-lineno">512</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.set_property(title, title, action, prop)}</tt> </tt>
|
570 | |
<a name="L513"></a><tt class="py-lineno">513</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
571 | |
<a name="L514"></a><tt class="py-lineno">514</tt> <tt class="py-line"><tt class="py-docstring"> Allowable actions: C{add, remove, toggle}</tt> </tt>
|
572 | |
<a name="L515"></a><tt class="py-lineno">515</tt> <tt class="py-line"><tt class="py-docstring"> Allowable properties: C{modal, sticky, maximized_vert, maximized_horz, shaded, skip_taskbar,</tt> </tt>
|
573 | |
<a name="L516"></a><tt class="py-lineno">516</tt> <tt class="py-line"><tt class="py-docstring"> skip_pager, hidden, fullscreen, above}</tt> </tt>
|
574 | |
<a name="L517"></a><tt class="py-lineno">517</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
575 | |
<a name="L518"></a><tt class="py-lineno">518</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
576 | |
<a name="L519"></a><tt class="py-lineno">519</tt> <tt class="py-line"><tt class="py-docstring"> @param action: one of the actions listed above</tt> </tt>
|
577 | |
<a name="L520"></a><tt class="py-lineno">520</tt> <tt class="py-line"><tt class="py-docstring"> @param prop: one of the properties listed above</tt> </tt>
|
578 | |
<a name="L521"></a><tt class="py-lineno">521</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
579 | |
<a name="L522"></a><tt class="py-lineno">522</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-23', '__runWmctrl', 'link-17');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-r"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-string">"-b"</tt> <tt class="py-op">+</tt> <tt class="py-name">action</tt> <tt class="py-op">+</tt> <tt class="py-string">','</tt> <tt class="py-op">+</tt> <tt class="py-name">prop</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
580 | |
</div><a name="L523"></a><tt class="py-lineno">523</tt> <tt class="py-line"> </tt>
|
581 | |
<a name="Window.__runWmctrl"></a><div id="Window.__runWmctrl-def"><a name="L524"></a><tt class="py-lineno">524</tt> <a class="py-toggle" href="#" id="Window.__runWmctrl-toggle" onclick="return toggle('Window.__runWmctrl');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#__runWmctrl">__runWmctrl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
582 | |
</div><div id="Window.__runWmctrl-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.__runWmctrl-expanded"><a name="L525"></a><tt class="py-lineno">525</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"wmctrl"</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt> </tt>
|
583 | |
<a name="L526"></a><tt class="py-lineno">526</tt> <tt class="py-line"> <tt class="py-name">retCode</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
584 | |
<a name="L527"></a><tt class="py-lineno">527</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-comment"># Drop trailing newline</tt> </tt>
|
585 | |
<a name="L528"></a><tt class="py-lineno">528</tt> <tt class="py-line"> </tt>
|
586 | |
<a name="L529"></a><tt class="py-lineno">529</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
|
587 | |
</div></div><a name="L530"></a><tt class="py-lineno">530</tt> <tt class="py-line"> </tt><script type="text/javascript">
|
|
301 |
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.save_file(title="Save As", initialDir="~", fileTypes="*|All Files", rememberAs=None)}</tt> </tt>
|
|
302 |
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
303 |
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
304 |
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"><tt class="py-docstring"> @param initialDir: starting directory for the file dialog</tt> </tt>
|
|
305 |
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"><tt class="py-docstring"> @param fileTypes: file type filter expression</tt> </tt>
|
|
306 |
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"><tt class="py-docstring"> @param rememberAs: gives an ID to this file dialog, allowing it to open at the last used path next time</tt> </tt>
|
|
307 |
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
308 |
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rememberAs</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
|
309 |
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-8', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--getsavefilename"</tt><tt class="py-op">,</tt> <tt class="py-name">initialDir</tt><tt class="py-op">,</tt> <tt class="py-name">fileTypes</tt><tt class="py-op">,</tt> <tt class="py-string">":"</tt> <tt class="py-op">+</tt> <tt class="py-name">rememberAs</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
310 |
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
311 |
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-9', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--getsavefilename"</tt><tt class="py-op">,</tt> <tt class="py-name">initialDir</tt><tt class="py-op">,</tt> <tt class="py-name">fileTypes</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
312 |
</div><a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> </tt>
|
|
313 |
<a name="Dialog.choose_directory"></a><div id="Dialog.choose_directory-def"><a name="L256"></a><tt class="py-lineno">256</tt> <a class="py-toggle" href="#" id="Dialog.choose_directory-toggle" onclick="return toggle('Dialog.choose_directory');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#choose_directory">choose_directory</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Select Directory"</tt><tt class="py-op">,</tt> <tt class="py-param">initialDir</tt><tt class="py-op">=</tt><tt class="py-string">"~"</tt><tt class="py-op">,</tt> <tt class="py-param">rememberAs</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
314 |
</div><div id="Dialog.choose_directory-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.choose_directory-expanded"><a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
315 |
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"><tt class="py-docstring"> Show a Directory Chooser dialog</tt> </tt>
|
|
316 |
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
317 |
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.choose_directory(title="Select Directory", initialDir="~", rememberAs=None)}</tt> </tt>
|
|
318 |
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
319 |
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
320 |
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"><tt class="py-docstring"> @param initialDir: starting directory for the directory chooser dialog</tt> </tt>
|
|
321 |
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"><tt class="py-docstring"> @param rememberAs: gives an ID to this file dialog, allowing it to open at the last used path next time</tt> </tt>
|
|
322 |
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
323 |
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rememberAs</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
|
324 |
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-10', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--getexistingdirectory"</tt><tt class="py-op">,</tt> <tt class="py-name">initialDir</tt><tt class="py-op">,</tt> <tt class="py-string">":"</tt> <tt class="py-op">+</tt> <tt class="py-name">rememberAs</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
325 |
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
326 |
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-11', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--getexistingdirectory"</tt><tt class="py-op">,</tt> <tt class="py-name">initialDir</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
327 |
</div><a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> </tt>
|
|
328 |
<a name="Dialog.choose_colour"></a><div id="Dialog.choose_colour-def"><a name="L271"></a><tt class="py-lineno">271</tt> <a class="py-toggle" href="#" id="Dialog.choose_colour-toggle" onclick="return toggle('Dialog.choose_colour');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Dialog-class.html#choose_colour">choose_colour</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">"Select Colour"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
329 |
</div><div id="Dialog.choose_colour-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Dialog.choose_colour-expanded"><a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
330 |
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> Show a Colour Chooser dialog</tt> </tt>
|
|
331 |
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
332 |
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.choose_colour(title="Select Colour")}</tt> </tt>
|
|
333 |
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
334 |
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
|
|
335 |
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
336 |
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="lib.scripting.Dialog.__runKdialog" class="py-name" href="#" onclick="return doclink('link-12', '__runKdialog', 'link-1');">__runKdialog</a></tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-string">"--getcolor"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
337 |
</div></div><a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> </tt>
|
|
338 |
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> </tt>
|
|
339 |
<a name="System"></a><div id="System-def"><a name="L282"></a><tt class="py-lineno">282</tt> <a class="py-toggle" href="#" id="System-toggle" onclick="return toggle('System');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.System-class.html">System</a><tt class="py-op">:</tt> </tt>
|
|
340 |
</div><div id="System-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="System-expanded"><a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
341 |
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"><tt class="py-docstring"> Simplified access to some system commands.</tt> </tt>
|
|
342 |
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
343 |
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> </tt>
|
|
344 |
<a name="System.exec_command"></a><div id="System.exec_command-def"><a name="L287"></a><tt class="py-lineno">287</tt> <a class="py-toggle" href="#" id="System.exec_command-toggle" onclick="return toggle('System.exec_command');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.System-class.html#exec_command">exec_command</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">command</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
345 |
</div><div id="System.exec_command-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="System.exec_command-expanded"><a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
346 |
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"><tt class="py-docstring"> Execute a shell command</tt> </tt>
|
|
347 |
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
348 |
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{system.exec_command(command)}</tt> </tt>
|
|
349 |
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
350 |
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"><tt class="py-docstring"> @param command: command to be executed (including any arguments) - e.g. "ls -l"</tt> </tt>
|
|
351 |
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"><tt class="py-docstring"> @raises subprocess.CalledProcessError: if the command returns a non-zero exit code</tt> </tt>
|
|
352 |
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
353 |
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-name">command</tt><tt class="py-op">,</tt> <tt class="py-name">shell</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">bufsize</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt> </tt>
|
|
354 |
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-name">retCode</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
355 |
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
|
|
356 |
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">retCode</tt> <tt class="py-op">!=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
|
|
357 |
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">CalledProcessError</tt><tt class="py-op">(</tt><tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
|
|
358 |
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
359 |
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">output</tt> </tt>
|
|
360 |
</div><a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> </tt>
|
|
361 |
<a name="System.create_file"></a><div id="System.create_file-def"><a name="L304"></a><tt class="py-lineno">304</tt> <a class="py-toggle" href="#" id="System.create_file-toggle" onclick="return toggle('System.create_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.System-class.html#create_file">create_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fileName</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
362 |
</div><div id="System.create_file-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="System.create_file-expanded"><a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
363 |
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"><tt class="py-docstring"> Create a file with contents</tt> </tt>
|
|
364 |
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
365 |
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{system.create_file(fileName, contents="")}</tt> </tt>
|
|
366 |
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
367 |
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"><tt class="py-docstring"> @param fileName: full path to the file to be created</tt> </tt>
|
|
368 |
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: contents to insert into the file</tt> </tt>
|
|
369 |
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
370 |
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">fileName</tt><tt class="py-op">,</tt> <tt class="py-string">"w"</tt><tt class="py-op">)</tt> </tt>
|
|
371 |
<a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
|
372 |
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Method lib.scripting.Window.close()=lib.scripting.Window-class.html#close"><a title="lib.scripting.Window.close" class="py-name" href="#" onclick="return doclink('link-13', 'close', 'link-13');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
373 |
</div></div><a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"> </tt>
|
|
374 |
<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"> </tt>
|
|
375 |
<a name="Clipboard"></a><div id="Clipboard-def"><a name="L318"></a><tt class="py-lineno">318</tt> <a class="py-toggle" href="#" id="Clipboard-toggle" onclick="return toggle('Clipboard');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html">Clipboard</a><tt class="py-op">:</tt> </tt>
|
|
376 |
</div><div id="Clipboard-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Clipboard-expanded"><a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
377 |
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"><tt class="py-docstring"> Read/write access to the X selection and clipboard</tt> </tt>
|
|
378 |
<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
379 |
<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"> </tt>
|
|
380 |
<a name="Clipboard.__init__"></a><div id="Clipboard.__init__-def"><a name="L323"></a><tt class="py-lineno">323</tt> <a class="py-toggle" href="#" id="Clipboard.__init__-toggle" onclick="return toggle('Clipboard.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">app</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
381 |
</div><div id="Clipboard.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__init__-expanded"><a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt> <tt class="py-op">=</tt> <tt class="py-name">QApplication</tt><tt class="py-op">.</tt><tt class="py-name">clipboard</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
382 |
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">app</tt> <tt class="py-op">=</tt> <tt class="py-name">app</tt> </tt>
|
|
383 |
</div><a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> </tt>
|
|
384 |
<a name="Clipboard.fill_selection"></a><div id="Clipboard.fill_selection-def"><a name="L327"></a><tt class="py-lineno">327</tt> <a class="py-toggle" href="#" id="Clipboard.fill_selection-toggle" onclick="return toggle('Clipboard.fill_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#fill_selection">fill_selection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
385 |
</div><div id="Clipboard.fill_selection-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.fill_selection-expanded"><a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
386 |
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the X selection</tt> </tt>
|
|
387 |
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
388 |
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_selection(contents)}</tt> </tt>
|
|
389 |
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
390 |
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
|
|
391 |
<a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
392 |
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method lib.scripting.Clipboard.__execAsync()=lib.scripting.Clipboard-class.html#__execAsync"><a title="lib.scripting.Clipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-14', '__execAsync', 'link-14');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name" targets="Method lib.scripting.Clipboard.__fillSelection()=lib.scripting.Clipboard-class.html#__fillSelection"><a title="lib.scripting.Clipboard.__fillSelection" class="py-name" href="#" onclick="return doclink('link-15', '__fillSelection', 'link-15');">__fillSelection</a></tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
|
393 |
</div><a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"> </tt>
|
|
394 |
<a name="Clipboard.__fillSelection"></a><div id="Clipboard.__fillSelection-def"><a name="L337"></a><tt class="py-lineno">337</tt> <a class="py-toggle" href="#" id="Clipboard.__fillSelection-toggle" onclick="return toggle('Clipboard.__fillSelection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__fillSelection">__fillSelection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
395 |
</div><div id="Clipboard.__fillSelection-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__fillSelection-expanded"><a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt><tt class="py-op">.</tt><tt class="py-name">setText</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">,</tt> <tt class="py-name">QClipboard</tt><tt class="py-op">.</tt><tt class="py-name">Selection</tt><tt class="py-op">)</tt> </tt>
|
|
396 |
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt><tt class="py-op">.</tt><tt class="py-name">release</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
397 |
</div><a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"> </tt>
|
|
398 |
<a name="Clipboard.get_selection"></a><div id="Clipboard.get_selection-def"><a name="L341"></a><tt class="py-lineno">341</tt> <a class="py-toggle" href="#" id="Clipboard.get_selection-toggle" onclick="return toggle('Clipboard.get_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#get_selection">get_selection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
399 |
</div><div id="Clipboard.get_selection-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.get_selection-expanded"><a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
400 |
<a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the X selection</tt> </tt>
|
|
401 |
<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
402 |
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_selection()}</tt> </tt>
|
|
403 |
<a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
404 |
<a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="lib.scripting.Clipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-16', '__execAsync', 'link-14');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Method lib.scripting.Clipboard.__getSelection()=lib.scripting.Clipboard-class.html#__getSelection"><a title="lib.scripting.Clipboard.__getSelection" class="py-name" href="#" onclick="return doclink('link-17', '__getSelection', 'link-17');">__getSelection</a></tt><tt class="py-op">)</tt> </tt>
|
|
405 |
<a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
|
|
406 |
</div><a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"> </tt>
|
|
407 |
<a name="Clipboard.__getSelection"></a><div id="Clipboard.__getSelection-def"><a name="L350"></a><tt class="py-lineno">350</tt> <a class="py-toggle" href="#" id="Clipboard.__getSelection-toggle" onclick="return toggle('Clipboard.__getSelection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__getSelection">__getSelection</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
408 |
</div><div id="Clipboard.__getSelection-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__getSelection-expanded"><a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt><tt class="py-op">.</tt><tt class="py-name">text</tt><tt class="py-op">(</tt><tt class="py-name">QClipboard</tt><tt class="py-op">.</tt><tt class="py-name">Selection</tt><tt class="py-op">)</tt> </tt>
|
|
409 |
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt><tt class="py-op">.</tt><tt class="py-name">release</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
410 |
</div><a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"> </tt>
|
|
411 |
<a name="Clipboard.fill_clipboard"></a><div id="Clipboard.fill_clipboard-def"><a name="L354"></a><tt class="py-lineno">354</tt> <a class="py-toggle" href="#" id="Clipboard.fill_clipboard-toggle" onclick="return toggle('Clipboard.fill_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#fill_clipboard">fill_clipboard</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
412 |
</div><div id="Clipboard.fill_clipboard-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.fill_clipboard-expanded"><a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
413 |
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the clipboard</tt> </tt>
|
|
414 |
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
415 |
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_clipboard(contents)}</tt> </tt>
|
|
416 |
<a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
417 |
<a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
|
|
418 |
<a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
419 |
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="lib.scripting.Clipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-18', '__execAsync', 'link-14');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Method lib.scripting.Clipboard.__fillClipboard()=lib.scripting.Clipboard-class.html#__fillClipboard"><a title="lib.scripting.Clipboard.__fillClipboard" class="py-name" href="#" onclick="return doclink('link-19', '__fillClipboard', 'link-19');">__fillClipboard</a></tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
|
420 |
</div><a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"> </tt>
|
|
421 |
<a name="Clipboard.__fillClipboard"></a><div id="Clipboard.__fillClipboard-def"><a name="L364"></a><tt class="py-lineno">364</tt> <a class="py-toggle" href="#" id="Clipboard.__fillClipboard-toggle" onclick="return toggle('Clipboard.__fillClipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__fillClipboard">__fillClipboard</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
422 |
</div><div id="Clipboard.__fillClipboard-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__fillClipboard-expanded"><a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt><tt class="py-op">.</tt><tt class="py-name">setText</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">,</tt> <tt class="py-name">QClipboard</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Class lib.scripting.Clipboard=lib.scripting.Clipboard-class.html"><a title="lib.scripting.Clipboard" class="py-name" href="#" onclick="return doclink('link-20', 'Clipboard', 'link-20');">Clipboard</a></tt><tt class="py-op">)</tt> </tt>
|
|
423 |
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt><tt class="py-op">.</tt><tt class="py-name">release</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
424 |
</div><a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"> </tt>
|
|
425 |
<a name="Clipboard.get_clipboard"></a><div id="Clipboard.get_clipboard-def"><a name="L368"></a><tt class="py-lineno">368</tt> <a class="py-toggle" href="#" id="Clipboard.get_clipboard-toggle" onclick="return toggle('Clipboard.get_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#get_clipboard">get_clipboard</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
426 |
</div><div id="Clipboard.get_clipboard-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.get_clipboard-expanded"><a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
427 |
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the clipboard</tt> </tt>
|
|
428 |
<a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
429 |
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_clipboard()}</tt> </tt>
|
|
430 |
<a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
431 |
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="lib.scripting.Clipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-21', '__execAsync', 'link-14');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name" targets="Method lib.scripting.Clipboard.__getClipboard()=lib.scripting.Clipboard-class.html#__getClipboard"><a title="lib.scripting.Clipboard.__getClipboard" class="py-name" href="#" onclick="return doclink('link-22', '__getClipboard', 'link-22');">__getClipboard</a></tt><tt class="py-op">)</tt> </tt>
|
|
432 |
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
|
|
433 |
</div><a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"> </tt>
|
|
434 |
<a name="Clipboard.__getClipboard"></a><div id="Clipboard.__getClipboard-def"><a name="L377"></a><tt class="py-lineno">377</tt> <a class="py-toggle" href="#" id="Clipboard.__getClipboard-toggle" onclick="return toggle('Clipboard.__getClipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__getClipboard">__getClipboard</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
435 |
</div><div id="Clipboard.__getClipboard-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__getClipboard-expanded"><a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">clipBoard</tt><tt class="py-op">.</tt><tt class="py-name">text</tt><tt class="py-op">(</tt><tt class="py-name">QClipboard</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="lib.scripting.Clipboard" class="py-name" href="#" onclick="return doclink('link-23', 'Clipboard', 'link-20');">Clipboard</a></tt><tt class="py-op">)</tt> </tt>
|
|
436 |
<a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt><tt class="py-op">.</tt><tt class="py-name">release</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
437 |
</div><a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"> </tt>
|
|
438 |
<a name="Clipboard.__execAsync"></a><div id="Clipboard.__execAsync-def"><a name="L381"></a><tt class="py-lineno">381</tt> <a class="py-toggle" href="#" id="Clipboard.__execAsync-toggle" onclick="return toggle('Clipboard.__execAsync');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Clipboard-class.html#__execAsync">__execAsync</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
439 |
</div><div id="Clipboard.__execAsync-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Clipboard.__execAsync-expanded"><a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt> <tt class="py-op">=</tt> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Semaphore</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
|
|
440 |
<a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">app</tt><tt class="py-op">.</tt><tt class="py-name">exec_in_main</tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
|
|
441 |
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sem</tt><tt class="py-op">.</tt><tt class="py-name">acquire</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
442 |
</div></div><a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"> </tt>
|
|
443 |
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"> </tt>
|
|
444 |
<a name="Window"></a><div id="Window-def"><a name="L387"></a><tt class="py-lineno">387</tt> <a class="py-toggle" href="#" id="Window-toggle" onclick="return toggle('Window');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Window-class.html">Window</a><tt class="py-op">:</tt> </tt>
|
|
445 |
</div><div id="Window-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Window-expanded"><a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
446 |
<a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"><tt class="py-docstring"> Basic window management using wmctrl</tt> </tt>
|
|
447 |
<a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
448 |
<a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"><tt class="py-docstring"> Note: in all cases where a window title is required (with the exception of wait_for_focus()), </tt> </tt>
|
|
449 |
<a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"><tt class="py-docstring"> two special values of window title are permitted:</tt> </tt>
|
|
450 |
<a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
451 |
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"><tt class="py-docstring"> :ACTIVE: - select the currently active window</tt> </tt>
|
|
452 |
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"><tt class="py-docstring"> :SELECT: - select the desired window by clicking on it</tt> </tt>
|
|
453 |
<a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
454 |
<a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"> </tt>
|
|
455 |
<a name="Window.__init__"></a><div id="Window.__init__-def"><a name="L398"></a><tt class="py-lineno">398</tt> <a class="py-toggle" href="#" id="Window.__init__-toggle" onclick="return toggle('Window.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mediator</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
456 |
</div><div id="Window.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.__init__-expanded"><a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt> <tt class="py-op">=</tt> <tt class="py-name">mediator</tt> </tt>
|
|
457 |
</div><a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"> </tt>
|
|
458 |
<a name="Window.wait_for_focus"></a><div id="Window.wait_for_focus-def"><a name="L401"></a><tt class="py-lineno">401</tt> <a class="py-toggle" href="#" id="Window.wait_for_focus-toggle" onclick="return toggle('Window.wait_for_focus');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#wait_for_focus">wait_for_focus</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">timeOut</tt><tt class="py-op">=</tt><tt class="py-number">5</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
459 |
</div><div id="Window.wait_for_focus-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.wait_for_focus-expanded"><a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
460 |
<a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"><tt class="py-docstring"> Wait for window with the given title to have focus</tt> </tt>
|
|
461 |
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
462 |
<a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.wait_for_focus(title, timeOut=5)}</tt> </tt>
|
|
463 |
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
464 |
<a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"><tt class="py-docstring"> If the window becomes active, returns True. Otherwise, returns False if</tt> </tt>
|
|
465 |
<a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"><tt class="py-docstring"> the window has not become active by the time the timeout has elapsed.</tt> </tt>
|
|
466 |
<a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
467 |
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"><tt class="py-docstring"> @param title: title to match against (as a regular expression)</tt> </tt>
|
|
468 |
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: period (seconds) to wait before giving up</tt> </tt>
|
|
469 |
<a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
470 |
<a name="L413"></a><tt class="py-lineno">413</tt> <tt class="py-line"> <tt class="py-name">regex</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">)</tt> </tt>
|
|
471 |
<a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
|
|
472 |
<a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">waited</tt> <tt class="py-op"><</tt> <tt class="py-name">timeOut</tt><tt class="py-op">:</tt> </tt>
|
|
473 |
<a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">regex</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">interface</tt><tt class="py-op">.</tt><tt class="py-name">get_window_title</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
474 |
<a name="L417"></a><tt class="py-lineno">417</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
|
|
475 |
<a name="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">sleep</tt><tt class="py-op">(</tt><tt class="py-number">0.3</tt><tt class="py-op">)</tt> </tt>
|
|
476 |
<a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">+=</tt> <tt class="py-number">0.3</tt> </tt>
|
|
477 |
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"> </tt>
|
|
478 |
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
|
|
479 |
</div><a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"> </tt>
|
|
480 |
<a name="Window.wait_for_exist"></a><div id="Window.wait_for_exist-def"><a name="L423"></a><tt class="py-lineno">423</tt> <a class="py-toggle" href="#" id="Window.wait_for_exist-toggle" onclick="return toggle('Window.wait_for_exist');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#wait_for_exist">wait_for_exist</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">timeOut</tt><tt class="py-op">=</tt><tt class="py-number">5</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
481 |
</div><div id="Window.wait_for_exist-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.wait_for_exist-expanded"><a name="L424"></a><tt class="py-lineno">424</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
482 |
<a name="L425"></a><tt class="py-lineno">425</tt> <tt class="py-line"><tt class="py-docstring"> Wait for window with the given title to be created</tt> </tt>
|
|
483 |
<a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
484 |
<a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.wait_for_exist(title, timeOut=5)}</tt> </tt>
|
|
485 |
<a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
486 |
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"><tt class="py-docstring"> If the window is in existence, returns True. Otherwise, returns False if</tt> </tt>
|
|
487 |
<a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"><tt class="py-docstring"> the window has not been created by the time the timeout has elapsed.</tt> </tt>
|
|
488 |
<a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
489 |
<a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"><tt class="py-docstring"> @param title: title to match against (as a regular expression)</tt> </tt>
|
|
490 |
<a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: period (seconds) to wait before giving up</tt> </tt>
|
|
491 |
<a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
492 |
<a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"> <tt class="py-name">regex</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">)</tt> </tt>
|
|
493 |
<a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
|
|
494 |
<a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">waited</tt> <tt class="py-op"><</tt> <tt class="py-name">timeOut</tt><tt class="py-op">:</tt> </tt>
|
|
495 |
<a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"> <tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name" targets="Method lib.scripting.Window.__runWmctrl()=lib.scripting.Window-class.html#__runWmctrl"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-24', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-l"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
496 |
<a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">output</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
497 |
<a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">regex</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">14</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
498 |
<a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
|
|
499 |
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"> </tt>
|
|
500 |
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">sleep</tt><tt class="py-op">(</tt><tt class="py-number">0.3</tt><tt class="py-op">)</tt> </tt>
|
|
501 |
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">+=</tt> <tt class="py-number">0.3</tt> </tt>
|
|
502 |
<a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"> </tt>
|
|
503 |
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
|
|
504 |
</div><a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"> </tt>
|
|
505 |
<a name="Window.activate"></a><div id="Window.activate-def"><a name="L448"></a><tt class="py-lineno">448</tt> <a class="py-toggle" href="#" id="Window.activate-toggle" onclick="return toggle('Window.activate');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#activate">activate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">switchDesktop</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
506 |
</div><div id="Window.activate-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.activate-expanded"><a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
507 |
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"><tt class="py-docstring"> Activate the specified window, giving it input focus</tt> </tt>
|
|
508 |
<a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
509 |
<a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.activate(title, switchDesktop=False)}</tt> </tt>
|
|
510 |
<a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
511 |
<a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"><tt class="py-docstring"> If switchDesktop is False (default), the window will be moved to the current desktop</tt> </tt>
|
|
512 |
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"><tt class="py-docstring"> and activated. Otherwise, switch to the window's current desktop and activate it there.</tt> </tt>
|
|
513 |
<a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
514 |
<a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
|
515 |
<a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"><tt class="py-docstring"> @param switchDesktop: whether or not to switch to the window's current desktop</tt> </tt>
|
|
516 |
<a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
517 |
<a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">switchDesktop</tt><tt class="py-op">:</tt> </tt>
|
|
518 |
<a name="L461"></a><tt class="py-lineno">461</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"-a"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt> </tt>
|
|
519 |
<a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
520 |
<a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"-R"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt> </tt>
|
|
521 |
<a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-25', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
|
|
522 |
</div><a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"> </tt>
|
|
523 |
<a name="Window.close"></a><div id="Window.close-def"><a name="L466"></a><tt class="py-lineno">466</tt> <a class="py-toggle" href="#" id="Window.close-toggle" onclick="return toggle('Window.close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#close">close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
524 |
</div><div id="Window.close-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.close-expanded"><a name="L467"></a><tt class="py-lineno">467</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
525 |
<a name="L468"></a><tt class="py-lineno">468</tt> <tt class="py-line"><tt class="py-docstring"> Close the specified window gracefully</tt> </tt>
|
|
526 |
<a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
527 |
<a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.close(title)}</tt> </tt>
|
|
528 |
<a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
529 |
<a name="L472"></a><tt class="py-lineno">472</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
|
530 |
<a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
531 |
<a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-26', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-c"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
532 |
</div><a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"> </tt>
|
|
533 |
<a name="Window.resize_move"></a><div id="Window.resize_move-def"><a name="L476"></a><tt class="py-lineno">476</tt> <a class="py-toggle" href="#" id="Window.resize_move-toggle" onclick="return toggle('Window.resize_move');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#resize_move">resize_move</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">xOrigin</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">yOrigin</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">height</tt><tt class="py-op">=</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
534 |
</div><div id="Window.resize_move-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.resize_move-expanded"><a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
535 |
<a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"><tt class="py-docstring"> Resize and/or move the specified window</tt> </tt>
|
|
536 |
<a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
537 |
<a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.close(title, xOrigin=-1, yOrigin=-1, width=-1, height=-1)}</tt> </tt>
|
|
538 |
<a name="L481"></a><tt class="py-lineno">481</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
539 |
<a name="L482"></a><tt class="py-lineno">482</tt> <tt class="py-line"><tt class="py-docstring"> Leaving and of the position/dimension values as the default (-1) will cause that</tt> </tt>
|
|
540 |
<a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"><tt class="py-docstring"> value to be left unmodified.</tt> </tt>
|
|
541 |
<a name="L484"></a><tt class="py-lineno">484</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
542 |
<a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
|
543 |
<a name="L486"></a><tt class="py-lineno">486</tt> <tt class="py-line"><tt class="py-docstring"> @param xOrigin: new x origin of the window (upper left corner)</tt> </tt>
|
|
544 |
<a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"><tt class="py-docstring"> @param yOrigin: new y origin of the window (upper left corner)</tt> </tt>
|
|
545 |
<a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"><tt class="py-docstring"> @param width: new width of the window</tt> </tt>
|
|
546 |
<a name="L489"></a><tt class="py-lineno">489</tt> <tt class="py-line"><tt class="py-docstring"> @param height: new height of the window</tt> </tt>
|
|
547 |
<a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
548 |
<a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"> <tt class="py-name">mvArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"0"</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">xOrigin</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">yOrigin</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">height</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
|
|
549 |
<a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-27', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-r"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-string">"-e"</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">mvArgs</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
550 |
</div><a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"> </tt>
|
|
551 |
<a name="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"> </tt>
|
|
552 |
<a name="Window.move_to_desktop"></a><div id="Window.move_to_desktop-def"><a name="L495"></a><tt class="py-lineno">495</tt> <a class="py-toggle" href="#" id="Window.move_to_desktop-toggle" onclick="return toggle('Window.move_to_desktop');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#move_to_desktop">move_to_desktop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
553 |
</div><div id="Window.move_to_desktop-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.move_to_desktop-expanded"><a name="L496"></a><tt class="py-lineno">496</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
554 |
<a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"><tt class="py-docstring"> Move the specified window to the given desktop</tt> </tt>
|
|
555 |
<a name="L498"></a><tt class="py-lineno">498</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
556 |
<a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.move_to_desktop(title, deskNum)}</tt> </tt>
|
|
557 |
<a name="L500"></a><tt class="py-lineno">500</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
558 |
<a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
|
559 |
<a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"><tt class="py-docstring"> @param deskNum: desktop to move the window to (note: zero based)</tt> </tt>
|
|
560 |
<a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
561 |
<a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-28', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-r"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-string">"-t"</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
562 |
</div><a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"> </tt>
|
|
563 |
<a name="L506"></a><tt class="py-lineno">506</tt> <tt class="py-line"> </tt>
|
|
564 |
<a name="Window.switch_desktop"></a><div id="Window.switch_desktop-def"><a name="L507"></a><tt class="py-lineno">507</tt> <a class="py-toggle" href="#" id="Window.switch_desktop-toggle" onclick="return toggle('Window.switch_desktop');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#switch_desktop">switch_desktop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
565 |
</div><div id="Window.switch_desktop-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.switch_desktop-expanded"><a name="L508"></a><tt class="py-lineno">508</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
566 |
<a name="L509"></a><tt class="py-lineno">509</tt> <tt class="py-line"><tt class="py-docstring"> Switch to the specified desktop</tt> </tt>
|
|
567 |
<a name="L510"></a><tt class="py-lineno">510</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
568 |
<a name="L511"></a><tt class="py-lineno">511</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.switch_desktop(deskNum)}</tt> </tt>
|
|
569 |
<a name="L512"></a><tt class="py-lineno">512</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
570 |
<a name="L513"></a><tt class="py-lineno">513</tt> <tt class="py-line"><tt class="py-docstring"> @param deskNum: desktop to switch to (note: zero based)</tt> </tt>
|
|
571 |
<a name="L514"></a><tt class="py-lineno">514</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
572 |
<a name="L515"></a><tt class="py-lineno">515</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-29', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-s"</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">deskNum</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
573 |
</div><a name="L516"></a><tt class="py-lineno">516</tt> <tt class="py-line"> </tt>
|
|
574 |
<a name="Window.set_property"></a><div id="Window.set_property-def"><a name="L517"></a><tt class="py-lineno">517</tt> <a class="py-toggle" href="#" id="Window.set_property-toggle" onclick="return toggle('Window.set_property');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#set_property">set_property</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">action</tt><tt class="py-op">,</tt> <tt class="py-param">prop</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
575 |
</div><div id="Window.set_property-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.set_property-expanded"><a name="L518"></a><tt class="py-lineno">518</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
576 |
<a name="L519"></a><tt class="py-lineno">519</tt> <tt class="py-line"><tt class="py-docstring"> Set a property on the given window using the specified action</tt> </tt>
|
|
577 |
<a name="L520"></a><tt class="py-lineno">520</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
|
|
578 |
<a name="L521"></a><tt class="py-lineno">521</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.set_property(title, title, action, prop)}</tt> </tt>
|
|
579 |
<a name="L522"></a><tt class="py-lineno">522</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
580 |
<a name="L523"></a><tt class="py-lineno">523</tt> <tt class="py-line"><tt class="py-docstring"> Allowable actions: C{add, remove, toggle}</tt> </tt>
|
|
581 |
<a name="L524"></a><tt class="py-lineno">524</tt> <tt class="py-line"><tt class="py-docstring"> Allowable properties: C{modal, sticky, maximized_vert, maximized_horz, shaded, skip_taskbar,</tt> </tt>
|
|
582 |
<a name="L525"></a><tt class="py-lineno">525</tt> <tt class="py-line"><tt class="py-docstring"> skip_pager, hidden, fullscreen, above}</tt> </tt>
|
|
583 |
<a name="L526"></a><tt class="py-lineno">526</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
584 |
<a name="L527"></a><tt class="py-lineno">527</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
|
|
585 |
<a name="L528"></a><tt class="py-lineno">528</tt> <tt class="py-line"><tt class="py-docstring"> @param action: one of the actions listed above</tt> </tt>
|
|
586 |
<a name="L529"></a><tt class="py-lineno">529</tt> <tt class="py-line"><tt class="py-docstring"> @param prop: one of the properties listed above</tt> </tt>
|
|
587 |
<a name="L530"></a><tt class="py-lineno">530</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
588 |
<a name="L531"></a><tt class="py-lineno">531</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-30', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-r"</tt><tt class="py-op">,</tt> <tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-string">"-b"</tt> <tt class="py-op">+</tt> <tt class="py-name">action</tt> <tt class="py-op">+</tt> <tt class="py-string">','</tt> <tt class="py-op">+</tt> <tt class="py-name">prop</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
589 |
</div><a name="L532"></a><tt class="py-lineno">532</tt> <tt class="py-line"> </tt>
|
|
590 |
<a name="Window.get_active_geometry"></a><div id="Window.get_active_geometry-def"><a name="L533"></a><tt class="py-lineno">533</tt> <a class="py-toggle" href="#" id="Window.get_active_geometry-toggle" onclick="return toggle('Window.get_active_geometry');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#get_active_geometry">get_active_geometry</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
591 |
</div><div id="Window.get_active_geometry-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.get_active_geometry-expanded"><a name="L534"></a><tt class="py-lineno">534</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
592 |
<a name="L535"></a><tt class="py-lineno">535</tt> <tt class="py-line"><tt class="py-docstring"> Get the geometry of the currently active window</tt> </tt>
|
|
593 |
<a name="L536"></a><tt class="py-lineno">536</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
594 |
<a name="L537"></a><tt class="py-lineno">537</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.get_active_geometry()}</tt> </tt>
|
|
595 |
<a name="L538"></a><tt class="py-lineno">538</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
596 |
<a name="L539"></a><tt class="py-lineno">539</tt> <tt class="py-line"><tt class="py-docstring"> Returns a 4-tuple containing the x-origin, y-origin, width and height of the window (in pixels)</tt> </tt>
|
|
597 |
<a name="L540"></a><tt class="py-lineno">540</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
598 |
<a name="L541"></a><tt class="py-lineno">541</tt> <tt class="py-line"> <tt class="py-name">active</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mediator</tt><tt class="py-op">.</tt><tt class="py-name">interface</tt><tt class="py-op">.</tt><tt class="py-name">get_window_title</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
599 |
<a name="L542"></a><tt class="py-lineno">542</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="lib.scripting.Window.__runWmctrl" class="py-name" href="#" onclick="return doclink('link-31', '__runWmctrl', 'link-24');">__runWmctrl</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"-l"</tt><tt class="py-op">,</tt> <tt class="py-string">"-G"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
|
|
600 |
<a name="L543"></a><tt class="py-lineno">543</tt> <tt class="py-line"> <tt class="py-name">matchingLine</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
|
601 |
<a name="L544"></a><tt class="py-lineno">544</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">output</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
602 |
<a name="L545"></a><tt class="py-lineno">545</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">active</tt> <tt class="py-keyword">in</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">34</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
|
|
603 |
<a name="L546"></a><tt class="py-lineno">546</tt> <tt class="py-line"> <tt class="py-name">matchingLine</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt> </tt>
|
|
604 |
<a name="L547"></a><tt class="py-lineno">547</tt> <tt class="py-line"> </tt>
|
|
605 |
<a name="L548"></a><tt class="py-lineno">548</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">matchingLine</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
|
606 |
<a name="L549"></a><tt class="py-lineno">549</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">matchingLine</tt><tt class="py-op">[</tt><tt class="py-number">14</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">:</tt><tt class="py-number">3</tt><tt class="py-op">]</tt> </tt>
|
|
607 |
<a name="L550"></a><tt class="py-lineno">550</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">map</tt><tt class="py-op">(</tt><tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
|
|
608 |
<a name="L551"></a><tt class="py-lineno">551</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
609 |
<a name="L552"></a><tt class="py-lineno">552</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
|
|
610 |
</div><a name="L553"></a><tt class="py-lineno">553</tt> <tt class="py-line"> </tt>
|
|
611 |
<a name="Window.__runWmctrl"></a><div id="Window.__runWmctrl-def"><a name="L554"></a><tt class="py-lineno">554</tt> <a class="py-toggle" href="#" id="Window.__runWmctrl-toggle" onclick="return toggle('Window.__runWmctrl');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#__runWmctrl">__runWmctrl</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
612 |
</div><div id="Window.__runWmctrl-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Window.__runWmctrl-expanded"><a name="L555"></a><tt class="py-lineno">555</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"wmctrl"</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt> </tt>
|
|
613 |
<a name="L556"></a><tt class="py-lineno">556</tt> <tt class="py-line"> <tt class="py-name">retCode</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
614 |
<a name="L557"></a><tt class="py-lineno">557</tt> <tt class="py-line"> <tt class="py-name">output</tt> <tt class="py-op">=</tt> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-comment"># Drop trailing newline</tt> </tt>
|
|
615 |
<a name="L558"></a><tt class="py-lineno">558</tt> <tt class="py-line"> </tt>
|
|
616 |
<a name="L559"></a><tt class="py-lineno">559</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">retCode</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
|
|
617 |
</div></div><a name="L560"></a><tt class="py-lineno">560</tt> <tt class="py-line"> </tt>
|
|
618 |
<a name="L561"></a><tt class="py-lineno">561</tt> <tt class="py-line"> </tt>
|
|
619 |
<a name="Engine"></a><div id="Engine-def"><a name="L562"></a><tt class="py-lineno">562</tt> <a class="py-toggle" href="#" id="Engine-toggle" onclick="return toggle('Engine');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html">Engine</a><tt class="py-op">:</tt> </tt>
|
|
620 |
</div><div id="Engine-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Engine-expanded"><a name="L563"></a><tt class="py-lineno">563</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
621 |
<a name="L564"></a><tt class="py-lineno">564</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to the internals of AutoKey.</tt> </tt>
|
|
622 |
<a name="L565"></a><tt class="py-lineno">565</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
623 |
<a name="L566"></a><tt class="py-lineno">566</tt> <tt class="py-line"><tt class="py-docstring"> Note that any configuration changes made using this API while the configuration window</tt> </tt>
|
|
624 |
<a name="L567"></a><tt class="py-lineno">567</tt> <tt class="py-line"><tt class="py-docstring"> is open will not appear until it is closed and re-opened.</tt> </tt>
|
|
625 |
<a name="L568"></a><tt class="py-lineno">568</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
626 |
<a name="L569"></a><tt class="py-lineno">569</tt> <tt class="py-line"> </tt>
|
|
627 |
<a name="Engine.__init__"></a><div id="Engine.__init__-def"><a name="L570"></a><tt class="py-lineno">570</tt> <a class="py-toggle" href="#" id="Engine.__init__-toggle" onclick="return toggle('Engine.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">configManager</tt><tt class="py-op">,</tt> <tt class="py-param">runner</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
628 |
</div><div id="Engine.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Engine.__init__-expanded"><a name="L571"></a><tt class="py-lineno">571</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt> <tt class="py-op">=</tt> <tt class="py-name">configManager</tt> </tt>
|
|
629 |
<a name="L572"></a><tt class="py-lineno">572</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">runner</tt> <tt class="py-op">=</tt> <tt class="py-name">runner</tt> </tt>
|
|
630 |
</div><a name="L573"></a><tt class="py-lineno">573</tt> <tt class="py-line"> </tt>
|
|
631 |
<a name="Engine.get_folder"></a><div id="Engine.get_folder-def"><a name="L574"></a><tt class="py-lineno">574</tt> <a class="py-toggle" href="#" id="Engine.get_folder-toggle" onclick="return toggle('Engine.get_folder');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#get_folder">get_folder</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
632 |
</div><div id="Engine.get_folder-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Engine.get_folder-expanded"><a name="L575"></a><tt class="py-lineno">575</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
633 |
<a name="L576"></a><tt class="py-lineno">576</tt> <tt class="py-line"><tt class="py-docstring"> Retrieve a folder by its title</tt> </tt>
|
|
634 |
<a name="L577"></a><tt class="py-lineno">577</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
635 |
<a name="L578"></a><tt class="py-lineno">578</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.get_folder(title)}</tt> </tt>
|
|
636 |
<a name="L579"></a><tt class="py-lineno">579</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
637 |
<a name="L580"></a><tt class="py-lineno">580</tt> <tt class="py-line"><tt class="py-docstring"> Note that if more than one folder has the same title, only the first match will be</tt> </tt>
|
|
638 |
<a name="L581"></a><tt class="py-lineno">581</tt> <tt class="py-line"><tt class="py-docstring"> returned.</tt> </tt>
|
|
639 |
<a name="L582"></a><tt class="py-lineno">582</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
640 |
<a name="L583"></a><tt class="py-lineno">583</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">folder</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">allFolders</tt><tt class="py-op">:</tt> </tt>
|
|
641 |
<a name="L584"></a><tt class="py-lineno">584</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">folder</tt><tt class="py-op">.</tt><tt class="py-name">title</tt> <tt class="py-op">==</tt> <tt class="py-name">title</tt><tt class="py-op">:</tt> </tt>
|
|
642 |
<a name="L585"></a><tt class="py-lineno">585</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">folder</tt> </tt>
|
|
643 |
<a name="L586"></a><tt class="py-lineno">586</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
|
|
644 |
</div><a name="L587"></a><tt class="py-lineno">587</tt> <tt class="py-line"> </tt>
|
|
645 |
<a name="Engine.create_phrase"></a><div id="Engine.create_phrase-def"><a name="L588"></a><tt class="py-lineno">588</tt> <a class="py-toggle" href="#" id="Engine.create_phrase-toggle" onclick="return toggle('Engine.create_phrase');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#create_phrase">create_phrase</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">folder</tt><tt class="py-op">,</tt> <tt class="py-param">description</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
646 |
</div><div id="Engine.create_phrase-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Engine.create_phrase-expanded"><a name="L589"></a><tt class="py-lineno">589</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
647 |
<a name="L590"></a><tt class="py-lineno">590</tt> <tt class="py-line"><tt class="py-docstring"> Create a text phrase</tt> </tt>
|
|
648 |
<a name="L591"></a><tt class="py-lineno">591</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
649 |
<a name="L592"></a><tt class="py-lineno">592</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.create_phrase(folder, description, contents)}</tt> </tt>
|
|
650 |
<a name="L593"></a><tt class="py-lineno">593</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
651 |
<a name="L594"></a><tt class="py-lineno">594</tt> <tt class="py-line"><tt class="py-docstring"> A new phrase with no abbreviation or hotkey is created in the specified folder</tt> </tt>
|
|
652 |
<a name="L595"></a><tt class="py-lineno">595</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
653 |
<a name="L596"></a><tt class="py-lineno">596</tt> <tt class="py-line"><tt class="py-docstring"> @param folder: folder to place the abbreviation in, retrieved using C{engine.get_folder()}</tt> </tt>
|
|
654 |
<a name="L597"></a><tt class="py-lineno">597</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description for the phrase</tt> </tt>
|
|
655 |
<a name="L598"></a><tt class="py-lineno">598</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: the expansion text</tt> </tt>
|
|
656 |
<a name="L599"></a><tt class="py-lineno">599</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
657 |
<a name="L600"></a><tt class="py-lineno">600</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">model</tt><tt class="py-op">.</tt><tt class="py-name">Phrase</tt><tt class="py-op">(</tt><tt class="py-name">description</tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
|
658 |
<a name="L601"></a><tt class="py-lineno">601</tt> <tt class="py-line"> <tt class="py-name">folder</tt><tt class="py-op">.</tt><tt class="py-name">add_item</tt><tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">)</tt> </tt>
|
|
659 |
<a name="L602"></a><tt class="py-lineno">602</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">config_altered</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
660 |
</div><a name="L603"></a><tt class="py-lineno">603</tt> <tt class="py-line"> </tt>
|
|
661 |
<a name="Engine.create_abbreviation"></a><div id="Engine.create_abbreviation-def"><a name="L604"></a><tt class="py-lineno">604</tt> <a class="py-toggle" href="#" id="Engine.create_abbreviation-toggle" onclick="return toggle('Engine.create_abbreviation');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#create_abbreviation">create_abbreviation</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">folder</tt><tt class="py-op">,</tt> <tt class="py-param">description</tt><tt class="py-op">,</tt> <tt class="py-param">abbr</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
662 |
</div><div id="Engine.create_abbreviation-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Engine.create_abbreviation-expanded"><a name="L605"></a><tt class="py-lineno">605</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
663 |
<a name="L606"></a><tt class="py-lineno">606</tt> <tt class="py-line"><tt class="py-docstring"> Create a text abbreviation</tt> </tt>
|
|
664 |
<a name="L607"></a><tt class="py-lineno">607</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
665 |
<a name="L608"></a><tt class="py-lineno">608</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.create_abbreviation(folder, description, abbr, contents)}</tt> </tt>
|
|
666 |
<a name="L609"></a><tt class="py-lineno">609</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
667 |
<a name="L610"></a><tt class="py-lineno">610</tt> <tt class="py-line"><tt class="py-docstring"> When the given abbreviation is typed, it will be replaced with the given</tt> </tt>
|
|
668 |
<a name="L611"></a><tt class="py-lineno">611</tt> <tt class="py-line"><tt class="py-docstring"> text.</tt> </tt>
|
|
669 |
<a name="L612"></a><tt class="py-lineno">612</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
670 |
<a name="L613"></a><tt class="py-lineno">613</tt> <tt class="py-line"><tt class="py-docstring"> @param folder: folder to place the abbreviation in, retrieved using C{engine.get_folder()}</tt> </tt>
|
|
671 |
<a name="L614"></a><tt class="py-lineno">614</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description for the phrase</tt> </tt>
|
|
672 |
<a name="L615"></a><tt class="py-lineno">615</tt> <tt class="py-line"><tt class="py-docstring"> @param abbr: the abbreviation that will trigger the expansion</tt> </tt>
|
|
673 |
<a name="L616"></a><tt class="py-lineno">616</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: the expansion text</tt> </tt>
|
|
674 |
<a name="L617"></a><tt class="py-lineno">617</tt> <tt class="py-line"><tt class="py-docstring"> @raises Exception: if the specified abbreviation is not unique</tt> </tt>
|
|
675 |
<a name="L618"></a><tt class="py-lineno">618</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
676 |
<a name="L619"></a><tt class="py-lineno">619</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">check_abbreviation_unique</tt><tt class="py-op">(</tt><tt class="py-name">abbr</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
677 |
<a name="L620"></a><tt class="py-lineno">620</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">"The specified abbreviation is already in use"</tt><tt class="py-op">)</tt> </tt>
|
|
678 |
<a name="L621"></a><tt class="py-lineno">621</tt> <tt class="py-line"> </tt>
|
|
679 |
<a name="L622"></a><tt class="py-lineno">622</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">model</tt><tt class="py-op">.</tt><tt class="py-name">Phrase</tt><tt class="py-op">(</tt><tt class="py-name">description</tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
|
680 |
<a name="L623"></a><tt class="py-lineno">623</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">modes</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">model</tt><tt class="py-op">.</tt><tt class="py-name">TriggerMode</tt><tt class="py-op">.</tt><tt class="py-name">ABBREVIATION</tt><tt class="py-op">)</tt> </tt>
|
|
681 |
<a name="L624"></a><tt class="py-lineno">624</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">abbreviation</tt> <tt class="py-op">=</tt> <tt class="py-name">abbr</tt> </tt>
|
|
682 |
<a name="L625"></a><tt class="py-lineno">625</tt> <tt class="py-line"> <tt class="py-name">folder</tt><tt class="py-op">.</tt><tt class="py-name">add_item</tt><tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">)</tt> </tt>
|
|
683 |
<a name="L626"></a><tt class="py-lineno">626</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">config_altered</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
684 |
</div><a name="L627"></a><tt class="py-lineno">627</tt> <tt class="py-line"> </tt>
|
|
685 |
<a name="Engine.create_hotkey"></a><div id="Engine.create_hotkey-def"><a name="L628"></a><tt class="py-lineno">628</tt> <a class="py-toggle" href="#" id="Engine.create_hotkey-toggle" onclick="return toggle('Engine.create_hotkey');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#create_hotkey">create_hotkey</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">folder</tt><tt class="py-op">,</tt> <tt class="py-param">description</tt><tt class="py-op">,</tt> <tt class="py-param">modifiers</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
686 |
</div><div id="Engine.create_hotkey-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Engine.create_hotkey-expanded"><a name="L629"></a><tt class="py-lineno">629</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
687 |
<a name="L630"></a><tt class="py-lineno">630</tt> <tt class="py-line"><tt class="py-docstring"> Create a text hotkey.</tt> </tt>
|
|
688 |
<a name="L631"></a><tt class="py-lineno">631</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
689 |
<a name="L632"></a><tt class="py-lineno">632</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.create_hotkey(folder, description, modifiers, key, contents)}</tt> </tt>
|
|
690 |
<a name="L633"></a><tt class="py-lineno">633</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
691 |
<a name="L634"></a><tt class="py-lineno">634</tt> <tt class="py-line"><tt class="py-docstring"> When the given hotkey is pressed, it will be replaced with the given</tt> </tt>
|
|
692 |
<a name="L635"></a><tt class="py-lineno">635</tt> <tt class="py-line"><tt class="py-docstring"> text. Modifiers must be given as a list of strings, with the following</tt> </tt>
|
|
693 |
<a name="L636"></a><tt class="py-lineno">636</tt> <tt class="py-line"><tt class="py-docstring"> values permitted:</tt> </tt>
|
|
694 |
<a name="L637"></a><tt class="py-lineno">637</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
695 |
<a name="L638"></a><tt class="py-lineno">638</tt> <tt class="py-line"><tt class="py-docstring"> <control></tt> </tt>
|
|
696 |
<a name="L639"></a><tt class="py-lineno">639</tt> <tt class="py-line"><tt class="py-docstring"> <alt></tt> </tt>
|
|
697 |
<a name="L640"></a><tt class="py-lineno">640</tt> <tt class="py-line"><tt class="py-docstring"> <super></tt> </tt>
|
|
698 |
<a name="L641"></a><tt class="py-lineno">641</tt> <tt class="py-line"><tt class="py-docstring"> <shift></tt> </tt>
|
|
699 |
<a name="L642"></a><tt class="py-lineno">642</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
700 |
<a name="L643"></a><tt class="py-lineno">643</tt> <tt class="py-line"><tt class="py-docstring"> The key must be an unshifted character (i.e. lowercase)</tt> </tt>
|
|
701 |
<a name="L644"></a><tt class="py-lineno">644</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
702 |
<a name="L645"></a><tt class="py-lineno">645</tt> <tt class="py-line"><tt class="py-docstring"> @param folder: folder to place the abbreviation in, retrieved using C{engine.get_folder()}</tt> </tt>
|
|
703 |
<a name="L646"></a><tt class="py-lineno">646</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description for the phrase</tt> </tt>
|
|
704 |
<a name="L647"></a><tt class="py-lineno">647</tt> <tt class="py-line"><tt class="py-docstring"> @param modifiers: modifiers to use with the hotkey (as a list)</tt> </tt>
|
|
705 |
<a name="L648"></a><tt class="py-lineno">648</tt> <tt class="py-line"><tt class="py-docstring"> @param key: the hotkey</tt> </tt>
|
|
706 |
<a name="L649"></a><tt class="py-lineno">649</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: the expansion text</tt> </tt>
|
|
707 |
<a name="L650"></a><tt class="py-lineno">650</tt> <tt class="py-line"><tt class="py-docstring"> @raises Exception: if the specified hotkey is not unique</tt> </tt>
|
|
708 |
<a name="L651"></a><tt class="py-lineno">651</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
709 |
<a name="L652"></a><tt class="py-lineno">652</tt> <tt class="py-line"> <tt class="py-name">modifiers</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
710 |
<a name="L653"></a><tt class="py-lineno">653</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">check_hotkey_unique</tt><tt class="py-op">(</tt><tt class="py-name">modifiers</tt><tt class="py-op">,</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
711 |
<a name="L654"></a><tt class="py-lineno">654</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">"The specified hotkey and modifier combination is already in use"</tt><tt class="py-op">)</tt> </tt>
|
|
712 |
<a name="L655"></a><tt class="py-lineno">655</tt> <tt class="py-line"> </tt>
|
|
713 |
<a name="L656"></a><tt class="py-lineno">656</tt> <tt class="py-line"> <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">model</tt><tt class="py-op">.</tt><tt class="py-name">Phrase</tt><tt class="py-op">(</tt><tt class="py-name">description</tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
|
|
714 |
<a name="L657"></a><tt class="py-lineno">657</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">modes</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">model</tt><tt class="py-op">.</tt><tt class="py-name">TriggerMode</tt><tt class="py-op">.</tt><tt class="py-name">HOTKEY</tt><tt class="py-op">)</tt> </tt>
|
|
715 |
<a name="L658"></a><tt class="py-lineno">658</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">set_hotkey</tt><tt class="py-op">(</tt><tt class="py-name">modifiers</tt><tt class="py-op">,</tt> <tt class="py-name">key</tt><tt class="py-op">)</tt> </tt>
|
|
716 |
<a name="L659"></a><tt class="py-lineno">659</tt> <tt class="py-line"> <tt class="py-name">folder</tt><tt class="py-op">.</tt><tt class="py-name">add_item</tt><tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">)</tt> </tt>
|
|
717 |
<a name="L660"></a><tt class="py-lineno">660</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">config_altered</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
|
|
718 |
</div><a name="L661"></a><tt class="py-lineno">661</tt> <tt class="py-line"> </tt>
|
|
719 |
<a name="Engine.run_script"></a><div id="Engine.run_script-def"><a name="L662"></a><tt class="py-lineno">662</tt> <a class="py-toggle" href="#" id="Engine.run_script-toggle" onclick="return toggle('Engine.run_script');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#run_script">run_script</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">description</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
720 |
</div><div id="Engine.run_script-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Engine.run_script-expanded"><a name="L663"></a><tt class="py-lineno">663</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
721 |
<a name="L664"></a><tt class="py-lineno">664</tt> <tt class="py-line"><tt class="py-docstring"> Run an existing script using its description to look it up</tt> </tt>
|
|
722 |
<a name="L665"></a><tt class="py-lineno">665</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
723 |
<a name="L666"></a><tt class="py-lineno">666</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.run_script(description)}</tt> </tt>
|
|
724 |
<a name="L667"></a><tt class="py-lineno">667</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
725 |
<a name="L668"></a><tt class="py-lineno">668</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description of the script to run</tt> </tt>
|
|
726 |
<a name="L669"></a><tt class="py-lineno">669</tt> <tt class="py-line"><tt class="py-docstring"> @raises Exception: if the specified script does not exist</tt> </tt>
|
|
727 |
<a name="L670"></a><tt class="py-lineno">670</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
728 |
<a name="L671"></a><tt class="py-lineno">671</tt> <tt class="py-line"> <tt class="py-name">targetScript</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
|
|
729 |
<a name="L672"></a><tt class="py-lineno">672</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">allItems</tt><tt class="py-op">:</tt> </tt>
|
|
730 |
<a name="L673"></a><tt class="py-lineno">673</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">item</tt><tt class="py-op">.</tt><tt class="py-name">description</tt> <tt class="py-op">==</tt> <tt class="py-name">description</tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">Script</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
731 |
<a name="L674"></a><tt class="py-lineno">674</tt> <tt class="py-line"> <tt class="py-name">targetScript</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt> </tt>
|
|
732 |
<a name="L675"></a><tt class="py-lineno">675</tt> <tt class="py-line"> </tt>
|
|
733 |
<a name="L676"></a><tt class="py-lineno">676</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">targetScript</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
|
|
734 |
<a name="L677"></a><tt class="py-lineno">677</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">runner</tt><tt class="py-op">.</tt><tt class="py-name">execute</tt><tt class="py-op">(</tt><tt class="py-name">targetScript</tt><tt class="py-op">,</tt> <tt class="py-string">""</tt><tt class="py-op">)</tt> </tt>
|
|
735 |
<a name="L678"></a><tt class="py-lineno">678</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
|
|
736 |
<a name="L679"></a><tt class="py-lineno">679</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">"No script with description '%s' found"</tt> <tt class="py-op">%</tt> <tt class="py-name">description</tt><tt class="py-op">)</tt> </tt>
|
|
737 |
</div></div><a name="L680"></a><tt class="py-lineno">680</tt> <tt class="py-line"> </tt><script type="text/javascript">
|
588 | 738 |
<!--
|
589 | 739 |
expandto(location.href);
|
590 | 740 |
// -->
|
|
617 | 767 |
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
618 | 768 |
<tr>
|
619 | 769 |
<td align="left" class="footer">
|
620 | |
Generated by Epydoc 3.0.1 on Sat Nov 28 12:25:37 2009
|
|
770 |
Generated by Epydoc 3.0.1 on Fri Jan 8 16:51:02 2010
|
621 | 771 |
</td>
|
622 | 772 |
<td align="right" class="footer">
|
623 | 773 |
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|