<?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>B<X11::GUITest> - Provides GUI testing/interaction routines.</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">
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<ul>
<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>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p><strong>X11::GUITest</strong> - Provides GUI testing/interaction routines.</p>
<p>Developed by Dennis K. Paulsen</p>
<p>
</p>
<hr />
<h1><a name="version">VERSION</a></h1>
<p>0.27</p>
<p>Updates are made available at the following sites:</p>
<pre>
<a href="http://sourceforge.net/projects/x11guitest">http://sourceforge.net/projects/x11guitest</a>
<a href="http://www.cpan.org">http://www.cpan.org</a></pre>
<p>Please consult 'docs/Changes' for the list of changes between
module revisions.</p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></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 respository.</p>
<p>
</p>
<hr />
<h1><a name="dependencies">DEPENDENCIES</a></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 <code>XTestFakeMotionEvent()</code> 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>
<p>
</p>
<hr />
<h1><a name="installation">INSTALLATION</a></h1>
<pre>
perl Makefile.PL
make
make test
make install</pre>
<pre>
# If you'd like to install the recorder, use these steps:
cd recorder
./autogen.sh
./configure
make
make install
x11guirecord --help</pre>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p>For additional examples, please look under the 'eg/'
sub-directory from the installation folder.</p>
<pre>
use X11::GUITest qw/
StartApp
WaitWindowViewable
SendKeys
/;</pre>
<pre>
# Start gedit application
StartApp('gedit');</pre>
<pre>
# Wait for application window to come up and become viewable.
my ($GEditWinId) = WaitWindowViewable('gedit');
if (!$GEditWinId) {
die("Couldn't find gedit window in time!");
}</pre>
<pre>
# Send text to it
SendKeys("Hello, how are you?\n");</pre>
<pre>
# Close Application (Alt-f, q).
SendKeys('%(f)q');</pre>
<pre>
# 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)');
}</pre>
<p>
</p>
<hr />
<h1><a name="functions">FUNCTIONS</a></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><strong><a name="findwindowlike_titleregex_windowidstartunder" class="item">FindWindowLike TITLEREGEX [, WINDOWIDSTARTUNDER]</a></strong></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>
my @WindowIds = FindWindowLike('gedit');
# Only worry about first window found
my ($WindowId) = FindWindowLike('gedit');</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="waitwindowlike_titleregex_windowidstartunder_maxwaitinseconds" class="item">WaitWindowLike TITLEREGEX [, WINDOWIDSTARTUNDER] [, MAXWAITINSECONDS]</a></strong></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>
my @WindowIds = WaitWindowLike('gedit');
# Only worry about first window found
my ($WindowId) = WaitWindowLike('gedit');</pre>
<pre>
WaitWindowLike('gedit') or die("gedit window not found!");</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="waitwindowviewable_titleregex_windowidstartunder_maxwaitinseconds" class="item">WaitWindowViewable TITLEREGEX [, WINDOWIDSTARTUNDER] [, MAXWAITINSECONDS]</a></strong></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><strong><a name="waitwindowclose_windowid_maxwaitinseconds" class="item">WaitWindowClose WINDOWID [, MAXWAITINSECONDS]</a></strong></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><strong><a name="waitseconds_seconds" class="item">WaitSeconds SECONDS</a></strong></dt>
<dd>
<p>Pauses execution for the specified amount of seconds.</p>
<pre>
WaitSeconds(0.5); # Wait 1/2 second
WaitSeconds(3); # Wait 3 seconds</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="clickwindow_windowid_x_offset_y_offset_button" class="item">ClickWindow WINDOWID [, X Offset] [, Y Offset] [, Button]</a></strong></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><strong><a name="getwindowfrompoint_x_y_screen" class="item">GetWindowFromPoint X, Y [, SCREEN]</a></strong></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><strong><a name="ischild_parentwindowid_windowid" class="item">IsChild PARENTWINDOWID, WINDOWID</a></strong></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><strong><a name="quotestringforsendkeys_string" class="item">QuoteStringForSendKeys STRING</a></strong></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>
# Quote ~, %, etc. as {~}, {%}, etc for literal use in SendKeys.
SendKeys( QuoteStringForSendKeys('Hello: ~%^(){}+#') );
SendKeys( QSfSK('#+#') );</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="startapp_commandline" class="item">StartApp COMMANDLINE</a></strong></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>
StartApp('gedit');</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="runapp_commandline" class="item">RunApp COMMANDLINE</a></strong></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>
RunApp('/work/myapp');</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="clickmousebutton_button" class="item">ClickMouseButton BUTTON</a></strong></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><strong><a name="defaultscreen" class="item">DefaultScreen</a></strong></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><strong><a name="screencount" class="item">ScreenCount</a></strong></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><strong><a name="seteventsenddelay_delayinmilliseconds" class="item">SetEventSendDelay DELAYINMILLISECONDS</a></strong></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><strong><a name="geteventsenddelay" class="item">GetEventSendDelay</a></strong></dt>
<dd>
<p>Returns the current event sending delay amount in milliseconds.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="setkeysenddelay_delayinmilliseconds" class="item">SetKeySendDelay DELAYINMILLISECONDS</a></strong></dt>
<dd>
<p>Sets the milliseconds of delay between keystrokes.</p>
<p>Returns the old delay amount in milliseconds.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="getkeysenddelay" class="item">GetKeySendDelay</a></strong></dt>
<dd>
<p>Returns the current keystroke sending delay amount in milliseconds.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="getwindowname_windowid" class="item">GetWindowName WINDOWID</a></strong></dt>
<dd>
<p>Returns the window name for the specified window Id. undef
is returned if name could not be obtained.</p>
<pre>
# Return the name of the window that has the input focus.
my $WinName = GetWindowName(GetInputFocus());</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="setwindowname_windowid_name" class="item">SetWindowName WINDOWID, NAME</a></strong></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><strong><a name="getrootwindow_screen" class="item">GetRootWindow [SCREEN]</a></strong></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><strong><a name="getchildwindows_windowid" class="item">GetChildWindows WINDOWID</a></strong></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><strong><a name="movemouseabs_x_y_screen" class="item">MoveMouseAbs X, Y [, SCREEN]</a></strong></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><strong><a name="getmousepos" class="item">GetMousePos</a></strong></dt>
<dd>
<p>Returns an array containing the position and the screen (number) of the mouse
cursor.</p>
<pre>
my ($x, $y, $scr_num) = GetMousePos();</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="pressmousebutton_button" class="item">PressMouseButton BUTTON</a></strong></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><strong><a name="releasemousebutton_button" class="item">ReleaseMouseButton BUTTON</a></strong></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><strong><a name="sendkeys_keys" class="item">SendKeys KEYS</a></strong></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>
Modifier Keys:
^ CTRL
% ALT
+ SHIFT
# META
& ALTGR</pre>
<pre>
Other Keys:
~ ENTER
\n ENTER
\t TAB
( and ) MODIFIER GROUPING
{ and } QUOTE / ESCAPE CHARACTERS</pre>
<p>Simply, one can send a text string like so:</p>
<pre>
SendKeys('Hello, how are you today?');</pre>
<p>Parenthesis allow a modifier to work on one or more characters. For example:</p>
<pre>
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</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 preceeding key.</p>
<p>Quote Special Characters</p>
<pre>
SendKeys('{{}'); # {
SendKeys('{+}'); # +
SendKeys('{#}'); # #</pre>
<pre>
You can also use QuoteStringForSendKeys (QSfSK) to perform quoting.</pre>
<p>Aliased Key Names</p>
<pre>
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</pre>
<p>Special Functionality</p>
<pre>
# Pause execution for 500 milliseconds
SendKeys('{PAUSE 500}');</pre>
<p>Combinations</p>
<pre>
SendKeys('abc+(abc){TAB PAUSE 500}'); # a, b, c, A, B, C, Tab, Pause 500
SendKeys('+({a b c})'); # A, B, C</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>
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</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><strong><a name="presskey_key" class="item">PressKey KEY</a></strong></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>
# Alt-n
PressKey('LAL'); # Left Alt
PressKey('n');
ReleaseKey('n');
ReleaseKey('LAL');</pre>
<pre>
# Uppercase a
PressKey('LSH'); # Left Shift
PressKey('a');
ReleaseKey('a');
ReleaseKey('LSH');</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><strong><a name="releasekey_key" class="item">ReleaseKey KEY</a></strong></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>
ReleaseKey('n');</pre>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="pressreleasekey_key" class="item">PressReleaseKey KEY</a></strong></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>
PressReleaseKey('n');</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><strong><a name="iskeypressed_key" class="item">IsKeyPressed KEY</a></strong></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>
if (IsKeyPressed('esc')) { # Is Escape pressed?
if (IsKeyPressed('a')) { # Is a pressed?
if (IsKeyPressed('A')) { # Is A pressed?</pre>
<p>Returns non-zero for true, zero for false.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="ismousebuttonpressed_button" class="item">IsMouseButtonPressed BUTTON</a></strong></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>
if (IsMouseButtonPressed(M_LEFT)) { # Is left button pressed?</pre>
<p>Returns non-zero for true, zero for false.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="iswindow_windowid" class="item">IsWindow WINDOWID</a></strong></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><strong><a name="iswindowviewable_windowid" class="item">IsWindowViewable WINDOWID</a></strong></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><strong><a name="iswindowcursor_windowid_cursor" class="item">IsWindowCursor WINDOWID CURSOR</a></strong></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>
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</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="movewindow_windowid_x_y" class="item">MoveWindow WINDOWID, X, Y</a></strong></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><strong><a name="resizewindow_windowid_width_height" class="item">ResizeWindow WINDOWID, WIDTH, HEIGHT</a></strong></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><strong><a name="iconifywindow_windowid" class="item">IconifyWindow WINDOWID</a></strong></dt>
<dd>
<p>Minimizes (Iconifies) the specified window.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="uniconifywindow_windowid" class="item">UnIconifyWindow WINDOWID</a></strong></dt>
<dd>
<p>Unminimizes (UnIconifies) the specified window.</p>
<p>zero is returned on failure, non-zero for success.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="raisewindow_windowid" class="item">RaiseWindow WINDOWID</a></strong></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><strong><a name="lowerwindow_windowid" class="item">LowerWindow WINDOWID</a></strong></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><strong><a name="getinputfocus" class="item">GetInputFocus</a></strong></dt>
<dd>
<p>Returns the window that currently has the input focus.</p>
</dd>
</dl>
<dl>
<dt><strong><a name="setinputfocus_windowid" class="item">SetInputFocus WINDOWID</a></strong></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><strong><a name="getwindowpos_windowid" class="item">GetWindowPos WINDOWID</a></strong></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>
my ($x, $y, $width, $height, $borderWidth, $screen) =
GetWindowPos(GetRootWindow());</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="getparentwindow_windowid" class="item">GetParentWindow WINDOWID</a></strong></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><strong><a name="getscreendepth_screen" class="item">GetScreenDepth [SCREEN]</a></strong></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>
my $depth = GetScreenDepth();</pre>
</dd>
</dl>
<dl>
<dt><strong><a name="getscreenres_screen" class="item">GetScreenRes [SCREEN]</a></strong></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>
my ($x, $y) = GetScreenRes();</pre>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="other_documentation">OTHER DOCUMENTATION</a></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><p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>Copyright(c) 2003-2011 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>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Dennis K. Paulsen <<a href="mailto:ctrondlp@cpan.org">ctrondlp@cpan.org</a>> (Des Moines, Iowa USA)</p>
<p>
</p>
<hr />
<h1><a name="contributors">CONTRIBUTORS</a></h1>
<p>Paulo E. Castro <pauloedgarcastro tata gmail.com></p>
<p>
</p>
<hr />
<h1><a name="credits">CREDITS</a></h1>
<p>Thanks to everyone; including those specifically mentioned below for patches,
suggestions, etc.:</p>
<pre>
Alexey Tourbin
Richard Clamp
Gustav Larsson
Nelson D. Caro</pre>
</body>
</html>