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
|
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#VERSION">VERSION</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#DEPENDENCIES">DEPENDENCIES</a></li>
<li><a href="#INSTALLATION">INSTALLATION</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#FUNCTIONS">FUNCTIONS</a></li>
<li><a href="#OTHER-DOCUMENTATION">OTHER DOCUMENTATION</a></li>
<li><a href="#COPYRIGHT">COPYRIGHT</a></li>
<li><a href="#AUTHOR">AUTHOR</a></li>
<li><a href="#CONTRIBUTORS">CONTRIBUTORS</a></li>
<li><a href="#CREDITS">CREDITS</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p><b>X11::GUITest</b> - Provides GUI testing/interaction routines.</p>
<h1 id="VERSION">VERSION</h1>
<p>0.28</p>
<p>Updates are made available at the following sites:</p>
<pre><code> http://sourceforge.net/projects/x11guitest
http://www.cpan.org</code></pre>
<p>Please consult 'docs/Changes' for the list of changes between module revisions.</p>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>This Perl package is intended to facilitate the testing of GUI applications by means of user emulation. It can be used to test/interact with GUI applications; which have been built upon the X library or toolkits (i.e., GTK+, Xt, Qt, Motif, etc.) that "wrap" the X library's functionality.</p>
<p>A basic recorder (x11guirecord) is also available, and can be found in the source code repository.</p>
<h1 id="DEPENDENCIES">DEPENDENCIES</h1>
<p>An X server with the XTest extensions enabled. This seems to be the norm. If it is not enabled, it usually can be by modifying the X server configuration (i.e., XF86Config).</p>
<p>The standard DISPLAY environment variable is utilized to determine the host, display, and screen to work with. By default it is usually set to ":0.0" for the localhost. However, by altering this variable one can interact with applications under a remote host's X server. To change this from a terminal window, one can utilize the following basic syntax: export DISPLAY=<hostname-or-ipaddress>:<display>.<screen> Please note that under most circumstances, xhost will need to be executed properly on the remote host as well.</p>
<p>There is a known incompatibility between the XTest and Xinerama extensions, which causes the XTestFakeMotionEvent() function to misbehave. When the Xinerama (X server) extension is turned on, this (Perl) extension has been modified to allow one to invoke an alternative function. See Makefile.PL for details.</p>
<h1 id="INSTALLATION">INSTALLATION</h1>
<pre><code> perl Makefile.PL
make
make test
make install
# If the build has errors, you may need to install the following dependencies:
# libxt-dev, libxtst-dev
# If you'd like to install the recorder, use these steps:
cd recorder
./autogen.sh
./configure
make
make install
x11guirecord --help</code></pre>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<p>For additional examples, please look under the 'eg/' sub-directory from the installation folder.</p>
<pre><code> use X11::GUITest qw/
StartApp
WaitWindowViewable
SendKeys
/;
# Start gedit application
StartApp('gedit');
# Wait for application window to come up and become viewable.
my ($GEditWinId) = WaitWindowViewable('gedit');
if (!$GEditWinId) {
die("Couldn't find gedit window in time!");
}
# Send text to it
SendKeys("Hello, how are you?\n");
# Close Application (Alt-f, q).
SendKeys('%(f)q');
# Handle gedit's Question window if it comes up when closing. Wait
# at most 5 seconds for it.
if (WaitWindowViewable('Question', undef, 5)) {
# DoN't Save (Alt-n)
SendKeys('%(n)');
}</code></pre>
<h1 id="FUNCTIONS">FUNCTIONS</h1>
<p>Parameters enclosed within [] are optional.</p>
<p>If there are multiple optional parameters available for a function and you would like to specify the last one, for example, you can utilize undef for those parameters you don't specify.</p>
<p>REGEX in the documentation below denotes an item that is treated as a regular expression. For example, the regex "^OK$" would look for an exact match for the word OK.</p>
<dl>
<dt id="FindWindowLike-TITLEREGEX-WINDOWIDSTARTUNDER">FindWindowLike TITLEREGEX [, WINDOWIDSTARTUNDER]</dt>
<dd>
<p>Finds the window Ids of the windows matching the specified title regex. Optionally one can specify the window to start under; which would allow one to constrain the search to child windows of that window.</p>
<p>An array of window Ids is returned for the matches found. An empty array is returned if no matches were found.</p>
<pre><code> my @WindowIds = FindWindowLike('gedit');
# Only worry about first window found
my ($WindowId) = FindWindowLike('gedit');</code></pre>
</dd>
</dl>
<dl>
<dt id="WaitWindowLike-TITLEREGEX-WINDOWIDSTARTUNDER-MAXWAITINSECONDS">WaitWindowLike TITLEREGEX [, WINDOWIDSTARTUNDER] [, MAXWAITINSECONDS]</dt>
<dd>
<p>Waits for a window to come up that matches the specified title regex. Optionally one can specify the window to start under; which would allow one to constrain the search to child windows of that window.</p>
<p>One can optionally specify an alternative wait amount in seconds. A window will keep being looked for that matches the specified title regex until this amount of time has been reached. The default amount is defined in the DEF_WAIT constant available through the :CONST export tag.</p>
<p>If a window is going to be manipulated by input, WaitWindowViewable is the more robust solution to utilize.</p>
<p>An array of window Ids is returned for the matches found. An empty array is returned if no matches were found.</p>
<pre><code> my @WindowIds = WaitWindowLike('gedit');
# Only worry about first window found
my ($WindowId) = WaitWindowLike('gedit');
WaitWindowLike('gedit') or die("gedit window not found!");</code></pre>
</dd>
</dl>
<dl>
<dt id="WaitWindowViewable-TITLEREGEX-WINDOWIDSTARTUNDER-MAXWAITINSECONDS">WaitWindowViewable TITLEREGEX [, WINDOWIDSTARTUNDER] [, MAXWAITINSECONDS]</dt>
<dd>
<p>Similar to WaitWindow, but only recognizes windows that are viewable. When GUI applications are started, their window isn't necessarily viewable yet, let alone available for input, so this function is very useful.</p>
<p>Likewise, this function will only return an array of the matching window Ids for those windows that are viewable. An empty array is returned if no matches were found.</p>
</dd>
</dl>
<dl>
<dt id="WaitWindowClose-WINDOWID-MAXWAITINSECONDS">WaitWindowClose WINDOWID [, MAXWAITINSECONDS]</dt>
<dd>
<p>Waits for the specified window to close.</p>
<p>One can optionally specify an alternative wait amount in seconds. The window will keep being checked to see if it has closed until this amount of time has been reached. The default amount is defined in the DEF_WAIT constant available through the :CONST export tag.</p>
<p>zero is returned if window is not gone, non-zero if it is gone.</p>
</dd>
</dl>
<dl>
<dt id="WaitSeconds-SECONDS">WaitSeconds SECONDS</dt>
<dd>
<p>Pauses execution for the specified amount of seconds.</p>
<pre><code> WaitSeconds(0.5); # Wait 1/2 second
WaitSeconds(3); # Wait 3 seconds</code></pre>
</dd>
</dl>
<dl>
<dt id="ClickWindow-WINDOWID-X-Offset-Y-Offset-Button">ClickWindow WINDOWID [, X Offset] [, Y Offset] [, Button]</dt>
<dd>
<p>Clicks on the specified window with the mouse.</p>
<p>Optionally one can specify the X offset and Y offset. By default, the top left corner of the window is clicked on, with these two parameters one can specify a different position to be clicked on.</p>
<p>One can also specify an alternative button. The default button is M_LEFT, but M_MIDDLE and M_RIGHT may be specified too. Also, you could use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3, M_BTN4, M_BTN5. These are all available through the :CONST export tag.</p>
<p>zero is returned on failure, non-zero for success</p>
</dd>
</dl>
<dl>
<dt id="GetWindowsFromPid">GetWindowsFromPid</dt>
<dd>
<p>Returns a list of window ids discovered for the specified process id (pid).</p>
<p>undef is returned on error.</p>
</dd>
</dl>
<dl>
<dt id="GetWindowFromPoint-X-Y-SCREEN">GetWindowFromPoint X, Y [, SCREEN]</dt>
<dd>
<p>Returns the window that is at the specified point. If no screen is given, it is taken from the value given when opening the X display.</p>
<p>zero is returned if there are no matches (i.e., off screen).</p>
</dd>
</dl>
<dl>
<dt id="IsChild-PARENTWINDOWID-WINDOWID">IsChild PARENTWINDOWID, WINDOWID</dt>
<dd>
<p>Determines if the specified window is a child of the specified parent.</p>
<p>zero is returned for false, non-zero for true.</p>
</dd>
</dl>
<dl>
<dt id="QuoteStringForSendKeys-STRING">QuoteStringForSendKeys STRING</dt>
<dd>
<p>Quotes {} characters in the specified string that would be interpreted as having special meaning if sent to SendKeys directly. This function would be useful if you had a text file in which you wanted to use each line of the file as input to the SendKeys function, but didn't want any special interpretation of the characters in the file.</p>
<p>Returns the quoted string, undef is returned on error.</p>
<pre><code> # Quote ~, %, etc. as {~}, {%}, etc for literal use in SendKeys.
SendKeys( QuoteStringForSendKeys('Hello: ~%^(){}+#') );
SendKeys( QSfSK('#+#') );</code></pre>
<p>The international AltGr key - modifier character (&) is not escaped by this function. Escape this character manually ("{&}"), if used/needed.</p>
</dd>
</dl>
<dl>
<dt id="StartApp-COMMANDLINE">StartApp COMMANDLINE</dt>
<dd>
<p>Uses the shell to execute a program. This function returns as soon as the program is called. Useful for starting GUI /applications and then going on to work with them.</p>
<p>zero is returned on failure, non-zero for success</p>
<pre><code> StartApp('gedit');</code></pre>
</dd>
</dl>
<dl>
<dt id="RunApp-COMMANDLINE">RunApp COMMANDLINE</dt>
<dd>
<p>Uses the shell to execute a program until its completion.</p>
<p>Return value will be application specific, however -1 is returned to indicate a failure in starting the program.</p>
<pre><code> RunApp('/work/myapp');</code></pre>
</dd>
</dl>
<dl>
<dt id="ClickMouseButton-BUTTON">ClickMouseButton BUTTON</dt>
<dd>
<p>Clicks the specified mouse button. Available mouse buttons are: M_LEFT, M_MIDDLE, M_RIGHT, M_DOWN, M_UP. Also, you could use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3, M_BTN4, M_BTN5. These are all available through the :CONST export tag.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="DefaultScreen">DefaultScreen</dt>
<dd>
<p>Returns the screen number specified in the X display value used to open the display.</p>
<p>Leverages the Xlib macro of the same name.</p>
</dd>
</dl>
<dl>
<dt id="ScreenCount">ScreenCount</dt>
<dd>
<p>Returns the number of screens in the X display specified when opening it.</p>
<p>Leverages the Xlib macro of the same name.</p>
</dd>
</dl>
<dl>
<dt id="SetEventSendDelay-DELAYINMILLISECONDS">SetEventSendDelay DELAYINMILLISECONDS</dt>
<dd>
<p>Sets the milliseconds of delay between events being sent to the X display. It is usually not a good idea to set this to 0.</p>
<p>Please note that this delay will also affect SendKeys.</p>
<p>Returns the old delay amount in milliseconds.</p>
</dd>
</dl>
<dl>
<dt id="GetEventSendDelay">GetEventSendDelay</dt>
<dd>
<p>Returns the current event sending delay amount in milliseconds.</p>
</dd>
</dl>
<dl>
<dt id="SetKeySendDelay-DELAYINMILLISECONDS">SetKeySendDelay DELAYINMILLISECONDS</dt>
<dd>
<p>Sets the milliseconds of delay between keystrokes.</p>
<p>Returns the old delay amount in milliseconds.</p>
</dd>
</dl>
<dl>
<dt id="GetKeySendDelay">GetKeySendDelay</dt>
<dd>
<p>Returns the current keystroke sending delay amount in milliseconds.</p>
</dd>
</dl>
<dl>
<dt id="GetWindowName-WINDOWID">GetWindowName WINDOWID</dt>
<dd>
<p>Returns the window name for the specified window Id. undef is returned if name could not be obtained.</p>
<pre><code> # Return the name of the window that has the input focus.
my $WinName = GetWindowName(GetInputFocus());</code></pre>
</dd>
</dl>
<dl>
<dt id="GetWindowPid-WINDOWID">GetWindowPid WINDOWID</dt>
<dd>
<p>Returns the process id (pid) associated with the specified window. 0 is returned if the pid is not available.</p>
<pre><code> # Return the pid of the window that has the input focus.
my $pid = GetWindowPid(GetInputFocus());</code></pre>
</dd>
</dl>
<dl>
<dt id="SetWindowName-WINDOWID-NAME">SetWindowName WINDOWID, NAME</dt>
<dd>
<p>Sets the window name for the specified window Id.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="GetRootWindow-SCREEN">GetRootWindow [SCREEN]</dt>
<dd>
<p>Returns the Id of the root window of the screen. This is the top/root level window that all other windows are under. If no screen is given, it is taken from the value given when opening the X display.</p>
</dd>
</dl>
<dl>
<dt id="GetChildWindows-WINDOWID">GetChildWindows WINDOWID</dt>
<dd>
<p>Returns an array of the child windows for the specified window Id. If it detects that the window hierarchy is in transition, it will wait half a second and try again.</p>
</dd>
</dl>
<dl>
<dt id="MoveMouseAbs-X-Y-SCREEN">MoveMouseAbs X, Y [, SCREEN]</dt>
<dd>
<p>Moves the mouse cursor to the specified absolute position in the optionally given screen. If no screen is given, it is taken from the value given when opening the X display.</p>
<p>Zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="GetMousePos">GetMousePos</dt>
<dd>
<p>Returns an array containing the position and the screen (number) of the mouse cursor.</p>
<pre><code> my ($x, $y, $scr_num) = GetMousePos();</code></pre>
</dd>
</dl>
<dl>
<dt id="PressMouseButton-BUTTON">PressMouseButton BUTTON</dt>
<dd>
<p>Presses the specified mouse button. Available mouse buttons are: M_LEFT, M_MIDDLE, M_RIGHT, M_DOWN, M_UP. Also, you could use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3, M_BTN4, M_BTN5. These are all available through the :CONST export tag.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="ReleaseMouseButton-BUTTON">ReleaseMouseButton BUTTON</dt>
<dd>
<p>Releases the specified mouse button. Available mouse buttons are: M_LEFT, M_MIDDLE, M_RIGHT, M_DOWN, M_UP. Also, you could use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3, M_BTN4, M_BTN5. These are all available through the :CONST export tag.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="SendKeys-KEYS">SendKeys KEYS</dt>
<dd>
<p>Sends keystrokes to the window that has the input focus.</p>
<p>The keystrokes to send are those specified in KEYS parameter. Some characters have special meaning, they are:</p>
<pre><code> Modifier Keys:
^ CTRL
% ALT
+ SHIFT
# META
& ALTGR
Other Keys:
~ ENTER
\n ENTER
\t TAB
( and ) MODIFIER GROUPING
{ and } QUOTE / ESCAPE CHARACTERS</code></pre>
<p>Simply, one can send a text string like so:</p>
<pre><code> SendKeys('Hello, how are you today?');</code></pre>
<p>Parenthesis allow a modifier to work on one or more characters. For example:</p>
<pre><code> SendKeys('%(f)q'); # Alt-f, then press q
SendKeys('%(fa)^(m)'); # Alt-f, Alt-a, Ctrl-m
SendKeys('+(abc)'); # Uppercase ABC using shift modifier
SendKeys('^(+(l))'); # Ctrl-Shift-l
SendKeys('+'); # Press shift</code></pre>
<p>Braces are used to quote special characters, for utilizing aliased key names, or for special functionality. Multiple characters can be specified in a brace by space delimiting the entries. Characters can be repeated using a number that is space delimited after the preceding key.</p>
<p>Quote Special Characters</p>
<pre><code> SendKeys('{{}'); # {
SendKeys('{+}'); # +
SendKeys('{#}'); # #
You can also use QuoteStringForSendKeys (QSfSK) to perform quoting.</code></pre>
<p>Aliased Key Names</p>
<pre><code> SendKeys('{BAC}'); # Backspace
SendKeys('{F1 F2 F3}'); # F1, F2, F3
SendKeys('{TAB 3}'); # Press TAB 3 times
SendKeys('{SPC 3 a b c}'); # Space 3 times, a, b, c</code></pre>
<p>Special Functionality</p>
<pre><code> # Pause execution for 500 milliseconds
SendKeys('{PAUSE 500}');</code></pre>
<p>Combinations</p>
<pre><code> SendKeys('abc+(abc){TAB PAUSE 500}'); # a, b, c, A, B, C, Tab, Pause 500
SendKeys('+({a b c})'); # A, B, C</code></pre>
<p>The following abbreviated key names are currently recognized within a brace set. If you don't see the desired key, you can still use the unabbreviated name for the key. If you are unsure of this name, utilize the xev (X event view) tool, press the key you want and look at the tools output for the name of that key. Names that are in the list below can be utilized regardless of case. Ones that aren't in this list are going to be case sensitive and also not abbreviated. For example, using 'xev' you will find that the name of the backspace key is BackSpace, so you could use {BackSpace} in place of {bac} if you really wanted to.</p>
<pre><code> Name Action
-------------------
BAC BackSpace
BS BackSpace
BKS BackSpace
BRE Break
CAN Cancel
CAP Caps_Lock
DEL Delete
DOWN Down
END End
ENT Return
ESC Escape
F1 F1
... ...
F12 F12
HEL Help
HOM Home
INS Insert
LAL Alt_L
LMA Meta_L
LCT Control_L
LEF Left
LSH Shift_L
LSK Super_L
MNU Menu
NUM Num_Lock
PGD Page_Down
PGU Page_Up
PRT Print
RAL Alt_R
RMA Meta_R
RCT Control_R
RIG Right
RSH Shift_R
RSK Super_R
SCR Scroll_Lock
SPA Space
SPC Space
TAB Tab
UP Up</code></pre>
<p>zero is returned on failure, non-zero for success. For configurations (Xvfb) that don't support Alt_Left, Meta_Left is automatically used in its place.</p>
</dd>
</dl>
<dl>
<dt id="PressKey-KEY">PressKey KEY</dt>
<dd>
<p>Presses the specified key.</p>
<p>One can utilize the abbreviated key names from the table listed above as outlined in the following example:</p>
<pre><code> # Alt-n
PressKey('LAL'); # Left Alt
PressKey('n');
ReleaseKey('n');
ReleaseKey('LAL');
# Uppercase a
PressKey('LSH'); # Left Shift
PressKey('a');
ReleaseKey('a');
ReleaseKey('LSH');</code></pre>
<p>The ReleaseKey calls in the above example are there to set both key states back.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="ReleaseKey-KEY">ReleaseKey KEY</dt>
<dd>
<p>Releases the specified key. Normally follows a PressKey call.</p>
<p>One can utilize the abbreviated key names from the table listed above.</p>
<pre><code> ReleaseKey('n');</code></pre>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="PressReleaseKey-KEY">PressReleaseKey KEY</dt>
<dd>
<p>Presses and releases the specified key.</p>
<p>One can utilize the abbreviated key names from the table listed above.</p>
<pre><code> PressReleaseKey('n');</code></pre>
<p>This function is affected by the key send delay.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="IsKeyPressed-KEY">IsKeyPressed KEY</dt>
<dd>
<p>Determines if the specified key is currently being pressed.</p>
<p>You can specify such things as 'bac' or the unabbreviated form 'BackSpace' as covered in the SendKeys information. Brace forms such as '{bac}' are unsupported. A '{' is taken literally and letters are case sensitive.</p>
<pre><code> if (IsKeyPressed('esc')) { # Is Escape pressed?
if (IsKeyPressed('a')) { # Is a pressed?
if (IsKeyPressed('A')) { # Is A pressed?</code></pre>
<p>Returns non-zero for true, zero for false.</p>
</dd>
</dl>
<dl>
<dt id="IsMouseButtonPressed-BUTTON">IsMouseButtonPressed BUTTON</dt>
<dd>
<p>Determines if the specified mouse button is currently being pressed.</p>
<p>Available mouse buttons are: M_LEFT, M_MIDDLE, M_RIGHT. Also, you could use the logical Id for the button: M_BTN1, M_BTN2, M_BTN3, M_BTN4, M_BTN5. These are all available through the :CONST export tag.</p>
<pre><code> if (IsMouseButtonPressed(M_LEFT)) { # Is left button pressed?</code></pre>
<p>Returns non-zero for true, zero for false.</p>
</dd>
</dl>
<dl>
<dt id="IsWindow-WINDOWID">IsWindow WINDOWID</dt>
<dd>
<p>zero is returned if the specified window Id is not for something that can be recognized as a window. non-zero is returned if it looks like a window.</p>
</dd>
</dl>
<dl>
<dt id="IsWindowViewable-WINDOWID">IsWindowViewable WINDOWID</dt>
<dd>
<p>zero is returned if the specified window Id is for a window that isn't viewable. non-zero is returned if the window is viewable.</p>
</dd>
</dl>
<dl>
<dt id="IsWindowCursor-WINDOWID-CURSOR">IsWindowCursor WINDOWID CURSOR</dt>
<dd>
<p>Determines if the specified window has the specified cursor.</p>
<p>zero is returned for false, non-zero for true.</p>
<p>The following cursors are available through the :CONST export tag.</p>
<pre><code> Name
-------------------
XC_NUM_GLYPHS
XC_X_CURSOR
XC_ARROW
XC_BASED_ARROW_DOWN
XC_BASED_ARROW_UP
XC_BOAT
XC_BOGOSITY
XC_BOTTOM_LEFT_CORNER
XC_BOTTOM_RIGHT_CORNER
XC_BOTTOM_SIDE
XC_BOTTOM_TEE
XC_BOX_SPIRAL
XC_CENTER_PTR
XC_CIRCLE
XC_CLOCK
XC_COFFEE_MUG
XC_CROSS
XC_CROSS_REVERSE
XC_CROSSHAIR
XC_DIAMOND_CROSS
XC_DOT
XC_DOTBOX
XC_DOUBLE_ARROW
XC_DRAFT_LARGE
XC_DRAFT_SMALL
XC_DRAPED_BOX
XC_EXCHANGE
XC_FLEUR
XC_GOBBLER
XC_GUMBY
XC_HAND1
XC_HAND2
XC_HEART
XC_ICON
XC_IRON_CROSS
XC_LEFT_PTR
XC_LEFT_SIDE
XC_LEFT_TEE
XC_LEFTBUTTON
XC_LL_ANGLE
XC_LR_ANGLE
XC_MAN
XC_MIDDLEBUTTON
XC_MOUSE
XC_PENCIL
XC_PIRATE
XC_PLUS
XC_QUESTION_ARROW
XC_RIGHT_PTR
XC_RIGHT_SIDE
XC_RIGHT_TEE
XC_RIGHTBUTTON
XC_RTL_LOGO
XC_SAILBOAT
XC_SB_DOWN_ARROW
XC_SB_H_DOUBLE_ARROW
XC_SB_LEFT_ARROW
XC_SB_RIGHT_ARROW
XC_SB_UP_ARROW
XC_SB_V_DOUBLE_ARROW
XC_SHUTTLE
XC_SIZING
XC_SPIDER
XC_SPRAYCAN
XC_STAR
XC_TARGET
XC_TCROSS
XC_TOP_LEFT_ARROW
XC_TOP_LEFT_CORNER
XC_TOP_RIGHT_CORNER
XC_TOP_SIDE
XC_TOP_TEE
XC_TREK
XC_UL_ANGLE
XC_UMBRELLA
XC_UR_ANGLE
XC_WATCH
XC_XTERM</code></pre>
</dd>
</dl>
<dl>
<dt id="MoveWindow-WINDOWID-X-Y">MoveWindow WINDOWID, X, Y</dt>
<dd>
<p>Moves the window to the specified location.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="ResizeWindow-WINDOWID-WIDTH-HEIGHT">ResizeWindow WINDOWID, WIDTH, HEIGHT</dt>
<dd>
<p>Resizes the window to the specified size.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="IconifyWindow-WINDOWID">IconifyWindow WINDOWID</dt>
<dd>
<p>Minimizes (Iconifies) the specified window.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="UnIconifyWindow-WINDOWID">UnIconifyWindow WINDOWID</dt>
<dd>
<p>Unminimizes (UnIconifies) the specified window.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="RaiseWindow-WINDOWID">RaiseWindow WINDOWID</dt>
<dd>
<p>Raises the specified window to the top of the stack, so that no other windows cover it.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="LowerWindow-WINDOWID">LowerWindow WINDOWID</dt>
<dd>
<p>Lowers the specified window to the bottom of the stack, so other existing windows will cover it.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="GetInputFocus">GetInputFocus</dt>
<dd>
<p>Returns the window that currently has the input focus.</p>
</dd>
</dl>
<dl>
<dt id="SetInputFocus-WINDOWID">SetInputFocus WINDOWID</dt>
<dd>
<p>Sets the specified window to be the one that has the input focus.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt id="GetWindowPos-WINDOWID">GetWindowPos WINDOWID</dt>
<dd>
<p>Returns an array containing the position information for the specified window. It also returns size information (including border width) and the number of the screen where the window resides.</p>
<pre><code> my ($x, $y, $width, $height, $borderWidth, $screen) =
GetWindowPos(GetRootWindow());</code></pre>
</dd>
</dl>
<dl>
<dt id="GetParentWindow-WINDOWID">GetParentWindow WINDOWID</dt>
<dd>
<p>Returns the parent of the specified window.</p>
<p>zero is returned if parent couldn't be determined (i.e., root window).</p>
</dd>
</dl>
<dl>
<dt id="GetScreenDepth-SCREEN">GetScreenDepth [SCREEN]</dt>
<dd>
<p>Returns the color depth for the screen. If no screen is specified, it is taken from the value given when opening the X display. If the screen (number) is invalid, -1 will be returned.</p>
<p>Value is represented as bits, i.e. 16.</p>
<pre><code> my $depth = GetScreenDepth();</code></pre>
</dd>
</dl>
<dl>
<dt id="GetScreenRes-SCREEN">GetScreenRes [SCREEN]</dt>
<dd>
<p>Returns the screen resolution. If no screen is specified, it is taken from the value given when opening the X display. If the screen (number) is invalid, the returned list will be empty.</p>
<pre><code> my ($x, $y) = GetScreenRes();</code></pre>
</dd>
</dl>
<h1 id="OTHER-DOCUMENTATION">OTHER DOCUMENTATION</h1>
<a href='../Changes'>Module Changes</a><br>
<a href='CodingStyle'>Coding-Style Guidelines</a><br>
<a href='../ToDo'>ToDo List</a><br>
<a href='Copying'>Copy of the GPL License</a><br>
<h1 id="COPYRIGHT">COPYRIGHT</h1>
<p>Copyright(c) 2003-2014 Dennis K. Paulsen, All Rights Reserved. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License.</p>
<h1 id="AUTHOR">AUTHOR</h1>
<p>Dennis K. Paulsen <ctrondlp@cpan.org> (Iowa USA)</p>
<h1 id="CONTRIBUTORS">CONTRIBUTORS</h1>
<p>Paulo E. Castro <pauloedgarcastro tata gmail.com></p>
<h1 id="CREDITS">CREDITS</h1>
<p>Thanks to everyone; including those specifically mentioned below for patches, suggestions, etc.:</p>
<pre><code> David Dick
Alexey Tourbin
Richard Clamp
Gustav Larsson
Nelson D. Caro</code></pre>
</body>
</html>
|
