libcvautomation/libcvautomation-xtest_8h.html

1212 lines
64 KiB
HTML
Raw Normal View History

2012-07-17 16:07:18 -04:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libcvautomation: libcvautomation-xtest.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul></div>
<h1>libcvautomation-xtest.h File Reference</h1>The source code to access the XTest extension inside libcvautomation. <a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="libcvautomation_8h-source.html">libcvautomation/libcvautomation.h</a>&gt;</code><br>
<p>
<a href="libcvautomation-xtest_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#3409a0d4da000192a6561485e1288dfc">IS_CMD</a>(x, y)&nbsp;&nbsp;&nbsp;strncmp( x, y, strlen( y ) ) == 0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks if string <code>'x'</code> is in <code>'y'</code>. <a href="#3409a0d4da000192a6561485e1288dfc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="066e8fa570bba320a3c0a0d44f7e5c4d"></a><!-- doxytag: member="libcvautomation-xtest.h::COMMAND_STR_LEN" ref="066e8fa570bba320a3c0a0d44f7e5c4d" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#066e8fa570bba320a3c0a0d44f7e5c4d">COMMAND_STR_LEN</a>&nbsp;&nbsp;&nbsp;512</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies the maximum length of a command string. <br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#d054a30613fdebf388218ce7c7ba8eaa">xte_XTestSupported</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if the XTest extension is supported. <a href="#d054a30613fdebf388218ce7c7ba8eaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#6b2aaf7275e7671691ff9e09d3365bdb">xte_pointerLocation</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Grab the current location of the pointer. <a href="#6b2aaf7275e7671691ff9e09d3365bdb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#e795b36e13508632ae69e9141dbd9b71">xte_clickMouse</a> (Display *displayLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Click the mouse in its current location. <a href="#e795b36e13508632ae69e9141dbd9b71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#88f51bec45b626f4bf2f1eaf0eb2b570">xte_clickMouseXY</a> (Display *displayLocation, int xLocation, int yLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Click the mouse button at an absolute location. <a href="#88f51bec45b626f4bf2f1eaf0eb2b570"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#94f3c779c24b95d5fb743787a507d49e">xte_clickMouseRXY</a> (Display *displayLocation, int xIncrement, int yIncrement, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Click the mouse button at a relative location. <a href="#94f3c779c24b95d5fb743787a507d49e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#42e82ace64c71fb6cf247ac16ee95da1">xte_clickMouseImage</a> (Display *displayLocation, IplImage *subImage, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Click the mouse based on location of an image. <a href="#42e82ace64c71fb6cf247ac16ee95da1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#db6d976b6b4849a295e02aac2567fa86">xte_clickMouseImage_location</a> (Display *displayLocation, const char *fileName, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Click the mouse based on the location of an image from file. <a href="#db6d976b6b4849a295e02aac2567fa86"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a8f71206992c631e8e2827424b3d6090">xte_clickMouseImage_center</a> (Display *displayLocation, IplImage *subImage, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Click the mouse based on center location of an image. <a href="#a8f71206992c631e8e2827424b3d6090"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#25b98d2e0780ae8f8afc152e620ceaaf">xte_clickMouseImage_location_center</a> (Display *displayLocation, const char *fileName, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Click the mouse based on the center location of an image from file. <a href="#25b98d2e0780ae8f8afc152e620ceaaf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#dcc93e8aa9a0fd445c3c1971e35e194b">xte_hoverMouseXY</a> (Display *displayLocation, int xLocation, int yLocation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the mouse to a location, but do not click it. <a href="#dcc93e8aa9a0fd445c3c1971e35e194b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#8bb400fb20f4416f6f93465935a76be2">xte_hoverMouseRXY</a> (Display *displayLocation, int xIncrement, int yIncrement)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the mouse to a relative location, but do not click it. <a href="#8bb400fb20f4416f6f93465935a76be2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#8827d93f5299e4aa99acc7c2c1d398c4">xte_hoverMouseImage</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the mouse based on location of an image. <a href="#8827d93f5299e4aa99acc7c2c1d398c4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#217328d995073752cd182098f18b3397">xte_hoverMouseImage_location</a> (Display *displayLocation, const char *filename, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the mouse based on location of an image from file. <a href="#217328d995073752cd182098f18b3397"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#9e8b30c7b59467dba853e467153123db">xte_hoverMouseImage_center</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the mouse based on center location of an image. <a href="#9e8b30c7b59467dba853e467153123db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#2b16677d20493c1c4f96c6e43b3fc0b7">xte_hoverMouseImage_location_center</a> (Display *displayLocation, const char *fileName, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the mouse based on the center location of an image from file. <a href="#2b16677d20493c1c4f96c6e43b3fc0b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#09ef864a45f24c7f682c96368a62be4d">xte_mouseDown</a> (Display *displayLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Press a mouse button down, and do not release it. <a href="#09ef864a45f24c7f682c96368a62be4d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#68a7da112f124b61799162923657116a">xte_mouseUp</a> (Display *displayLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release a mouse button. <a href="#68a7da112f124b61799162923657116a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#2431de2ae4b296a9a91da6e20250a67b">xte_mouseJiggle</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Jiggle the mouse in place. <a href="#2431de2ae4b296a9a91da6e20250a67b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acba3ced27f5f489696885508ae01f50"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_mouseScrollUp" ref="acba3ced27f5f489696885508ae01f50" args="(Display *displayLocation)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>xte_mouseScrollUp</b> (Display *displayLocation)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9dac28fe78d3bd977d83d3d6aee31290"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_mouseScrollDown" ref="9dac28fe78d3bd977d83d3d6aee31290" args="(Display *displayLocation)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>xte_mouseScrollDown</b> (Display *displayLocation)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#5ce1dbeb65bba1613e4e6619857b1746">xte_clickKey</a> (Display *displayLocation, char *key)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Press and release a keyboard key. <a href="#5ce1dbeb65bba1613e4e6619857b1746"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#b327a24f45f673a4aeab6dfb7b9e411a">xte_clickKeyStr</a> (Display *displayLocation, char *string)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Input a string of characters to the X Server. <a href="#b327a24f45f673a4aeab6dfb7b9e411a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#04ded64c2bd31804cc109502530890c0">xte_keyDown</a> (Display *displayLocation, char *key)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Press a key down, but do not release it. <a href="#04ded64c2bd31804cc109502530890c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#574402ddf94858b340254a4e444fa404">xte_keyUp</a> (Display *displayLocation, char *key)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release a key. <a href="#574402ddf94858b340254a4e444fa404"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#382af05e5669ea2cbb22608e41cbc49a">xte_commandString</a> (Display *displayLocation, char *commandString, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Execute a command where the command is coming from a string. <a href="#382af05e5669ea2cbb22608e41cbc49a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The source code to access the XTest extension inside libcvautomation.
<p>
This source file builds in the necessary functionality to drive the X11 server in libcvautomation <dl compact><dt><b>Author:</b></dt><dd>Bradlee Speice </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>6/26/2012 </dd></dl>
<p>
Definition in file <a class="el" href="libcvautomation-xtest_8h-source.html">libcvautomation-xtest.h</a>.<hr><h2>Define Documentation</h2>
<a class="anchor" name="3409a0d4da000192a6561485e1288dfc"></a><!-- doxytag: member="libcvautomation-xtest.h::IS_CMD" ref="3409a0d4da000192a6561485e1288dfc" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IS_CMD </td>
<td>(</td>
<td class="paramtype">x, <tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">y&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%">&nbsp;&nbsp;&nbsp;strncmp( x, y, strlen( y ) ) == 0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if string <code>'x'</code> is in <code>'y'</code>.
<p>
Performs a safe check to see if x is in y - this way, you can check that <code>"command"</code> is inside <code>"command argument"</code>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="d054a30613fdebf388218ce7c7ba8eaa"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_XTestSupported" ref="d054a30613fdebf388218ce7c7ba8eaa" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool xte_XTestSupported </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the XTest extension is supported.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display to check if XTest is supported on </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True if XTest is supported, False otherwise </dd></dl>
<p>
Referenced by <a class="el" href="cva-input_8c-source.html#l00204">checkXTEEnabled()</a>.
</div>
</div><p>
<a class="anchor" name="6b2aaf7275e7671691ff9e09d3365bdb"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_pointerLocation" ref="6b2aaf7275e7671691ff9e09d3365bdb" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_pointerLocation </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Grab the current location of the pointer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to grab the pointer location from </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="structcvaPoint.html">cvaPoint</a> with the current location of the pointer </dd></dl>
</div>
</div><p>
<a class="anchor" name="e795b36e13508632ae69e9141dbd9b71"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickMouse" ref="e795b36e13508632ae69e9141dbd9b71" args="(Display *displayLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_clickMouse </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Click the mouse in its current location.
<p>
Perform a mouse-down and mouse-up event on button <code>mouseButton</code> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="88f51bec45b626f4bf2f1eaf0eb2b570"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickMouseXY" ref="88f51bec45b626f4bf2f1eaf0eb2b570" args="(Display *displayLocation, int xLocation, int yLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_clickMouseXY </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>xLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>yLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Click the mouse button at an absolute location.
<p>
Move the mouse to location (<code>xLocation</code>, <code>yLocation</code> ) and then click button <code>mouseButton</code> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>xLocation</em>&nbsp;</td><td>The X-coordinate to move the mouse to before clicking </td></tr>
<tr><td valign="top"></td><td valign="top"><em>yLocation</em>&nbsp;</td><td>The Y-location to move the mouse to before clicking </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="94f3c779c24b95d5fb743787a507d49e"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickMouseRXY" ref="94f3c779c24b95d5fb743787a507d49e" args="(Display *displayLocation, int xIncrement, int yIncrement, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_clickMouseRXY </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>xIncrement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>yIncrement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Click the mouse button at a relative location.
<p>
Move the mouse horizontally <code>xIncrement</code> and vertically <code>yIncrement</code> before clicking button <code>mouseButton</code> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>xIncrement</em>&nbsp;</td><td>Move the mouse horizontally this many pixels - positive value is motion to the right </td></tr>
<tr><td valign="top"></td><td valign="top"><em>yIncrement</em>&nbsp;</td><td>Move the mouse vertically this many pixels - positive value is motion downwards </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="42e82ace64c71fb6cf247ac16ee95da1"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickMouseImage" ref="42e82ace64c71fb6cf247ac16ee95da1" args="(Display *displayLocation, IplImage *subImage, int mouseButton, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_clickMouseImage </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&nbsp;</td>
<td class="paramname"> <em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Click the mouse based on location of an image.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding <code>subImage</code> in this display, moving the mouse to that location, and then clicking <code>mouseButton</code>. The return value can be ignored, the mouse will already have been clicked there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage</em>&nbsp;</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked. </dd></dl>
</div>
</div><p>
<a class="anchor" name="db6d976b6b4849a295e02aac2567fa86"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickMouseImage_location" ref="db6d976b6b4849a295e02aac2567fa86" args="(Display *displayLocation, const char *fileName, int mouseButton, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_clickMouseImage_location </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Click the mouse based on the location of an image from file.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding the sub image from <code>fileName</code> in this display, moving the mouse to that location, and then clicking <code>mouseButton</code>. The return value can be ignored, the mouse will already have been clicked there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fileName</em>&nbsp;</td><td>The file name from which to load the sub-image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a8f71206992c631e8e2827424b3d6090"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickMouseImage_center" ref="a8f71206992c631e8e2827424b3d6090" args="(Display *displayLocation, IplImage *subImage, int mouseButton, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_clickMouseImage_center </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&nbsp;</td>
<td class="paramname"> <em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Click the mouse based on center location of an image.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding the center of <code>subImage</code> in this display, moving the mouse to that location, and then clicking <code>mouseButton</code>. The return value can be ignored, the mouse will already have been clicked there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage</em>&nbsp;</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked. </dd></dl>
</div>
</div><p>
<a class="anchor" name="25b98d2e0780ae8f8afc152e620ceaaf"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickMouseImage_location_center" ref="25b98d2e0780ae8f8afc152e620ceaaf" args="(Display *displayLocation, const char *fileName, int mouseButton, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_clickMouseImage_location_center </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Click the mouse based on the center location of an image from file.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding the center location of the sub image from <code>fileName</code> in this display, moving the mouse to that location, and then clicking <code>mouseButton</code>. The return value can be ignored, the mouse will already have been clicked there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fileName</em>&nbsp;</td><td>The file name from which to load the sub-image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked. </dd></dl>
</div>
</div><p>
<a class="anchor" name="dcc93e8aa9a0fd445c3c1971e35e194b"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_hoverMouseXY" ref="dcc93e8aa9a0fd445c3c1971e35e194b" args="(Display *displayLocation, int xLocation, int yLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_hoverMouseXY </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>xLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>yLocation</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the mouse to a location, but do not click it.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to move the mouse </td></tr>
<tr><td valign="top"></td><td valign="top"><em>xLocation</em>&nbsp;</td><td>The X-coordinate of which to move the mouse </td></tr>
<tr><td valign="top"></td><td valign="top"><em>yLocation</em>&nbsp;</td><td>The Y-coordinate of which to move the mouse </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8bb400fb20f4416f6f93465935a76be2"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_hoverMouseRXY" ref="8bb400fb20f4416f6f93465935a76be2" args="(Display *displayLocation, int xIncrement, int yIncrement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_hoverMouseRXY </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>xIncrement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>yIncrement</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the mouse to a relative location, but do not click it.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to move the mouse </td></tr>
<tr><td valign="top"></td><td valign="top"><em>xIncrement</em>&nbsp;</td><td>How far to move the mouse horizontally. Positive values indicate motion to the right. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>yIncrement</em>&nbsp;</td><td>How far to move the mouse vertically. Positive values indicate motion downward. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8827d93f5299e4aa99acc7c2c1d398c4"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_hoverMouseImage" ref="8827d93f5299e4aa99acc7c2c1d398c4" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_hoverMouseImage </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&nbsp;</td>
<td class="paramname"> <em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the mouse based on location of an image.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding <code>subImage</code> in this display, and then moving the mouse to that location. The return value can be ignored, the mouse will already have been moved there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to move the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage</em>&nbsp;</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved. </dd></dl>
</div>
</div><p>
<a class="anchor" name="217328d995073752cd182098f18b3397"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_hoverMouseImage_location" ref="217328d995073752cd182098f18b3397" args="(Display *displayLocation, const char *filename, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_hoverMouseImage_location </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the mouse based on location of an image from file.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding the sub image from <code>fileName</code> in this display, and then moving the mouse to that location. The return value can be ignored, the mouse will already have been moved there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to move the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The file name from which to load the sub-image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9e8b30c7b59467dba853e467153123db"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_hoverMouseImage_center" ref="9e8b30c7b59467dba853e467153123db" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_hoverMouseImage_center </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&nbsp;</td>
<td class="paramname"> <em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the mouse based on center location of an image.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding the center of <code>subImage</code> in this display, and then moving the mouse to that location. The return value can be ignored, the mouse will already have been moved there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to move the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>subImage</em>&nbsp;</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2b16677d20493c1c4f96c6e43b3fc0b7"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_hoverMouseImage_location_center" ref="2b16677d20493c1c4f96c6e43b3fc0b7" args="(Display *displayLocation, const char *fileName, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_hoverMouseImage_location_center </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the mouse based on the center location of an image from file.
<p>
Wraps grabbing the X11 root window of <code>displayLocation</code>, finding the center location of the sub image from <code>fileName</code> in this display, and then moving the mouse to that location. The return value can be ignored, the mouse will already have been moved there. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to move the mouse on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fileName</em>&nbsp;</td><td>The file name from which to load the sub-image </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved. </dd></dl>
</div>
</div><p>
<a class="anchor" name="09ef864a45f24c7f682c96368a62be4d"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_mouseDown" ref="09ef864a45f24c7f682c96368a62be4d" args="(Display *displayLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_mouseDown </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Press a mouse button down, and do not release it.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to push a mouse button down </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to push down </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="68a7da112f124b61799162923657116a"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_mouseUp" ref="68a7da112f124b61799162923657116a" args="(Display *displayLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_mouseUp </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release a mouse button.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to release a mouse button </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to release </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2431de2ae4b296a9a91da6e20250a67b"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_mouseJiggle" ref="2431de2ae4b296a9a91da6e20250a67b" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_mouseJiggle </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Jiggle the mouse in place.
<p>
This moves the mouse down and right one pixel, and then back. This may be needed to activate menu items, etc. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to move the mouse </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5ce1dbeb65bba1613e4e6619857b1746"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickKey" ref="5ce1dbeb65bba1613e4e6619857b1746" args="(Display *displayLocation, char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_clickKey </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>key</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Press and release a keyboard key.
<p>
This method allows you to press and release a key, where the key may be <code>'a'</code>, <code>'b'</code>, or maybe something fancy like <code>'space'</code>. Please see <a class="el" href="XTest_key_strings.html">XTest Key Strings</a> for a full list of keys. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to click a key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The key to click as a string </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="XTest_key_strings.html">XTest Key Strings</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b327a24f45f673a4aeab6dfb7b9e411a"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_clickKeyStr" ref="b327a24f45f673a4aeab6dfb7b9e411a" args="(Display *displayLocation, char *string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_clickKeyStr </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>string</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Input a string of characters to the X Server.
<p>
Instead of specifying a single character to enter at a time (<code>'a'</code>, <code>'space'</code>) this function allows you to enter an entire string (<code>'Hello</code>, World!') at a time. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to enter a key string on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em>&nbsp;</td><td>The key string to input to the X Server </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="04ded64c2bd31804cc109502530890c0"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_keyDown" ref="04ded64c2bd31804cc109502530890c0" args="(Display *displayLocation, char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_keyDown </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>key</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Press a key down, but do not release it.
<p>
This method allows you to push down a key, where the key may be <code>'a'</code>, <code>'b'</code>, or maybe something fancy like <code>'space'</code>. Please see <a class="el" href="XTest_key_strings.html">XTest Key Strings</a> for a full list of keys. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to push down a key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The key to click as a string </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="XTest_key_strings.html">XTest Key Strings</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="574402ddf94858b340254a4e444fa404"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_keyUp" ref="574402ddf94858b340254a4e444fa404" args="(Display *displayLocation, char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xte_keyUp </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>key</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release a key.
<p>
This method allows you to release a key, where the key may be <code>'a'</code>, <code>'b'</code>, or maybe something fancy like <code>'space'</code>. Please see <a class="el" href="XTest_key_strings.html">XTest Key Strings</a> for a full list of keys. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to release a key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The key to click as a string </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="XTest_key_strings.html">XTest Key Strings</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="382af05e5669ea2cbb22608e41cbc49a"></a><!-- doxytag: member="libcvautomation-xtest.h::xte_commandString" ref="382af05e5669ea2cbb22608e41cbc49a" args="(Display *displayLocation, char *commandString, int mouseButton, int searchMethod, int tolerance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> xte_commandString </td>
<td>(</td>
<td class="paramtype">Display *&nbsp;</td>
<td class="paramname"> <em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&nbsp;</td>
<td class="paramname"> <em>commandString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>tolerance</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Execute a command where the command is coming from a string.
<p>
This function allows you to input a command to libcvautomation from a string. For example, to click a mouse button, you would use the <code>command</code> 'mouseclick'. Please note that some <code>command</code>s may need arguments to the string, and some may use function arguments. See <a class="el" href="XTest_command_strings.html">xte_commandString() Command Strings</a> for a full list of command and arguments <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocation</em>&nbsp;</td><td>The Display of which to operate on </td></tr>
<tr><td valign="top"></td><td valign="top"><em>commandString</em>&nbsp;</td><td>The command string to execute - limit to <a class="el" href="libcvautomation-xtest_8h.html#066e8fa570bba320a3c0a0d44f7e5c4d">COMMAND_STR_LEN</a> characters </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mouseButton</em>&nbsp;</td><td>The mouse button to click if it is needed by the command being executed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>searchMethod</em>&nbsp;</td><td>The search method to use if it is needed by the command being executed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance to use if it is needed by the command being executed </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="XTest_command_strings.html">xte_commandString() Command Strings</a> <p>
<a class="el" href="libcv_search_methods.html">Libcv Search Methods</a> </dd></dl>
<p>
Referenced by <a class="el" href="cva-input_8c-source.html#l00030">main()</a>.
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 17 12:19:00 2012 for libcvautomation by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>