1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>lib.scripting</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package lib ::
Module scripting
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="lib.scripting-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="lib.scripting-module.html">Module lib.scripting</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># -*- coding: utf-8 -*-</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) 2011 Chris Dekter</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<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>
<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>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># the Free Software Foundation, either version 3 of the License, or</tt> </tt>
<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>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<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,</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># but WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
<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</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># GNU General Public License for more details.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<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>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"># along with this program. If not, see <http://www.gnu.org/licenses/>.</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</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>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">common</tt><tt class="py-comment">#, model, iomediator</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-comment">#if common.USING_QT:</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-comment"># from PyQt4.QtGui import QClipboard, QApplication</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-comment">#else:</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-comment"># from gi.repository import Gtk, Gdk</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> </tt>
<a name="Keyboard"></a><div id="Keyboard-def"><a name="L25"></a><tt class="py-lineno"> 25</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>
</div><div id="Keyboard-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Keyboard-expanded"><a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to the keyboard for event generation.</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> </tt>
<a name="Keyboard.__init__"></a><div id="Keyboard.__init__-def"><a name="L30"></a><tt class="py-lineno"> 30</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>
</div><div id="Keyboard.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Keyboard.__init__-expanded"><a name="L31"></a><tt class="py-lineno"> 31</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>
</div><a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> </tt>
<a name="Keyboard.send_keys"></a><div id="Keyboard.send_keys-def"><a name="L33"></a><tt class="py-lineno"> 33</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>
</div><div id="Keyboard.send_keys-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Keyboard.send_keys-expanded"><a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> Send a sequence of keys via keyboard events</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.send_keys(keyString)}</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> @param keyString: string of keys (including special keys) to send</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</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">interface</tt><tt class="py-op">.</tt><tt class="py-name">begin_send</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</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>
<a name="L43"></a><tt class="py-lineno"> 43</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">interface</tt><tt class="py-op">.</tt><tt class="py-name">finish_send</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> </tt>
<a name="Keyboard.send_key"></a><div id="Keyboard.send_key-def"><a name="L45"></a><tt class="py-lineno"> 45</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>
</div><div id="Keyboard.send_key-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Keyboard.send_key-expanded"><a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> Send a keyboard event</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.send_key(key, repeat=1)}</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> @param key: they key to be sent (e.g. "s" or "<enter>")</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> @param repeat: number of times to repeat the key event</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</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">xrange</tt><tt class="py-op">(</tt><tt class="py-name">repeat</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</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>
<a name="L56"></a><tt class="py-lineno"> 56</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>
</div><a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> </tt>
<a name="Keyboard.press_key"></a><div id="Keyboard.press_key-def"><a name="L58"></a><tt class="py-lineno"> 58</tt> <a class="py-toggle" href="#" id="Keyboard.press_key-toggle" onclick="return toggle('Keyboard.press_key');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#press_key">press_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-op">:</tt> </tt>
</div><div id="Keyboard.press_key-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Keyboard.press_key-expanded"><a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> Send a key down event</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.press_key(key)}</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> The key will be treated as down until a matching release_key() is sent.</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> @param key: they key to be pressed (e.g. "s" or "<enter>")</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</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-1" class="py-name" targets="Method lib.scripting.Keyboard.press_key()=lib.scripting.Keyboard-class.html#press_key"><a title="lib.scripting.Keyboard.press_key" class="py-name" href="#" onclick="return doclink('link-1', 'press_key', 'link-1');">press_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>
</div><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> </tt>
<a name="Keyboard.release_key"></a><div id="Keyboard.release_key-def"><a name="L69"></a><tt class="py-lineno"> 69</tt> <a class="py-toggle" href="#" id="Keyboard.release_key-toggle" onclick="return toggle('Keyboard.release_key');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#release_key">release_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-op">:</tt> </tt>
</div><div id="Keyboard.release_key-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Keyboard.release_key-expanded"><a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> Send a key up event</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.release_key(key)}</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> If the specified key was not made down using press_key(), the event will be </tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> ignored.</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> @param key: they key to be released (e.g. "s" or "<enter>")</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</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-2" class="py-name" targets="Method lib.scripting.Keyboard.release_key()=lib.scripting.Keyboard-class.html#release_key"><a title="lib.scripting.Keyboard.release_key" class="py-name" href="#" onclick="return doclink('link-2', 'release_key', 'link-2');">release_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>
</div><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> </tt>
<a name="Keyboard.fake_keypress"></a><div id="Keyboard.fake_keypress-def"><a name="L81"></a><tt class="py-lineno"> 81</tt> <a class="py-toggle" href="#" id="Keyboard.fake_keypress-toggle" onclick="return toggle('Keyboard.fake_keypress');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#fake_keypress">fake_keypress</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>
</div><div id="Keyboard.fake_keypress-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Keyboard.fake_keypress-expanded"><a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> Fake a keypress</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.fake_keypress(key, repeat=1)}</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> Uses XTest to 'fake' a keypress. This is useful to send keypresses to some</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> applications which won't respond to keyboard.send_key()</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> @param key: they key to be sent (e.g. "s" or "<enter>")</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> @param repeat: number of times to repeat the key event</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</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">xrange</tt><tt class="py-op">(</tt><tt class="py-name">repeat</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</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-3" class="py-name" targets="Method lib.scripting.Keyboard.fake_keypress()=lib.scripting.Keyboard-class.html#fake_keypress"><a title="lib.scripting.Keyboard.fake_keypress" class="py-name" href="#" onclick="return doclink('link-3', 'fake_keypress', 'link-3');">fake_keypress</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>
</div><a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> </tt>
<a name="Keyboard.wait_for_keypress"></a><div id="Keyboard.wait_for_keypress-def"><a name="L96"></a><tt class="py-lineno"> 96</tt> <a class="py-toggle" href="#" id="Keyboard.wait_for_keypress-toggle" onclick="return toggle('Keyboard.wait_for_keypress');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Keyboard-class.html#wait_for_keypress">wait_for_keypress</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">modifiers</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-param">timeOut</tt><tt class="py-op">=</tt><tt class="py-number">10.0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Keyboard.wait_for_keypress-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Keyboard.wait_for_keypress-expanded"><a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> Wait for a keypress or key combination</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{keyboard.wait_for_keypress(self, key, modifiers=[], timeOut=10.0)}</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"><tt class="py-docstring"> Note: this function cannot be used to wait for modifier keys on their own</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"><tt class="py-docstring"> @param key: they key to wait for</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"><tt class="py-docstring"> @param modifiers: list of modifiers that should be pressed with the key</tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: maximum time, in seconds, to wait for the keypress to occur</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-name">w</tt> <tt class="py-op">=</tt> <tt class="py-name">iomediator</tt><tt class="py-op">.</tt><tt class="py-name">Waiter</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">modifiers</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">timeOut</tt><tt class="py-op">)</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"> <tt class="py-name">w</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"> </tt>
<a name="Mouse"></a><div id="Mouse-def"><a name="L112"></a><tt class="py-lineno"> 112</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>
</div><div id="Mouse-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Mouse-expanded"><a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to send mouse clicks</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="Mouse.__init__"></a><div id="Mouse.__init__-def"><a name="L116"></a><tt class="py-lineno"> 116</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>
</div><div id="Mouse.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Mouse.__init__-expanded"><a name="L117"></a><tt class="py-lineno"> 117</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>
</div><a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> </tt>
<a name="Mouse.click_relative"></a><div id="Mouse.click_relative-def"><a name="L119"></a><tt class="py-lineno"> 119</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>
</div><div id="Mouse.click_relative-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Mouse.click_relative-expanded"><a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-docstring"> Send a mouse click relative to the active window</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.click_relative(x, y, button)}</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"><tt class="py-docstring"> @param x: x-coordinate in pixels, relative to upper left corner of window</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-docstring"> @param y: y-coordinate in pixels, relative to upper left corner of window</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"><tt class="py-docstring"> @param button: mouse button to simulate (left=1, middle=2, right=3)</tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</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>
</div><a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> </tt>
<a name="Mouse.click_relative_self"></a><div id="Mouse.click_relative_self-def"><a name="L131"></a><tt class="py-lineno"> 131</tt> <a class="py-toggle" href="#" id="Mouse.click_relative_self-toggle" onclick="return toggle('Mouse.click_relative_self');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#click_relative_self">click_relative_self</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>
</div><div id="Mouse.click_relative_self-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Mouse.click_relative_self-expanded"><a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"><tt class="py-docstring"> Send a mouse click relative to the current mouse position</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.click_relative_self(x, y, button)}</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"><tt class="py-docstring"> @param x: x-offset in pixels, relative to current mouse position</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"><tt class="py-docstring"> @param y: y-offset in pixels, relative to current mouse position</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"><tt class="py-docstring"> @param button: mouse button to simulate (left=1, middle=2, right=3)</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</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_relative</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>
</div><a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> </tt>
<a name="Mouse.click_absolute"></a><div id="Mouse.click_absolute-def"><a name="L143"></a><tt class="py-lineno"> 143</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>
</div><div id="Mouse.click_absolute-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Mouse.click_absolute-expanded"><a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"><tt class="py-docstring"> Send a mouse click relative to the screen (absolute)</tt> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.click_absolute(x, y, button)}</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"><tt class="py-docstring"> @param x: x-coordinate in pixels, relative to upper left corner of window</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"><tt class="py-docstring"> @param y: y-coordinate in pixels, relative to upper left corner of window</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"><tt class="py-docstring"> @param button: mouse button to simulate (left=1, middle=2, right=3)</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</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>
</div><a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> </tt>
<a name="Mouse.wait_for_click"></a><div id="Mouse.wait_for_click-def"><a name="L155"></a><tt class="py-lineno"> 155</tt> <a class="py-toggle" href="#" id="Mouse.wait_for_click-toggle" onclick="return toggle('Mouse.wait_for_click');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Mouse-class.html#wait_for_click">wait_for_click</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">button</tt><tt class="py-op">,</tt> <tt class="py-param">timeOut</tt><tt class="py-op">=</tt><tt class="py-number">10.0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Mouse.wait_for_click-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Mouse.wait_for_click-expanded"><a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"> Wait for a mouse click</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{mouse.wait_for_click(self, button, timeOut=10.0)}</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-docstring"> @param button: they mouse button click to wait for as a button number, 1-9</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: maximum time, in seconds, to wait for the keypress to occur</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"> <tt class="py-name">button</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">button</tt><tt class="py-op">)</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"> <tt class="py-name">w</tt> <tt class="py-op">=</tt> <tt class="py-name">iomediator</tt><tt class="py-op">.</tt><tt class="py-name">Waiter</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">button</tt><tt class="py-op">,</tt> <tt class="py-name">timeOut</tt><tt class="py-op">)</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> <tt class="py-name">w</tt><tt class="py-op">.</tt><tt class="py-name">wait</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"> </tt>
<a name="Store"></a><div id="Store-def"><a name="L169"></a><tt class="py-lineno"> 169</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>
</div><div id="Store-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Store-expanded"><a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-docstring"> Allows persistent storage of values between invocations of the script.</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> </tt>
<a name="Store.set_value"></a><div id="Store.set_value-def"><a name="L174"></a><tt class="py-lineno"> 174</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>
</div><div id="Store.set_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Store.set_value-expanded"><a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-docstring"> Store a value</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.set_value(key, value)}</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</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>
</div><a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> </tt>
<a name="Store.get_value"></a><div id="Store.get_value-def"><a name="L182"></a><tt class="py-lineno"> 182</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>
</div><div id="Store.get_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Store.get_value-expanded"><a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"> Get a value</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.get_value(key)}</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</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>
</div><a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> </tt>
<a name="Store.remove_value"></a><div id="Store.remove_value-def"><a name="L190"></a><tt class="py-lineno"> 190</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>
</div><div id="Store.remove_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Store.remove_value-expanded"><a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-docstring"> Remove a value</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.remove_value(key)}</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</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>
</div><a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"> </tt>
<a name="Store.set_global_value"></a><div id="Store.set_global_value-def"><a name="L198"></a><tt class="py-lineno"> 198</tt> <a class="py-toggle" href="#" id="Store.set_global_value-toggle" onclick="return toggle('Store.set_global_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#set_global_value">set_global_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>
</div><div id="Store.set_global_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Store.set_global_value-expanded"><a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-docstring"> Store a global value</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.set_global_value(key, value)}</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"><tt class="py-docstring"> The value stored with this method will be available to all scripts.</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> <tt id="link-4" class="py-name" targets="Class lib.scripting.Store=lib.scripting.Store-class.html"><a title="lib.scripting.Store" class="py-name" href="#" onclick="return doclink('link-4', 'Store', 'link-4');">Store</a></tt><tt class="py-op">.</tt><tt class="py-name">GLOBALS</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>
</div><a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> </tt>
<a name="Store.get_global_value"></a><div id="Store.get_global_value-def"><a name="L208"></a><tt class="py-lineno"> 208</tt> <a class="py-toggle" href="#" id="Store.get_global_value-toggle" onclick="return toggle('Store.get_global_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#get_global_value">get_global_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>
</div><div id="Store.get_global_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Store.get_global_value-expanded"><a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"><tt class="py-docstring"> Get a global value</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.get_global_value(key)}</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</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">GLOBALS</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
</div><a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> </tt>
<a name="Store.remove_global_value"></a><div id="Store.remove_global_value-def"><a name="L216"></a><tt class="py-lineno"> 216</tt> <a class="py-toggle" href="#" id="Store.remove_global_value-toggle" onclick="return toggle('Store.remove_global_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Store-class.html#remove_global_value">remove_global_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>
</div><div id="Store.remove_global_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Store.remove_global_value-expanded"><a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"><tt class="py-docstring"> Remove a global value</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{store.remove_global_value(key)}</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</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">GLOBALS</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> </tt>
</div></div><a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> </tt>
<a name="QtDialog"></a><div id="QtDialog-def"><a name="L225"></a><tt class="py-lineno"> 225</tt> <a class="py-toggle" href="#" id="QtDialog-toggle" onclick="return toggle('QtDialog');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.QtDialog-class.html">QtDialog</a><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="QtDialog-expanded"><a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</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>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"><tt class="py-docstring"> This version uses KDialog to integrate well with KDE. To pass additional arguments to KDialog that are </tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"><tt class="py-docstring"> not specifically handled, use keyword arguments. For example, to pass the --geometry argument to KDialog</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-docstring"> to specify the desired size of the dialog, pass C{geometry="700x400"} as one of the parameters. All</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"> keyword arguments must be given as strings.</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"> A note on exit codes: an exit code of 0 indicates that the user clicked OK.</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"> </tt>
<a name="QtDialog._run_kdialog"></a><div id="QtDialog._run_kdialog-def"><a name="L237"></a><tt class="py-lineno"> 237</tt> <a class="py-toggle" href="#" id="QtDialog._run_kdialog-toggle" onclick="return toggle('QtDialog._run_kdialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-class.html#_run_kdialog">_run_kdialog</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-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog._run_kdialog-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog._run_kdialog-expanded"><a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">k</tt><tt class="py-op">,</tt> <tt class="py-name">v</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"--"</tt> <tt class="py-op">+</tt> <tt class="py-name">k</tt><tt class="py-op">)</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">)</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</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>
<a name="L243"></a><tt class="py-lineno"> 243</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>
<a name="L244"></a><tt class="py-lineno"> 244</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>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</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>
</div><a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> </tt>
<a name="QtDialog.info_dialog"></a><div id="QtDialog.info_dialog-def"><a name="L248"></a><tt class="py-lineno"> 248</tt> <a class="py-toggle" href="#" id="QtDialog.info_dialog-toggle" onclick="return toggle('QtDialog.info_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-class.html#info_dialog">info_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">"Information"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.info_dialog-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.info_dialog-expanded"><a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"><tt class="py-docstring"> Show an information dialog</tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.info_dialog(title="Information", message="", **kwargs)}</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed in the dialog</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user input</tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</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-5" class="py-name" targets="Method lib.scripting.QtDialog._run_kdialog()=lib.scripting.QtDialog-class.html#_run_kdialog"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-5', '_run_kdialog', 'link-5');">_run_kdialog</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">"--msgbox"</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">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"> </tt>
<a name="QtDialog.input_dialog"></a><div id="QtDialog.input_dialog-def"><a name="L261"></a><tt class="py-lineno"> 261</tt> <a class="py-toggle" href="#" id="QtDialog.input_dialog-toggle" onclick="return toggle('QtDialog.input_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.input_dialog-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.input_dialog-expanded"><a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"><tt class="py-docstring"> Show an input dialog</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.input_dialog(title="Enter a value", message="Enter a value", default="", **kwargs)}</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the input box</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value for the input box</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user input</tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</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.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-6', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> </tt>
<a name="QtDialog.password_dialog"></a><div id="QtDialog.password_dialog-def"><a name="L275"></a><tt class="py-lineno"> 275</tt> <a class="py-toggle" href="#" id="QtDialog.password_dialog-toggle" onclick="return toggle('QtDialog.password_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.password_dialog-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.password_dialog-expanded"><a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"><tt class="py-docstring"> Show a password input dialog</tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.password_dialog(title="Enter password", message="Enter password", **kwargs)}</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the password input box</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user input</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</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.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-7', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> </tt>
<a name="QtDialog.combo_menu"></a><div id="QtDialog.combo_menu-def"><a name="L288"></a><tt class="py-lineno"> 288</tt> <a class="py-toggle" href="#" id="QtDialog.combo_menu-toggle" onclick="return toggle('QtDialog.combo_menu');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.combo_menu-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.combo_menu-expanded"><a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"><tt class="py-docstring"> Show a combobox menu</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.combo_menu(options, title="Choose an option", message="Choose an option", **kwargs)}</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the combobox</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user choice</tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</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.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-8', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"> </tt>
<a name="QtDialog.list_menu"></a><div id="QtDialog.list_menu-def"><a name="L302"></a><tt class="py-lineno"> 302</tt> <a class="py-toggle" href="#" id="QtDialog.list_menu-toggle" onclick="return toggle('QtDialog.list_menu');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.list_menu-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.list_menu-expanded"><a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-docstring"> Show a single-selection list menu</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</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, **kwargs)}</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value to be selected</tt> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user choice</tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</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>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</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>
<a name="L319"></a><tt class="py-lineno"> 319</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>
<a name="L320"></a><tt class="py-lineno"> 320</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>
<a name="L321"></a><tt class="py-lineno"> 321</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>
<a name="L322"></a><tt class="py-lineno"> 322</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>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</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>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</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-9" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-9', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</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>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</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>
</div><a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> </tt>
<a name="QtDialog.list_menu_multi"></a><div id="QtDialog.list_menu_multi-def"><a name="L332"></a><tt class="py-lineno"> 332</tt> <a class="py-toggle" href="#" id="QtDialog.list_menu_multi-toggle" onclick="return toggle('QtDialog.list_menu_multi');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.list_menu_multi-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.list_menu_multi-expanded"><a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"><tt class="py-docstring"> Show a multiple-selection list menu</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</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=[], **kwargs)}</tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"><tt class="py-docstring"> @param defaults: list of default values to be selected</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user choice</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</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>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</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>
<a name="L349"></a><tt class="py-lineno"> 349</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>
<a name="L350"></a><tt class="py-lineno"> 350</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>
<a name="L351"></a><tt class="py-lineno"> 351</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>
<a name="L352"></a><tt class="py-lineno"> 352</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>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</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>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-name">optionNum</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</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-10" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-10', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</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>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</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>
<a name="L361"></a><tt class="py-lineno"> 361</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>
<a name="L362"></a><tt class="py-lineno"> 362</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>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</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>
</div><a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> </tt>
<a name="QtDialog.open_file"></a><div id="QtDialog.open_file-def"><a name="L366"></a><tt class="py-lineno"> 366</tt> <a class="py-toggle" href="#" id="QtDialog.open_file-toggle" onclick="return toggle('QtDialog.open_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.open_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.open_file-expanded"><a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-docstring"> Show an Open File dialog</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.open_file(title="Open File", initialDir="~", fileTypes="*|All Files", rememberAs=None, **kwargs)}</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"><tt class="py-docstring"> @param initialDir: starting directory for the file dialog</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-docstring"> @param fileTypes: file type filter expression</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</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>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and file path</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</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>
<a name="L380"></a><tt class="py-lineno"> 380</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.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-11', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</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.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-12', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> </tt>
<a name="QtDialog.save_file"></a><div id="QtDialog.save_file-def"><a name="L384"></a><tt class="py-lineno"> 384</tt> <a class="py-toggle" href="#" id="QtDialog.save_file-toggle" onclick="return toggle('QtDialog.save_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.save_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.save_file-expanded"><a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"> Show a Save As dialog</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.save_file(title="Save As", initialDir="~", fileTypes="*|All Files", rememberAs=None, **kwargs)}</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"><tt class="py-docstring"> @param initialDir: starting directory for the file dialog</tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"><tt class="py-docstring"> @param fileTypes: file type filter expression</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</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>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and file path</tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</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>
<a name="L398"></a><tt class="py-lineno"> 398</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-13" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-13', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</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-14" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-14', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> </tt>
<a name="QtDialog.choose_directory"></a><div id="QtDialog.choose_directory-def"><a name="L402"></a><tt class="py-lineno"> 402</tt> <a class="py-toggle" href="#" id="QtDialog.choose_directory-toggle" onclick="return toggle('QtDialog.choose_directory');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.choose_directory-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.choose_directory-expanded"><a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"><tt class="py-docstring"> Show a Directory Chooser dialog</tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.choose_directory(title="Select Directory", initialDir="~", rememberAs=None, **kwargs)}</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"><tt class="py-docstring"> @param initialDir: starting directory for the directory chooser dialog</tt> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</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>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and chosen path</tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</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>
<a name="L415"></a><tt class="py-lineno"> 415</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-15" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-15', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</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-16" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-16', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> </tt>
<a name="QtDialog.choose_colour"></a><div id="QtDialog.choose_colour-def"><a name="L419"></a><tt class="py-lineno"> 419</tt> <a class="py-toggle" href="#" id="QtDialog.choose_colour-toggle" onclick="return toggle('QtDialog.choose_colour');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.choose_colour-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.choose_colour-expanded"><a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"><tt class="py-docstring"> Show a Colour Chooser dialog</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.choose_colour(title="Select Colour")}</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and colour</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</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-17" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-17', '_run_kdialog', 'link-5');">_run_kdialog</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> </tt>
<a name="QtDialog.calendar"></a><div id="QtDialog.calendar-def"><a name="L431"></a><tt class="py-lineno"> 431</tt> <a class="py-toggle" href="#" id="QtDialog.calendar-toggle" onclick="return toggle('QtDialog.calendar');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtDialog-class.html#calendar">calendar</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">"Choose a date"</tt><tt class="py-op">,</tt> <tt class="py-param">format</tt><tt class="py-op">=</tt><tt class="py-string">"%Y-%m-%d"</tt><tt class="py-op">,</tt> <tt class="py-param">date</tt><tt class="py-op">=</tt><tt class="py-string">"today"</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="QtDialog.calendar-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtDialog.calendar-expanded"><a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"><tt class="py-docstring"> Show a calendar dialog</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.calendar_dialog(title="Choose a date", format="%Y-%m-%d", date="YYYY-MM-DD", **kwargs)}</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"><tt class="py-docstring"> Note: the format and date parameters are not currently used</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"><tt class="py-docstring"> @param format: format of date to be returned</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"><tt class="py-docstring"> @param date: initial date as YYYY-MM-DD, otherwise today</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and date</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</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-18" class="py-name"><a title="lib.scripting.QtDialog._run_kdialog" class="py-name" href="#" onclick="return doclink('link-18', '_run_kdialog', 'link-5');">_run_kdialog</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">"--calendar"</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> </tt>
<a name="System"></a><div id="System-def"><a name="L448"></a><tt class="py-lineno"> 448</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>
</div><div id="System-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="System-expanded"><a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"><tt class="py-docstring"> Simplified access to some system commands.</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> </tt>
<a name="System.exec_command"></a><div id="System.exec_command-def"><a name="L453"></a><tt class="py-lineno"> 453</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-param">getOutput</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="System.exec_command-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="System.exec_command-expanded"><a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-docstring"> Execute a shell command</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{system.exec_command(command, getOutput=True)}</tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-docstring"> Set getOutput to False if the command does not exit and return immediately. Otherwise</tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"> AutoKey will not respond to any hotkeys/abbreviations etc until the process started</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-docstring"> by the command exits.</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-docstring"> @param command: command to be executed (including any arguments) - e.g. "ls -l"</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"><tt class="py-docstring"> @param getOutput: whether to capture the (stdout) output of the command</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"><tt class="py-docstring"> @raise subprocess.CalledProcessError: if the command returns a non-zero exit code</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">getOutput</tt><tt class="py-op">:</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</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>
<a name="L469"></a><tt class="py-lineno"> 469</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>
<a name="L470"></a><tt class="py-lineno"> 470</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>
<a name="L471"></a><tt class="py-lineno"> 471</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>
<a name="L472"></a><tt class="py-lineno"> 472</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>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">output</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <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>
</div><a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> </tt>
<a name="System.create_file"></a><div id="System.create_file-def"><a name="L478"></a><tt class="py-lineno"> 478</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>
</div><div id="System.create_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="System.create_file-expanded"><a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"><tt class="py-docstring"> Create a file with contents</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{system.create_file(fileName, contents="")}</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"><tt class="py-docstring"> @param fileName: full path to the file to be created</tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: contents to insert into the file</tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</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>
<a name="L488"></a><tt class="py-lineno"> 488</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>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-19" 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-19', 'close', 'link-19');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> </tt>
<a name="GtkDialog"></a><div id="GtkDialog-def"><a name="L492"></a><tt class="py-lineno"> 492</tt> <a class="py-toggle" href="#" id="GtkDialog-toggle" onclick="return toggle('GtkDialog');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-class.html">GtkDialog</a><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="GtkDialog-expanded"><a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</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>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"><tt class="py-docstring"> This version uses Zenity to integrate well with GNOME. To pass additional arguments to Zenity that are </tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"><tt class="py-docstring"> not specifically handled, use keyword arguments. For example, to pass the --timeout argument to Zenity</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-docstring"> pass C{timeout="15"} as one of the parameters. All keyword arguments must be given as strings.</tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"><tt class="py-docstring"> A note on exit codes: an exit code of 0 indicates that the user clicked OK.</tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> </tt>
<a name="GtkDialog._run_zenity"></a><div id="GtkDialog._run_zenity-def"><a name="L503"></a><tt class="py-lineno"> 503</tt> <a class="py-toggle" href="#" id="GtkDialog._run_zenity-toggle" onclick="return toggle('GtkDialog._run_zenity');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-class.html#_run_zenity">_run_zenity</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-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog._run_zenity-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog._run_zenity-expanded"><a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">k</tt><tt class="py-op">,</tt> <tt class="py-name">v</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"--"</tt> <tt class="py-op">+</tt> <tt class="py-name">k</tt><tt class="py-op">)</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">)</tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</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>
<a name="L509"></a><tt class="py-lineno"> 509</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>
<a name="L510"></a><tt class="py-lineno"> 510</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>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</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>
</div><a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.info_dialog"></a><div id="GtkDialog.info_dialog-def"><a name="L514"></a><tt class="py-lineno"> 514</tt> <a class="py-toggle" href="#" id="GtkDialog.info_dialog-toggle" onclick="return toggle('GtkDialog.info_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-class.html#info_dialog">info_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">"Information"</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.info_dialog-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.info_dialog-expanded"><a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"><tt class="py-docstring"> Show an information dialog</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.info_dialog(title="Information", message="", **kwargs)}</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed in the dialog</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user input</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</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-20" class="py-name" targets="Method lib.scripting.GtkDialog._run_zenity()=lib.scripting.GtkDialog-class.html#_run_zenity"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-20', '_run_zenity', 'link-20');">_run_zenity</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">"--info"</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-op">,</tt> <tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.input_dialog"></a><div id="GtkDialog.input_dialog-def"><a name="L527"></a><tt class="py-lineno"> 527</tt> <a class="py-toggle" href="#" id="GtkDialog.input_dialog-toggle" onclick="return toggle('GtkDialog.input_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.input_dialog-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.input_dialog-expanded"><a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"><tt class="py-docstring"> Show an input dialog</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.input_dialog(title="Enter a value", message="Enter a value", default="", **kwargs)}</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the input box</tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value for the input box</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user input</tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</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-21" class="py-name"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-21', '_run_zenity', 'link-20');">_run_zenity</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.password_dialog"></a><div id="GtkDialog.password_dialog-def"><a name="L541"></a><tt class="py-lineno"> 541</tt> <a class="py-toggle" href="#" id="GtkDialog.password_dialog-toggle" onclick="return toggle('GtkDialog.password_dialog');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.password_dialog-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.password_dialog-expanded"><a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-docstring"> Show a password input dialog</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.password_dialog(title="Enter password", message="Enter password")}</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the password input box</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user input</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</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-22" class="py-name"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-22', '_run_zenity', 'link-20');">_run_zenity</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> <tt class="py-comment">#def combo_menu(self, options, title="Choose an option", message="Choose an option"):</tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"><tt class="py-string"> Show a combobox menu - not supported by zenity</tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</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>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"><tt class="py-string"> @param options: list of options (strings) for the dialog</tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"><tt class="py-string"> @param title: window title for the dialog</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"><tt class="py-string"> @param message: message displayed above the combobox </tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
</div><a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-comment">#return self._run_zenity(title, ["--combobox", message] + options)</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.list_menu"></a><div id="GtkDialog.list_menu-def"><a name="L566"></a><tt class="py-lineno"> 566</tt> <a class="py-toggle" href="#" id="GtkDialog.list_menu-toggle" onclick="return toggle('GtkDialog.list_menu');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.list_menu-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.list_menu-expanded"><a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"><tt class="py-docstring"> Show a single-selection list menu</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</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, **kwargs)}</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"><tt class="py-docstring"> @param default: default value to be selected</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user choice</tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</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>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-comment">#optionNum = 0</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</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>
<a name="L583"></a><tt class="py-lineno"> 583</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>
<a name="L584"></a><tt class="py-lineno"> 584</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>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</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>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"> <tt class="py-comment">#choices.append(str(optionNum))</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</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>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt class="py-comment">#optionNum += 1</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</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-23" class="py-name"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-23', '_run_zenity', 'link-20');">_run_zenity</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt class="py-comment">#return retCode, choice </tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.list_menu_multi"></a><div id="GtkDialog.list_menu_multi-def"><a name="L596"></a><tt class="py-lineno"> 596</tt> <a class="py-toggle" href="#" id="GtkDialog.list_menu_multi-toggle" onclick="return toggle('GtkDialog.list_menu_multi');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.list_menu_multi-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.list_menu_multi-expanded"><a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"><tt class="py-docstring"> Show a multiple-selection list menu</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</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=[], **kwargs)}</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-docstring"> @param options: list of options (strings) for the dialog</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"><tt class="py-docstring"> @param message: message displayed above the list</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-docstring"> @param defaults: list of default values to be selected</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and user choice</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</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>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-comment">#optionNum = 0</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</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>
<a name="L613"></a><tt class="py-lineno"> 613</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>
<a name="L614"></a><tt class="py-lineno"> 614</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>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</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>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> <tt class="py-comment">#choices.append(str(optionNum))</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</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>
<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> <tt class="py-comment">#optionNum += 1</tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</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"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-24', '_run_zenity', 'link-20');">_run_zenity</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</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-string">'|'</tt><tt class="py-op">)</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-comment">#choices = []</tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> <tt class="py-comment">#for choice in results:</tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> <tt class="py-comment"># choices.append(choice)</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</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">results</tt> </tt>
</div><a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.open_file"></a><div id="GtkDialog.open_file-def"><a name="L631"></a><tt class="py-lineno"> 631</tt> <a class="py-toggle" href="#" id="GtkDialog.open_file-toggle" onclick="return toggle('GtkDialog.open_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.open_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.open_file-expanded"><a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"><tt class="py-docstring"> Show an Open File dialog</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.open_file(title="Open File", **kwargs)}</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and file path</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> <tt class="py-comment">#if rememberAs is not None:</tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> <tt class="py-comment"># return self._run_zenity(title, ["--getopenfilename", initialDir, fileTypes, ":" + rememberAs])</tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"> <tt class="py-comment">#else:</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</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-25" class="py-name"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-25', '_run_zenity', 'link-20');">_run_zenity</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.save_file"></a><div id="GtkDialog.save_file-def"><a name="L646"></a><tt class="py-lineno"> 646</tt> <a class="py-toggle" href="#" id="GtkDialog.save_file-toggle" onclick="return toggle('GtkDialog.save_file');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.save_file-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.save_file-expanded"><a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"><tt class="py-docstring"> Show a Save As dialog</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.save_file(title="Save As", **kwargs)}</tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and file path</tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-comment">#if rememberAs is not None:</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"> <tt class="py-comment"># return self._run_zenity(title, ["--getsavefilename", initialDir, fileTypes, ":" + rememberAs])</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> <tt class="py-comment">#else:</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</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-26" class="py-name"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-26', '_run_zenity', 'link-20');">_run_zenity</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.choose_directory"></a><div id="GtkDialog.choose_directory-def"><a name="L661"></a><tt class="py-lineno"> 661</tt> <a class="py-toggle" href="#" id="GtkDialog.choose_directory-toggle" onclick="return toggle('GtkDialog.choose_directory');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-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 class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.choose_directory-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.choose_directory-expanded"><a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"><tt class="py-docstring"> Show a Directory Chooser dialog</tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.choose_directory(title="Select Directory", **kwargs)}</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and path</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-comment">#if rememberAs is not None:</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-comment"># return self._run_zenity(title, ["--getexistingdirectory", initialDir, ":" + rememberAs])</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> <tt class="py-comment">#else:</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</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-27" class="py-name"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-27', '_run_zenity', 'link-20');">_run_zenity</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 class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> <tt class="py-comment">#def choose_colour(self, title="Select Colour"):</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"><tt class="py-string"> Show a Colour Chooser dialog - not supported by zenity</tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"><tt class="py-string"> Usage: C{dialog.choose_colour(title="Select Colour")}</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"><tt class="py-string"> @param title: window title for the dialog</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
</div><a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt class="py-comment">#return self._run_zenity(title, ["--getcolor"])</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> </tt>
<a name="GtkDialog.calendar"></a><div id="GtkDialog.calendar-def"><a name="L686"></a><tt class="py-lineno"> 686</tt> <a class="py-toggle" href="#" id="GtkDialog.calendar-toggle" onclick="return toggle('GtkDialog.calendar');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkDialog-class.html#calendar">calendar</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">"Choose a date"</tt><tt class="py-op">,</tt> <tt class="py-param">format</tt><tt class="py-op">=</tt><tt class="py-string">"%Y-%m-%d"</tt><tt class="py-op">,</tt> <tt class="py-param">date</tt><tt class="py-op">=</tt><tt class="py-string">"today"</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GtkDialog.calendar-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkDialog.calendar-expanded"><a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"><tt class="py-docstring"> Show a calendar dialog</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{dialog.calendar_dialog(title="Choose a date", format="%Y-%m-%d", date="YYYY-MM-DD", **kwargs)}</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title for the dialog</tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"><tt class="py-docstring"> @param format: format of date to be returned</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"><tt class="py-docstring"> @param date: initial date as YYYY-MM-DD, otherwise today</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"><tt class="py-docstring"> @return: a tuple containing the exit code and date</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, str)}</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">r"[0-9]{4}-[0-9]{2}-[0-9]{2}"</tt><tt class="py-op">,</tt> <tt class="py-name">date</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-name">year</tt> <tt class="py-op">=</tt> <tt class="py-name">date</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">:</tt><tt class="py-number">4</tt><tt class="py-op">]</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-name">month</tt> <tt class="py-op">=</tt> <tt class="py-name">date</tt><tt class="py-op">[</tt><tt class="py-number">5</tt><tt class="py-op">:</tt><tt class="py-number">7</tt><tt class="py-op">]</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt class="py-name">day</tt> <tt class="py-op">=</tt> <tt class="py-name">date</tt><tt class="py-op">[</tt><tt class="py-number">8</tt><tt class="py-op">:</tt><tt class="py-number">10</tt><tt class="py-op">]</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-name">date_args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"--year="</tt> <tt class="py-op">+</tt> <tt class="py-name">year</tt><tt class="py-op">,</tt> <tt class="py-string">"--month="</tt> <tt class="py-op">+</tt> <tt class="py-name">month</tt><tt class="py-op">,</tt> <tt class="py-string">"--day="</tt> <tt class="py-op">+</tt> <tt class="py-name">day</tt><tt class="py-op">]</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"> <tt class="py-name">date_args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</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-28" class="py-name"><a title="lib.scripting.GtkDialog._run_zenity" class="py-name" href="#" onclick="return doclink('link-28', '_run_zenity', 'link-20');">_run_zenity</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">"--calendar"</tt><tt class="py-op">,</tt> <tt class="py-string">"--date-format="</tt> <tt class="py-op">+</tt> <tt class="py-name">format</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">date_args</tt><tt class="py-op">,</tt> <tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> </tt>
<a name="QtClipboard"></a><div id="QtClipboard-def"><a name="L708"></a><tt class="py-lineno"> 708</tt> <a class="py-toggle" href="#" id="QtClipboard-toggle" onclick="return toggle('QtClipboard');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-class.html">QtClipboard</a><tt class="py-op">:</tt> </tt>
</div><div id="QtClipboard-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="QtClipboard-expanded"><a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"><tt class="py-docstring"> Read/write access to the X selection and clipboard - QT version</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.__init__"></a><div id="QtClipboard.__init__-def"><a name="L713"></a><tt class="py-lineno"> 713</tt> <a class="py-toggle" href="#" id="QtClipboard.__init__-toggle" onclick="return toggle('QtClipboard.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.__init__-expanded"><a name="L714"></a><tt class="py-lineno"> 714</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>
<a name="L715"></a><tt class="py-lineno"> 715</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>
</div><a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.fill_selection"></a><div id="QtClipboard.fill_selection-def"><a name="L717"></a><tt class="py-lineno"> 717</tt> <a class="py-toggle" href="#" id="QtClipboard.fill_selection-toggle" onclick="return toggle('QtClipboard.fill_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.fill_selection-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.fill_selection-expanded"><a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the X selection</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_selection(contents)}</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name" targets="Method lib.scripting.GtkClipboard.__execAsync()=lib.scripting.GtkClipboard-class.html#__execAsync,Method lib.scripting.QtClipboard.__execAsync()=lib.scripting.QtClipboard-class.html#__execAsync"><a title="lib.scripting.GtkClipboard.__execAsync
lib.scripting.QtClipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-29', '__execAsync', 'link-29');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name" targets="Method lib.scripting.GtkClipboard.__fillSelection()=lib.scripting.GtkClipboard-class.html#__fillSelection,Method lib.scripting.QtClipboard.__fillSelection()=lib.scripting.QtClipboard-class.html#__fillSelection"><a title="lib.scripting.GtkClipboard.__fillSelection
lib.scripting.QtClipboard.__fillSelection" class="py-name" href="#" onclick="return doclink('link-30', '__fillSelection', 'link-30');">__fillSelection</a></tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
</div><a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.__fillSelection"></a><div id="QtClipboard.__fillSelection-def"><a name="L727"></a><tt class="py-lineno"> 727</tt> <a class="py-toggle" href="#" id="QtClipboard.__fillSelection-toggle" onclick="return toggle('QtClipboard.__fillSelection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.__fillSelection-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.__fillSelection-expanded"><a name="L728"></a><tt class="py-lineno"> 728</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>
<a name="L729"></a><tt class="py-lineno"> 729</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>
</div><a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.get_selection"></a><div id="QtClipboard.get_selection-def"><a name="L731"></a><tt class="py-lineno"> 731</tt> <a class="py-toggle" href="#" id="QtClipboard.get_selection-toggle" onclick="return toggle('QtClipboard.get_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.get_selection-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.get_selection-expanded"><a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the X selection</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_selection()}</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"><tt class="py-docstring"> @return: text contents of the mouse selection</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="lib.scripting.GtkClipboard.__execAsync
lib.scripting.QtClipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-31', '__execAsync', 'link-29');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method lib.scripting.QtClipboard.__getSelection()=lib.scripting.QtClipboard-class.html#__getSelection"><a title="lib.scripting.QtClipboard.__getSelection" class="py-name" href="#" onclick="return doclink('link-32', '__getSelection', 'link-32');">__getSelection</a></tt><tt class="py-op">)</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">unicode</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>
</div><a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.__getSelection"></a><div id="QtClipboard.__getSelection-def"><a name="L743"></a><tt class="py-lineno"> 743</tt> <a class="py-toggle" href="#" id="QtClipboard.__getSelection-toggle" onclick="return toggle('QtClipboard.__getSelection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.__getSelection-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.__getSelection-expanded"><a name="L744"></a><tt class="py-lineno"> 744</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>
<a name="L745"></a><tt class="py-lineno"> 745</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>
</div><a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.fill_clipboard"></a><div id="QtClipboard.fill_clipboard-def"><a name="L747"></a><tt class="py-lineno"> 747</tt> <a class="py-toggle" href="#" id="QtClipboard.fill_clipboard-toggle" onclick="return toggle('QtClipboard.fill_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.fill_clipboard-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.fill_clipboard-expanded"><a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the clipboard</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_clipboard(contents)}</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="lib.scripting.GtkClipboard.__execAsync
lib.scripting.QtClipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-33', '__execAsync', 'link-29');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name" targets="Method lib.scripting.GtkClipboard.__fillClipboard()=lib.scripting.GtkClipboard-class.html#__fillClipboard,Method lib.scripting.QtClipboard.__fillClipboard()=lib.scripting.QtClipboard-class.html#__fillClipboard"><a title="lib.scripting.GtkClipboard.__fillClipboard
lib.scripting.QtClipboard.__fillClipboard" class="py-name" href="#" onclick="return doclink('link-34', '__fillClipboard', 'link-34');">__fillClipboard</a></tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
</div><a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.__fillClipboard"></a><div id="QtClipboard.__fillClipboard-def"><a name="L757"></a><tt class="py-lineno"> 757</tt> <a class="py-toggle" href="#" id="QtClipboard.__fillClipboard-toggle" onclick="return toggle('QtClipboard.__fillClipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.__fillClipboard-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.__fillClipboard-expanded"><a name="L758"></a><tt class="py-lineno"> 758</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">Clipboard</tt><tt class="py-op">)</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</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>
</div><a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.get_clipboard"></a><div id="QtClipboard.get_clipboard-def"><a name="L761"></a><tt class="py-lineno"> 761</tt> <a class="py-toggle" href="#" id="QtClipboard.get_clipboard-toggle" onclick="return toggle('QtClipboard.get_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.get_clipboard-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.get_clipboard-expanded"><a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the clipboard</tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_clipboard()}</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"><tt class="py-docstring"> @return: text contents of the clipboard</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="lib.scripting.GtkClipboard.__execAsync
lib.scripting.QtClipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-35', '__execAsync', 'link-29');">__execAsync</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method lib.scripting.QtClipboard.__getClipboard()=lib.scripting.QtClipboard-class.html#__getClipboard"><a title="lib.scripting.QtClipboard.__getClipboard" class="py-name" href="#" onclick="return doclink('link-36', '__getClipboard', 'link-36');">__getClipboard</a></tt><tt class="py-op">)</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">unicode</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>
</div><a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.__getClipboard"></a><div id="QtClipboard.__getClipboard-def"><a name="L773"></a><tt class="py-lineno"> 773</tt> <a class="py-toggle" href="#" id="QtClipboard.__getClipboard-toggle" onclick="return toggle('QtClipboard.__getClipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.__getClipboard-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.__getClipboard-expanded"><a name="L774"></a><tt class="py-lineno"> 774</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">Clipboard</tt><tt class="py-op">)</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</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>
</div><a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"> </tt>
<a name="QtClipboard.__execAsync"></a><div id="QtClipboard.__execAsync-def"><a name="L777"></a><tt class="py-lineno"> 777</tt> <a class="py-toggle" href="#" id="QtClipboard.__execAsync-toggle" onclick="return toggle('QtClipboard.__execAsync');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.QtClipboard-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>
</div><div id="QtClipboard.__execAsync-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="QtClipboard.__execAsync-expanded"><a name="L778"></a><tt class="py-lineno"> 778</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>
<a name="L779"></a><tt class="py-lineno"> 779</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>
<a name="L780"></a><tt class="py-lineno"> 780</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>
</div></div><a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard"></a><div id="GtkClipboard-def"><a name="L783"></a><tt class="py-lineno"> 783</tt> <a class="py-toggle" href="#" id="GtkClipboard-toggle" onclick="return toggle('GtkClipboard');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-class.html">GtkClipboard</a><tt class="py-op">:</tt> </tt>
</div><div id="GtkClipboard-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="GtkClipboard-expanded"><a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"><tt class="py-docstring"> Read/write access to the X selection and clipboard - GTK version</tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.__init__"></a><div id="GtkClipboard.__init__-def"><a name="L788"></a><tt class="py-lineno"> 788</tt> <a class="py-toggle" href="#" id="GtkClipboard.__init__-toggle" onclick="return toggle('GtkClipboard.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.__init__-expanded"><a name="L789"></a><tt class="py-lineno"> 789</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 class="py-name">Clipboard</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">SELECTION_CLIPBOARD</tt><tt class="py-op">)</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</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 class="py-name">Clipboard</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">SELECTION_PRIMARY</tt><tt class="py-op">)</tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</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>
</div><a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.fill_selection"></a><div id="GtkClipboard.fill_selection-def"><a name="L793"></a><tt class="py-lineno"> 793</tt> <a class="py-toggle" href="#" id="GtkClipboard.fill_selection-toggle" onclick="return toggle('GtkClipboard.fill_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.fill_selection-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.fill_selection-expanded"><a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the X selection</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_selection(contents)}</tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt class="py-comment">#self.__execAsync(self.__fillSelection, contents)</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="lib.scripting.GtkClipboard.__fillSelection
lib.scripting.QtClipboard.__fillSelection" class="py-name" href="#" onclick="return doclink('link-37', '__fillSelection', 'link-30');">__fillSelection</a></tt><tt class="py-op">(</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
</div><a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.__fillSelection"></a><div id="GtkClipboard.__fillSelection-def"><a name="L804"></a><tt class="py-lineno"> 804</tt> <a class="py-toggle" href="#" id="GtkClipboard.__fillSelection-toggle" onclick="return toggle('GtkClipboard.__fillSelection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.__fillSelection-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.__fillSelection-expanded"><a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">threads_enter</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</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>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">threads_leave</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-comment">#self.sem.release()</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.get_selection"></a><div id="GtkClipboard.get_selection-def"><a name="L810"></a><tt class="py-lineno"> 810</tt> <a class="py-toggle" href="#" id="GtkClipboard.get_selection-toggle" onclick="return toggle('GtkClipboard.get_selection');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.get_selection-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.get_selection-expanded"><a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the X selection</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_selection()}</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"><tt class="py-docstring"> @return: text contents of the mouse selection</tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"><tt class="py-docstring"> @raise Exception: if no text was found in the selection</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="lib.scripting.GtkClipboard.__execAsync
lib.scripting.QtClipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-38', '__execAsync', 'link-29');">__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-39" class="py-name" targets="Method lib.scripting.GtkClipboard.__receive()=lib.scripting.GtkClipboard-class.html#__receive"><a title="lib.scripting.GtkClipboard.__receive" class="py-name" href="#" onclick="return doclink('link-39', '__receive', 'link-39');">__receive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</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>
<a name="L822"></a><tt class="py-lineno"> 822</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>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</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 text found in X selection"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.__receive"></a><div id="GtkClipboard.__receive-def"><a name="L826"></a><tt class="py-lineno"> 826</tt> <a class="py-toggle" href="#" id="GtkClipboard.__receive-toggle" onclick="return toggle('GtkClipboard.__receive');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.__receive-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.__receive-expanded"><a name="L827"></a><tt class="py-lineno"> 827</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>
<a name="L828"></a><tt class="py-lineno"> 828</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>
</div><a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.fill_clipboard"></a><div id="GtkClipboard.fill_clipboard-def"><a name="L830"></a><tt class="py-lineno"> 830</tt> <a class="py-toggle" href="#" id="GtkClipboard.fill_clipboard-toggle" onclick="return toggle('GtkClipboard.fill_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.fill_clipboard-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.fill_clipboard-expanded"><a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"><tt class="py-docstring"> Copy text into the clipboard</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.fill_clipboard(contents)}</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: string to be placed in the selection</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="lib.scripting.GtkClipboard.__fillClipboard
lib.scripting.QtClipboard.__fillClipboard" class="py-name" href="#" onclick="return doclink('link-40', '__fillClipboard', 'link-34');">__fillClipboard</a></tt><tt class="py-op">(</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
</div><a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.__fillClipboard"></a><div id="GtkClipboard.__fillClipboard-def"><a name="L840"></a><tt class="py-lineno"> 840</tt> <a class="py-toggle" href="#" id="GtkClipboard.__fillClipboard-toggle" onclick="return toggle('GtkClipboard.__fillClipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.__fillClipboard-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.__fillClipboard-expanded"><a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">threads_enter</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</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>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">threads_leave</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-comment">#self.sem.release() </tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.get_clipboard"></a><div id="GtkClipboard.get_clipboard-def"><a name="L846"></a><tt class="py-lineno"> 846</tt> <a class="py-toggle" href="#" id="GtkClipboard.get_clipboard-toggle" onclick="return toggle('GtkClipboard.get_clipboard');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.get_clipboard-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.get_clipboard-expanded"><a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"><tt class="py-docstring"> Read text from the clipboard</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{clipboard.get_clipboard()}</tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"><tt class="py-docstring"> @return: text contents of the clipboard</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"><tt class="py-docstring"> @raise Exception: if no text was found on the clipboard</tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="lib.scripting.GtkClipboard.__execAsync
lib.scripting.QtClipboard.__execAsync" class="py-name" href="#" onclick="return doclink('link-41', '__execAsync', 'link-29');">__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-42" class="py-name"><a title="lib.scripting.GtkClipboard.__receive" class="py-name" href="#" onclick="return doclink('link-42', '__receive', 'link-39');">__receive</a></tt><tt class="py-op">)</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">text</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>
<a name="L858"></a><tt class="py-lineno"> 858</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>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</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 text found on clipboard"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> </tt>
<a name="GtkClipboard.__execAsync"></a><div id="GtkClipboard.__execAsync-def"><a name="L862"></a><tt class="py-lineno"> 862</tt> <a class="py-toggle" href="#" id="GtkClipboard.__execAsync-toggle" onclick="return toggle('GtkClipboard.__execAsync');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.GtkClipboard-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>
</div><div id="GtkClipboard.__execAsync-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GtkClipboard.__execAsync-expanded"><a name="L863"></a><tt class="py-lineno"> 863</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>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">threads_enter</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</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>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-name">Gdk</tt><tt class="py-op">.</tt><tt class="py-name">threads_leave</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</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>
</div></div><a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> </tt>
<a name="Window"></a><div id="Window-def"><a name="L870"></a><tt class="py-lineno"> 870</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>
</div><div id="Window-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Window-expanded"><a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"><tt class="py-docstring"> Basic window management using wmctrl</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</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>
<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"><tt class="py-docstring"> two special values of window title are permitted:</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"><tt class="py-docstring"> :ACTIVE: - select the currently active window</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"><tt class="py-docstring"> :SELECT: - select the desired window by clicking on it</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> </tt>
<a name="Window.__init__"></a><div id="Window.__init__-def"><a name="L881"></a><tt class="py-lineno"> 881</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>
</div><div id="Window.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.__init__-expanded"><a name="L882"></a><tt class="py-lineno"> 882</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>
</div><a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> </tt>
<a name="Window.wait_for_focus"></a><div id="Window.wait_for_focus-def"><a name="L884"></a><tt class="py-lineno"> 884</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>
</div><div id="Window.wait_for_focus-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.wait_for_focus-expanded"><a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"><tt class="py-docstring"> Wait for window with the given title to have focus</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.wait_for_focus(title, timeOut=5)}</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"><tt class="py-docstring"> If the window becomes active, returns True. Otherwise, returns False if</tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"><tt class="py-docstring"> the window has not become active by the time the timeout has elapsed.</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"><tt class="py-docstring"> @param title: title to match against (as a regular expression)</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: period (seconds) to wait before giving up</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: boolean</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</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>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</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>
<a name="L900"></a><tt class="py-lineno"> 900</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>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">timeOut</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> <tt class="py-comment"># zero length timeout, if not matched go straight to end</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</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>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">+=</tt> <tt class="py-number">0.3</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> </tt>
<a name="Window.wait_for_exist"></a><div id="Window.wait_for_exist-def"><a name="L911"></a><tt class="py-lineno"> 911</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>
</div><div id="Window.wait_for_exist-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.wait_for_exist-expanded"><a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"><tt class="py-docstring"> Wait for window with the given title to be created</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.wait_for_exist(title, timeOut=5)}</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"><tt class="py-docstring"> If the window is in existence, returns True. Otherwise, returns False if</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"><tt class="py-docstring"> the window has not been created by the time the timeout has elapsed.</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"><tt class="py-docstring"> @param title: title to match against (as a regular expression)</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-docstring"> @param timeOut: period (seconds) to wait before giving up</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: boolean</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</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>
<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</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>
<a name="L927"></a><tt class="py-lineno"> 927</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-43" class="py-name" targets="Method lib.scripting.Window._run_wmctrl()=lib.scripting.Window-class.html#_run_wmctrl"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-43', '_run_wmctrl', 'link-43');">_run_wmctrl</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>
<a name="L928"></a><tt class="py-lineno"> 928</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>
<a name="L929"></a><tt class="py-lineno"> 929</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>
<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">timeOut</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> <tt class="py-comment"># zero length timeout, if not matched go straight to end</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</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>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-name">waited</tt> <tt class="py-op">+=</tt> <tt class="py-number">0.3</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> </tt>
<a name="Window.activate"></a><div id="Window.activate-def"><a name="L940"></a><tt class="py-lineno"> 940</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-param">matchClass</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Window.activate-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.activate-expanded"><a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"><tt class="py-docstring"> Activate the specified window, giving it input focus</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.activate(title, switchDesktop=False, matchClass=False)}</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</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>
<a name="L947"></a><tt class="py-lineno"> 947</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>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"><tt class="py-docstring"> @param switchDesktop: whether or not to switch to the window's current desktop</tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"><tt class="py-docstring"> @param matchClass: if True, match on the window class instead of the title</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">switchDesktop</tt><tt class="py-op">:</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</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>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</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>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">matchClass</tt><tt class="py-op">:</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</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">"-x"</tt><tt class="py-op">]</tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-44', '_run_wmctrl', 'link-43');">_run_wmctrl</a></tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
</div><a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> </tt>
<a name="Window.close"></a><div id="Window.close-def"><a name="L961"></a><tt class="py-lineno"> 961</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-param">matchClass</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Window.close-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.close-expanded"><a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-docstring"> Close the specified window gracefully</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.close(title, matchClass=False)}</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-docstring"> @param matchClass: if True, match on the window class instead of the title</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">matchClass</tt><tt class="py-op">:</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-45', '_run_wmctrl', 'link-43');">_run_wmctrl</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-string">"-x"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-46', '_run_wmctrl', 'link-43');">_run_wmctrl</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>
</div><a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"> </tt>
<a name="Window.resize_move"></a><div id="Window.resize_move-def"><a name="L975"></a><tt class="py-lineno"> 975</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-param">matchClass</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Window.resize_move-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.resize_move-expanded"><a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"><tt class="py-docstring"> Resize and/or move the specified window</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.close(title, xOrigin=-1, yOrigin=-1, width=-1, height=-1, matchClass=False)}</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</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>
<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"><tt class="py-docstring"> value to be left unmodified.</tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"><tt class="py-docstring"> @param xOrigin: new x origin of the window (upper left corner)</tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"><tt class="py-docstring"> @param yOrigin: new y origin of the window (upper left corner)</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"><tt class="py-docstring"> @param width: new width of the window</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"><tt class="py-docstring"> @param height: new height of the window</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"><tt class="py-docstring"> @param matchClass: if True, match on the window class instead of the title</tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</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>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">matchClass</tt><tt class="py-op">:</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt class="py-name">xArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"-x"</tt><tt class="py-op">]</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-name">xArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-47', '_run_wmctrl', 'link-43');">_run_wmctrl</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 class="py-name">xArgs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> </tt>
<a name="Window.move_to_desktop"></a><div id="Window.move_to_desktop-def"><a name="L999"></a><tt class="py-lineno"> 999</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-param">matchClass</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Window.move_to_desktop-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.move_to_desktop-expanded"><a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"><tt class="py-docstring"> Move the specified window to the given desktop</tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.move_to_desktop(title, deskNum, matchClass=False)}</tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"><tt class="py-docstring"> @param deskNum: desktop to move the window to (note: zero based)</tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"><tt class="py-docstring"> @param matchClass: if True, match on the window class instead of the title</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">matchClass</tt><tt class="py-op">:</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-name">xArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"-x"</tt><tt class="py-op">]</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"> <tt class="py-name">xArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-48', '_run_wmctrl', 'link-43');">_run_wmctrl</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 class="py-name">xArgs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> </tt>
<a name="Window.switch_desktop"></a><div id="Window.switch_desktop-def"><a name="L1016"></a><tt class="py-lineno">1016</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>
</div><div id="Window.switch_desktop-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.switch_desktop-expanded"><a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"><tt class="py-docstring"> Switch to the specified desktop</tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.switch_desktop(deskNum)}</tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"><tt class="py-docstring"> @param deskNum: desktop to switch to (note: zero based)</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-49', '_run_wmctrl', 'link-43');">_run_wmctrl</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>
</div><a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> </tt>
<a name="Window.set_property"></a><div id="Window.set_property-def"><a name="L1026"></a><tt class="py-lineno">1026</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-param">matchClass</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Window.set_property-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.set_property-expanded"><a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"><tt class="py-docstring"> Set a property on the given window using the specified action</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.set_property(title, action, prop, matchClass=False)}</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"><tt class="py-docstring"> Allowable actions: C{add, remove, toggle}</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"><tt class="py-docstring"> Allowable properties: C{modal, sticky, maximized_vert, maximized_horz, shaded, skip_taskbar,</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-docstring"> skip_pager, hidden, fullscreen, above}</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"><tt class="py-docstring"> @param title: window title to match against (as case-insensitive substring match)</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"><tt class="py-docstring"> @param action: one of the actions listed above</tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"><tt class="py-docstring"> @param prop: one of the properties listed above</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-docstring"> @param matchClass: if True, match on the window class instead of the title</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">matchClass</tt><tt class="py-op">:</tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"> <tt class="py-name">xArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">"-x"</tt><tt class="py-op">]</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"> <tt class="py-name">xArgs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-50', '_run_wmctrl', 'link-43');">_run_wmctrl</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 class="py-name">xArgs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> </tt>
<a name="Window.get_active_geometry"></a><div id="Window.get_active_geometry-def"><a name="L1047"></a><tt class="py-lineno">1047</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>
</div><div id="Window.get_active_geometry-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.get_active_geometry-expanded"><a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"><tt class="py-docstring"> Get the geometry of the currently active window</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.get_active_geometry()}</tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"><tt class="py-docstring"> @return: a 4-tuple containing the x-origin, y-origin, width and height of the window (in pixels)</tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{tuple(int, int, int, int)}</tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</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>
<a name="L1057"></a><tt class="py-lineno">1057</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-51" class="py-name"><a title="lib.scripting.Window._run_wmctrl" class="py-name" href="#" onclick="return doclink('link-51', '_run_wmctrl', 'link-43');">_run_wmctrl</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>
<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"> <tt class="py-name">matchingLine</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</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>
<a name="L1060"></a><tt class="py-lineno">1060</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>
<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt class="py-name">matchingLine</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</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>
<a name="L1064"></a><tt class="py-lineno">1064</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-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-number">6</tt><tt class="py-op">]</tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</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>
<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> </tt>
<a name="Window.get_active_title"></a><div id="Window.get_active_title-def"><a name="L1069"></a><tt class="py-lineno">1069</tt> <a class="py-toggle" href="#" id="Window.get_active_title-toggle" onclick="return toggle('Window.get_active_title');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#get_active_title">get_active_title</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Window.get_active_title-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.get_active_title-expanded"><a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"><tt class="py-docstring"> Get the visible title of the currently active window</tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.get_active_title()}</tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"><tt class="py-docstring"> @return: the visible title of the currentle active window</tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</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">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>
</div><a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> </tt>
<a name="Window.get_active_class"></a><div id="Window.get_active_class-def"><a name="L1080"></a><tt class="py-lineno">1080</tt> <a class="py-toggle" href="#" id="Window.get_active_class-toggle" onclick="return toggle('Window.get_active_class');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#get_active_class">get_active_class</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Window.get_active_class-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window.get_active_class-expanded"><a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"><tt class="py-docstring"> Get the class of the currently active window</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{window.get_active_class()}</tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"><tt class="py-docstring"> @return: the class of the currentle active window</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</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">mediator</tt><tt class="py-op">.</tt><tt class="py-name">interface</tt><tt class="py-op">.</tt><tt class="py-name">get_window_class</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> </tt>
<a name="Window._run_wmctrl"></a><div id="Window._run_wmctrl-def"><a name="L1091"></a><tt class="py-lineno">1091</tt> <a class="py-toggle" href="#" id="Window._run_wmctrl-toggle" onclick="return toggle('Window._run_wmctrl');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Window-class.html#_run_wmctrl">_run_wmctrl</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>
</div><div id="Window._run_wmctrl-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Window._run_wmctrl-expanded"><a name="L1092"></a><tt class="py-lineno">1092</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>
<a name="L1093"></a><tt class="py-lineno">1093</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>
<a name="L1094"></a><tt class="py-lineno">1094</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>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</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>
</div></div><a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> </tt>
<a name="Engine"></a><div id="Engine-def"><a name="L1099"></a><tt class="py-lineno">1099</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>
</div><div id="Engine-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Engine-expanded"><a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"><tt class="py-docstring"> Provides access to the internals of AutoKey.</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"><tt class="py-docstring"> Note that any configuration changes made using this API while the configuration window</tt> </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"><tt class="py-docstring"> is open will not appear until it is closed and re-opened.</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> </tt>
<a name="Engine.__init__"></a><div id="Engine.__init__-def"><a name="L1107"></a><tt class="py-lineno">1107</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>
</div><div id="Engine.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.__init__-expanded"><a name="L1108"></a><tt class="py-lineno">1108</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>
<a name="L1109"></a><tt class="py-lineno">1109</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>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt> <tt class="py-op">=</tt> <tt class="py-name">configManager</tt><tt class="py-op">.</tt><tt class="py-name">app</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__returnValue</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
</div><a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"> </tt>
<a name="Engine.get_folder"></a><div id="Engine.get_folder-def"><a name="L1113"></a><tt class="py-lineno">1113</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>
</div><div id="Engine.get_folder-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.get_folder-expanded"><a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"><tt class="py-docstring"> Retrieve a folder by its title</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.get_folder(title)}</tt> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</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>
<a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"><tt class="py-docstring"> returned.</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</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>
<a name="L1123"></a><tt class="py-lineno">1123</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>
<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">folder</tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> </tt>
<a name="Engine.create_phrase"></a><div id="Engine.create_phrase-def"><a name="L1127"></a><tt class="py-lineno">1127</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>
</div><div id="Engine.create_phrase-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.create_phrase-expanded"><a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"><tt class="py-docstring"> Create a text phrase</tt> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.create_phrase(folder, description, contents)}</tt> </tt>
<a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</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>
<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</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>
<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description for the phrase</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: the expansion text</tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt><tt class="py-op">.</tt><tt class="py-name">suspend</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</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>
<a name="L1141"></a><tt class="py-lineno">1141</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>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">persist</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt><tt class="py-op">.</tt><tt class="py-name">unsuspend</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</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-name">False</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> </tt>
<a name="Engine.create_abbreviation"></a><div id="Engine.create_abbreviation-def"><a name="L1146"></a><tt class="py-lineno">1146</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>
</div><div id="Engine.create_abbreviation-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.create_abbreviation-expanded"><a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"><tt class="py-docstring"> Create a text abbreviation</tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.create_abbreviation(folder, description, abbr, contents)}</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"><tt class="py-docstring"> When the given abbreviation is typed, it will be replaced with the given</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"><tt class="py-docstring"> text.</tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</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>
<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description for the phrase</tt> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"><tt class="py-docstring"> @param abbr: the abbreviation that will trigger the expansion</tt> </tt>
<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: the expansion text</tt> </tt>
<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"><tt class="py-docstring"> @raise Exception: if the specified abbreviation is not unique</tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</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-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</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>
<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt><tt class="py-op">.</tt><tt class="py-name">suspend</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</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>
<a name="L1166"></a><tt class="py-lineno">1166</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>
<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">abbreviations</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">abbr</tt><tt class="py-op">]</tt> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</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>
<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">persist</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt><tt class="py-op">.</tt><tt class="py-name">unsuspend</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</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-name">False</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> </tt>
<a name="Engine.create_hotkey"></a><div id="Engine.create_hotkey-def"><a name="L1173"></a><tt class="py-lineno">1173</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>
</div><div id="Engine.create_hotkey-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.create_hotkey-expanded"><a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"><tt class="py-docstring"> Create a text hotkey</tt> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.create_hotkey(folder, description, modifiers, key, contents)}</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"><tt class="py-docstring"> When the given hotkey is pressed, it will be replaced with the given</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"><tt class="py-docstring"> text. Modifiers must be given as a list of strings, with the following</tt> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"><tt class="py-docstring"> values permitted:</tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"><tt class="py-docstring"> <ctrl></tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"><tt class="py-docstring"> <alt></tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"><tt class="py-docstring"> <super></tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"><tt class="py-docstring"> <hyper></tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"><tt class="py-docstring"> <shift></tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"><tt class="py-docstring"> The key must be an unshifted character (i.e. lowercase)</tt> </tt>
<a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1191"></a><tt class="py-lineno">1191</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>
<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description for the phrase</tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"><tt class="py-docstring"> @param modifiers: modifiers to use with the hotkey (as a list)</tt> </tt>
<a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"><tt class="py-docstring"> @param key: the hotkey</tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: the expansion text</tt> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"><tt class="py-docstring"> @raise Exception: if the specified hotkey is not unique</tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1198"></a><tt class="py-lineno">1198</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>
<a name="L1199"></a><tt class="py-lineno">1199</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-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</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>
<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt><tt class="py-op">.</tt><tt class="py-name">suspend</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</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>
<a name="L1204"></a><tt class="py-lineno">1204</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>
<a name="L1205"></a><tt class="py-lineno">1205</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>
<a name="L1206"></a><tt class="py-lineno">1206</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>
<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"> <tt class="py-name">p</tt><tt class="py-op">.</tt><tt class="py-name">persist</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">monitor</tt><tt class="py-op">.</tt><tt class="py-name">unsuspend</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</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-name">False</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"> </tt>
<a name="Engine.run_script"></a><div id="Engine.run_script-def"><a name="L1211"></a><tt class="py-lineno">1211</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>
</div><div id="Engine.run_script-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.run_script-expanded"><a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"><tt class="py-docstring"> Run an existing script using its description to look it up</tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.run_script(description)}</tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"><tt class="py-docstring"> @param description: description of the script to run</tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"><tt class="py-docstring"> @raise Exception: if the specified script does not exist</tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> <tt class="py-name">targetScript</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</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>
<a name="L1222"></a><tt class="py-lineno">1222</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">model</tt><tt class="py-op">.</tt><tt class="py-name">Script</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"> <tt class="py-name">targetScript</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt> </tt>
<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</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>
<a name="L1226"></a><tt class="py-lineno">1226</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">run_subscript</tt><tt class="py-op">(</tt><tt class="py-name">targetScript</tt><tt class="py-op">)</tt> </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</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>
</div><a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"> </tt>
<a name="Engine.run_script_from_macro"></a><div id="Engine.run_script_from_macro-def"><a name="L1230"></a><tt class="py-lineno">1230</tt> <a class="py-toggle" href="#" id="Engine.run_script_from_macro-toggle" onclick="return toggle('Engine.run_script_from_macro');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#run_script_from_macro">run_script_from_macro</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>
</div><div id="Engine.run_script_from_macro-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.run_script_from_macro-expanded"><a name="L1231"></a><tt class="py-lineno">1231</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"><tt class="py-docstring"> Used internally by AutoKey for phrase macros</tt> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__macroArgs</tt> <tt class="py-op">=</tt> <tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-string">"args"</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>
<a name="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name" targets="Method lib.scripting.Engine.run_script()=lib.scripting.Engine-class.html#run_script"><a title="lib.scripting.Engine.run_script" class="py-name" href="#" onclick="return doclink('link-52', 'run_script', 'link-52');">run_script</a></tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-string">"name"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name" targets="Method lib.scripting.Engine.set_return_value()=lib.scripting.Engine-class.html#set_return_value"><a title="lib.scripting.Engine.set_return_value" class="py-name" href="#" onclick="return doclink('link-53', 'set_return_value', 'link-53');">set_return_value</a></tt><tt class="py-op">(</tt><tt class="py-string">"{ERROR: %s}"</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> </tt>
<a name="Engine.get_macro_arguments"></a><div id="Engine.get_macro_arguments-def"><a name="L1241"></a><tt class="py-lineno">1241</tt> <a class="py-toggle" href="#" id="Engine.get_macro_arguments-toggle" onclick="return toggle('Engine.get_macro_arguments');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#get_macro_arguments">get_macro_arguments</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Engine.get_macro_arguments-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.get_macro_arguments-expanded"><a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"><tt class="py-docstring"> Get the arguments supplied to the current script via its macro</tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.get_macro_arguments()}</tt> </tt>
<a name="L1246"></a><tt class="py-lineno">1246</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"><tt class="py-docstring"> @return: the arguments</tt> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{list(str())}</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</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">__macroArgs</tt> </tt>
</div><a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"> </tt>
<a name="Engine.set_return_value"></a><div id="Engine.set_return_value-def"><a name="L1252"></a><tt class="py-lineno">1252</tt> <a class="py-toggle" href="#" id="Engine.set_return_value-toggle" onclick="return toggle('Engine.set_return_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#set_return_value">set_return_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">val</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Engine.set_return_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine.set_return_value-expanded"><a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"><tt class="py-docstring"> Store a return value to be used by a phrase macro</tt> </tt>
<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"><tt class="py-docstring"> Usage: C{engine.set_return_value(val)}</tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"><tt class="py-docstring"> @param val: value to be stored</tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__returnValue</tt> <tt class="py-op">=</tt> <tt class="py-name">val</tt> </tt>
</div><a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"> </tt>
<a name="Engine._get_return_value"></a><div id="Engine._get_return_value-def"><a name="L1262"></a><tt class="py-lineno">1262</tt> <a class="py-toggle" href="#" id="Engine._get_return_value-toggle" onclick="return toggle('Engine._get_return_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="lib.scripting.Engine-class.html#_get_return_value">_get_return_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Engine._get_return_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Engine._get_return_value-expanded"><a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"><tt class="py-docstring"> Used internally by AutoKey for phrase macros</tt> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> <tt class="py-name">ret</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__returnValue</tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__returnValue</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">ret</tt> </tt>
</div></div><a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
