mirror-github-bspeice/libcvautomation
1
0
Fork 0
mirror of https://github.com/bspeice/libcvautomation synced 2024-12-04 13:58:11 -05:00
Code Issues Releases Wiki Activity
gh-pages
libcvautomation/libcvautomation-xtest_8h.html

1566 lines
82 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libcvautomation: libcvautomation-xtest.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://www.mathjax.org/mathjax/MathJax.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libcvautomation
&#160;<span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">libcvautomation-xtest.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The source code to access the XTest extension inside libcvautomation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="libcvautomation_8h_source.html">libcvautomation/libcvautomation.h</a>&gt;</code><br/>
</div>
<p><a href="libcvautomation-xtest_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#ae9d8d80e438d68a6c57c02d7217df1bd">IS_CMD</a>(x, y)&#160;&#160;&#160;strncmp( x, y, strlen( y ) ) == 0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if string <code>'x'</code> is in <code>'y'</code>. <a href="#ae9d8d80e438d68a6c57c02d7217df1bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17af6c2b164a04cae831df5fb93836f6"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::COMMAND_STR_LEN" ref="a17af6c2b164a04cae831df5fb93836f6" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a17af6c2b164a04cae831df5fb93836f6">COMMAND_STR_LEN</a>&#160;&#160;&#160;512</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the maximum length of a command string. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#af5b751f28a87f6ca4c1b3969c2ddb7f4">xte_XTestSupported</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the XTest extension is supported. <a href="#af5b751f28a87f6ca4c1b3969c2ddb7f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#aaa6da04691328c02b3fc3442eaa9bb44">xte_mouseLocation</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Grab the current location of the mouse. <a href="#aaa6da04691328c02b3fc3442eaa9bb44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a8a95419cacd3a0efbd4bb6274567e284">xte_clickMouse</a> (Display *displayLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Click the mouse in its current location. <a href="#a8a95419cacd3a0efbd4bb6274567e284"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a808386f36914966032aa2e15fd5ef60b">xte_clickMouseXY</a> (Display *displayLocation, int xLocation, int yLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Click the mouse button at an absolute location. <a href="#a808386f36914966032aa2e15fd5ef60b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a54df9f6d2278b6c840299f1f8ff94576">xte_clickMouseRXY</a> (Display *displayLocation, int xIncrement, int yIncrement, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Click the mouse button at a relative location. <a href="#a54df9f6d2278b6c840299f1f8ff94576"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#afa808d82bff7531af99d20b5397f4810">xte_clickMouseImage</a> (Display *displayLocation, IplImage *subImage, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Click the mouse based on location of an image. <a href="#afa808d82bff7531af99d20b5397f4810"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#aa8e0c08cbca4f2863c4feda535c34bf5">xte_clickMouseImage_location</a> (Display *displayLocation, const char *fileName, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Click the mouse based on the location of an image from file. <a href="#aa8e0c08cbca4f2863c4feda535c34bf5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#aa167cd70fe8284dbccbbd42cd4878b3e">xte_clickMouseImage_center</a> (Display *displayLocation, IplImage *subImage, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Click the mouse based on center location of an image. <a href="#aa167cd70fe8284dbccbbd42cd4878b3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a40ca9d0d71b8f7cc513c27a9b0171995">xte_clickMouseImage_location_center</a> (Display *displayLocation, const char *fileName, int mouseButton, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Click the mouse based on the center location of an image from file. <a href="#a40ca9d0d71b8f7cc513c27a9b0171995"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a16e54e500caa43ab825a2039be9aabf9">xte_hoverMouseXY</a> (Display *displayLocation, int xLocation, int yLocation)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the mouse to a location, but do not click it. <a href="#a16e54e500caa43ab825a2039be9aabf9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#ab86c2de782d401599652f2856f311aad">xte_hoverMouseRXY</a> (Display *displayLocation, int xIncrement, int yIncrement)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the mouse to a relative location, but do not click it. <a href="#ab86c2de782d401599652f2856f311aad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a657631e704e31818b42587ef50724930">xte_hoverMouseImage</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the mouse based on location of an image. <a href="#a657631e704e31818b42587ef50724930"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#ad274843eaaed7af192f09310caa9e5b2">xte_hoverMouseImage_location</a> (Display *displayLocation, const char *filename, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the mouse based on location of an image from file. <a href="#ad274843eaaed7af192f09310caa9e5b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a72f049ae7ade76344e47d01ba451e8f1">xte_hoverMouseImage_center</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the mouse based on center location of an image. <a href="#a72f049ae7ade76344e47d01ba451e8f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#acdcc9eb1e6633458ebb6ec0c7b57ba26">xte_hoverMouseImage_location_center</a> (Display *displayLocation, const char *fileName, int searchMethod, int tolerance)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the mouse based on the center location of an image from file. <a href="#acdcc9eb1e6633458ebb6ec0c7b57ba26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#acca8cce58009ce177265bea29e8223e8">xte_mouseDown</a> (Display *displayLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Press a mouse button down, and do not release it. <a href="#acca8cce58009ce177265bea29e8223e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a317610586ac31c5c501290099b7ebf63">xte_mouseUp</a> (Display *displayLocation, int mouseButton)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Release a mouse button. <a href="#a317610586ac31c5c501290099b7ebf63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#ad4a4b4739bf494478dccb520d6946fbd">xte_mouseJiggle</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Jiggle the mouse in place. <a href="#ad4a4b4739bf494478dccb520d6946fbd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a18f5cc7307329ce2e13ceb25b274822b">xte_mouseScrollUp</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Scroll the mouse up. <a href="#a18f5cc7307329ce2e13ceb25b274822b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a5942cc208d0adc9ac8f74175803466b5">xte_mouseScrollDown</a> (Display *displayLocation)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Scroll the mouse down. <a href="#a5942cc208d0adc9ac8f74175803466b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#aa5d0f5167ac455ac88d063450b8aaac6">xte_clickKey</a> (Display *displayLocation, char *key)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Press and release a keyboard key. <a href="#aa5d0f5167ac455ac88d063450b8aaac6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a1411973d9245ac1d610988a965ceb5a7">xte_clickKeyStr</a> (Display *displayLocation, char *string)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Input a string of characters to the X Server. <a href="#a1411973d9245ac1d610988a965ceb5a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#ad1d7153af9ed5cb2ba3b6d2a89c4ec75">xte_keyDown</a> (Display *displayLocation, char *key)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Press a key down, but do not release it. <a href="#ad1d7153af9ed5cb2ba3b6d2a89c4ec75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a6af5c14f862dd91fec682fde44a10e23">xte_keyUp</a> (Display *displayLocation, char *key)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Release a key. <a href="#a6af5c14f862dd91fec682fde44a10e23"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#abfbad79445cce59c95940649210f1b31">xte_waitForImage</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance, int timeout)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for an image to show up on screen. <a href="#abfbad79445cce59c95940649210f1b31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a3f474b9f3ae44e2fcf8997a2a806139e">xte_waitForImage_location</a> (Display *displayLocation, const char *fileName, int searchMethod, int tolerance, int timeout)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for an image from file to show up on screen. <a href="#a3f474b9f3ae44e2fcf8997a2a806139e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a6c246fab2cf1e45eb11f519d805e0fb2">xte_waitForImage_center</a> (Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance, int timeout)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for an image to show up on screen, return the center point. <a href="#a6c246fab2cf1e45eb11f519d805e0fb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#ac95300b7c9f5310967e8ffe793c9c8e9">xte_waitForImage_location_center</a> (Display *displayLocation, const char *fileName, int searchMethod, int tolerance, int timeout)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for an image from file to show up on screen, return the center point. <a href="#ac95300b7c9f5310967e8ffe793c9c8e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcvaPoint.html">cvaPoint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="libcvautomation-xtest_8h.html#a7ea1430ed90d3166f8d9fbb4e240a28f">xte_commandString</a> (Display *displayLocation, char *commandString, int mouseButton, int searchMethod, int tolerance, int timeout)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute a command where the command is coming from a string. <a href="#a7ea1430ed90d3166f8d9fbb4e240a28f"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The source code to access the XTest extension inside libcvautomation. </p>
<p>This source file builds in the necessary functionality to drive the X11 server in libcvautomation </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Bradlee Speice </dd></dl>
<p>Definition in file <a class="el" href="libcvautomation-xtest_8h_source.html">libcvautomation-xtest.h</a>.</p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="ae9d8d80e438d68a6c57c02d7217df1bd"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::IS_CMD" ref="ae9d8d80e438d68a6c57c02d7217df1bd" args="(x, y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="libcvautomation-xtest_8h.html#ae9d8d80e438d68a6c57c02d7217df1bd">IS_CMD</a></td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">y&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;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>
<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> </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="af5b751f28a87f6ca4c1b3969c2ddb7f4"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_XTestSupported" ref="af5b751f28a87f6ca4c1b3969c2ddb7f4" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool <a class="el" href="libcvautomation-xtest_8h.html#af5b751f28a87f6ca4c1b3969c2ddb7f4">xte_XTestSupported</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the XTest extension is supported. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display to check if XTest is supported on </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if XTest is supported, False otherwise </dd></dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>The program using this library is responsible for checking to see if XTest is supported. </dd></dl>
</div>
</div>
<a class="anchor" id="aaa6da04691328c02b3fc3442eaa9bb44"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_mouseLocation" ref="aaa6da04691328c02b3fc3442eaa9bb44" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xtest_8h.html#aaa6da04691328c02b3fc3442eaa9bb44">xte_mouseLocation</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Grab the current location of the mouse. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to grab the mouse location from </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="structcvaPoint.html" title="Very simple structure to standardize how points are used in libcvautomation.">cvaPoint</a> with the current location of the mouse </dd></dl>
</div>
</div>
<a class="anchor" id="a8a95419cacd3a0efbd4bb6274567e284"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickMouse" ref="a8a95419cacd3a0efbd4bb6274567e284" args="(Display *displayLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a8a95419cacd3a0efbd4bb6274567e284">xte_clickMouse</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Click the mouse in its current location. </p>
<p>Perform a mouse-down and mouse-up event on button <code>mouseButton</code> </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click the mouse on </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a808386f36914966032aa2e15fd5ef60b"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickMouseXY" ref="a808386f36914966032aa2e15fd5ef60b" args="(Display *displayLocation, int xLocation, int yLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a808386f36914966032aa2e15fd5ef60b">xte_clickMouseXY</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>xLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>yLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Click the mouse button at an absolute location. </p>
<p>Move the mouse to location (<code>xLocation</code>, <code>yLocation</code> ) and then click button <code>mouseButton</code> </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click the mouse on </td></tr>
<tr><td class="paramname">xLocation</td><td>The X-coordinate to move the mouse to before clicking </td></tr>
<tr><td class="paramname">yLocation</td><td>The Y-location to move the mouse to before clicking </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a54df9f6d2278b6c840299f1f8ff94576"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickMouseRXY" ref="a54df9f6d2278b6c840299f1f8ff94576" args="(Display *displayLocation, int xIncrement, int yIncrement, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a54df9f6d2278b6c840299f1f8ff94576">xte_clickMouseRXY</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>xIncrement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>yIncrement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Click the mouse button at a relative location. </p>
<p>Move the mouse horizontally <code>xIncrement</code> and vertically <code>yIncrement</code> before clicking button <code>mouseButton</code> </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click the mouse on </td></tr>
<tr><td class="paramname">xIncrement</td><td>Move the mouse horizontally this many pixels - positive value is motion to the right </td></tr>
<tr><td class="paramname">yIncrement</td><td>Move the mouse vertically this many pixels - positive value is motion downwards </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afa808d82bff7531af99d20b5397f4810"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickMouseImage" ref="afa808d82bff7531af99d20b5397f4810" 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> <a class="el" href="libcvautomation-xtest_8h.html#afa808d82bff7531af99d20b5397f4810">xte_clickMouseImage</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&#160;</td>
<td class="paramname"><em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Click the mouse based on location of an image. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click the mouse on </td></tr>
<tr><td class="paramname">subImage</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="aa8e0c08cbca4f2863c4feda535c34bf5"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickMouseImage_location" ref="aa8e0c08cbca4f2863c4feda535c34bf5" 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> <a class="el" href="libcvautomation-xtest_8h.html#aa8e0c08cbca4f2863c4feda535c34bf5">xte_clickMouseImage_location</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Click the mouse based on the location of an image from file. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click the mouse on </td></tr>
<tr><td class="paramname">fileName</td><td>The file name from which to load the sub-image </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="aa167cd70fe8284dbccbbd42cd4878b3e"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickMouseImage_center" ref="aa167cd70fe8284dbccbbd42cd4878b3e" 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> <a class="el" href="libcvautomation-xtest_8h.html#aa167cd70fe8284dbccbbd42cd4878b3e">xte_clickMouseImage_center</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&#160;</td>
<td class="paramname"><em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Click the mouse based on center location of an image. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click the mouse on </td></tr>
<tr><td class="paramname">subImage</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="a40ca9d0d71b8f7cc513c27a9b0171995"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickMouseImage_location_center" ref="a40ca9d0d71b8f7cc513c27a9b0171995" 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> <a class="el" href="libcvautomation-xtest_8h.html#a40ca9d0d71b8f7cc513c27a9b0171995">xte_clickMouseImage_location_center</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Click the mouse based on the center location of an image from file. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click the mouse on </td></tr>
<tr><td class="paramname">fileName</td><td>The file name from which to load the sub-image </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="a16e54e500caa43ab825a2039be9aabf9"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_hoverMouseXY" ref="a16e54e500caa43ab825a2039be9aabf9" args="(Display *displayLocation, int xLocation, int yLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a16e54e500caa43ab825a2039be9aabf9">xte_hoverMouseXY</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>xLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>yLocation</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the mouse to a location, but do not click it. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to move the mouse </td></tr>
<tr><td class="paramname">xLocation</td><td>The X-coordinate of which to move the mouse </td></tr>
<tr><td class="paramname">yLocation</td><td>The Y-coordinate of which to move the mouse </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab86c2de782d401599652f2856f311aad"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_hoverMouseRXY" ref="ab86c2de782d401599652f2856f311aad" args="(Display *displayLocation, int xIncrement, int yIncrement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#ab86c2de782d401599652f2856f311aad">xte_hoverMouseRXY</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>xIncrement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>yIncrement</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the mouse to a relative location, but do not click it. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to move the mouse </td></tr>
<tr><td class="paramname">xIncrement</td><td>How far to move the mouse horizontally. Positive values indicate motion to the right. </td></tr>
<tr><td class="paramname">yIncrement</td><td>How far to move the mouse vertically. Positive values indicate motion downward. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a657631e704e31818b42587ef50724930"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_hoverMouseImage" ref="a657631e704e31818b42587ef50724930" 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> <a class="el" href="libcvautomation-xtest_8h.html#a657631e704e31818b42587ef50724930">xte_hoverMouseImage</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&#160;</td>
<td class="paramname"><em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the mouse based on location of an image. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to move the mouse on </td></tr>
<tr><td class="paramname">subImage</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="ad274843eaaed7af192f09310caa9e5b2"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_hoverMouseImage_location" ref="ad274843eaaed7af192f09310caa9e5b2" 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> <a class="el" href="libcvautomation-xtest_8h.html#ad274843eaaed7af192f09310caa9e5b2">xte_hoverMouseImage_location</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the mouse based on location of an image from file. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to move the mouse on </td></tr>
<tr><td class="paramname">filename</td><td>The file name from which to load the sub-image </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="a72f049ae7ade76344e47d01ba451e8f1"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_hoverMouseImage_center" ref="a72f049ae7ade76344e47d01ba451e8f1" 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> <a class="el" href="libcvautomation-xtest_8h.html#a72f049ae7ade76344e47d01ba451e8f1">xte_hoverMouseImage_center</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&#160;</td>
<td class="paramname"><em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the mouse based on center location of an image. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to move the mouse on </td></tr>
<tr><td class="paramname">subImage</td><td>The sub image (in IplImage format) to find in the root X11 window </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>subImage</code> in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="acdcc9eb1e6633458ebb6ec0c7b57ba26"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_hoverMouseImage_location_center" ref="acdcc9eb1e6633458ebb6ec0c7b57ba26" 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> <a class="el" href="libcvautomation-xtest_8h.html#acdcc9eb1e6633458ebb6ec0c7b57ba26">xte_hoverMouseImage_location_center</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the mouse based on the center location of an image from file. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to move the mouse on </td></tr>
<tr><td class="paramname">fileName</td><td>The file name from which to load the sub-image </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for the sub image in the root X11 window </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for the sub image in the root X11 window </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
<dl class="return"><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>
<a class="anchor" id="acca8cce58009ce177265bea29e8223e8"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_mouseDown" ref="acca8cce58009ce177265bea29e8223e8" args="(Display *displayLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#acca8cce58009ce177265bea29e8223e8">xte_mouseDown</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Press a mouse button down, and do not release it. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to push a mouse button down </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to push down </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a317610586ac31c5c501290099b7ebf63"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_mouseUp" ref="a317610586ac31c5c501290099b7ebf63" args="(Display *displayLocation, int mouseButton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a317610586ac31c5c501290099b7ebf63">xte_mouseUp</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release a mouse button. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to release a mouse button </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to release </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad4a4b4739bf494478dccb520d6946fbd"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_mouseJiggle" ref="ad4a4b4739bf494478dccb520d6946fbd" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#ad4a4b4739bf494478dccb520d6946fbd">xte_mouseJiggle</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jiggle the mouse in place. </p>
<p>This moves the mouse down and right one pixel, and then back. This may be needed to activate menu items, etc. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to move the mouse </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a18f5cc7307329ce2e13ceb25b274822b"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_mouseScrollUp" ref="a18f5cc7307329ce2e13ceb25b274822b" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a18f5cc7307329ce2e13ceb25b274822b">xte_mouseScrollUp</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scroll the mouse up. </p>
<p>This moves the mouse scroll wheel up one rotation, which may be multiple lines. What this really does is click mouse button 4. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to scroll the mouse </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5942cc208d0adc9ac8f74175803466b5"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_mouseScrollDown" ref="a5942cc208d0adc9ac8f74175803466b5" args="(Display *displayLocation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a5942cc208d0adc9ac8f74175803466b5">xte_mouseScrollDown</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scroll the mouse down. </p>
<p>This moves the mouse scroll wheel down one rotation, which may be multiple lines. What this really does is click mouse button 5. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to scroll the mouse </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa5d0f5167ac455ac88d063450b8aaac6"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickKey" ref="aa5d0f5167ac455ac88d063450b8aaac6" args="(Display *displayLocation, char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#aa5d0f5167ac455ac88d063450b8aaac6">xte_clickKey</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Press and release a keyboard key. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to click a key </td></tr>
<tr><td class="paramname">key</td><td>The key to click as a string </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="xtest_key_strings.html">XTest Key Strings</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1411973d9245ac1d610988a965ceb5a7"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_clickKeyStr" ref="a1411973d9245ac1d610988a965ceb5a7" args="(Display *displayLocation, char *string)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a1411973d9245ac1d610988a965ceb5a7">xte_clickKeyStr</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>string</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Input a string of characters to the X Server. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to enter a key string on </td></tr>
<tr><td class="paramname">string</td><td>The key string to input to the X Server </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad1d7153af9ed5cb2ba3b6d2a89c4ec75"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_keyDown" ref="ad1d7153af9ed5cb2ba3b6d2a89c4ec75" args="(Display *displayLocation, char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#ad1d7153af9ed5cb2ba3b6d2a89c4ec75">xte_keyDown</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Press a key down, but do not release it. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to push down a key </td></tr>
<tr><td class="paramname">key</td><td>The key to click as a string </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="xtest_key_strings.html">XTest Key Strings</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6af5c14f862dd91fec682fde44a10e23"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_keyUp" ref="a6af5c14f862dd91fec682fde44a10e23" args="(Display *displayLocation, char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="libcvautomation-xtest_8h.html#a6af5c14f862dd91fec682fde44a10e23">xte_keyUp</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>key</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release a key. </p>
<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. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to release a key </td></tr>
<tr><td class="paramname">key</td><td>The key to click as a string </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="xtest_key_strings.html">XTest Key Strings</a> </dd></dl>
</div>
</div>
<a class="anchor" id="abfbad79445cce59c95940649210f1b31"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_waitForImage" ref="abfbad79445cce59c95940649210f1b31" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance, int timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xtest_8h.html#abfbad79445cce59c95940649210f1b31">xte_waitForImage</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&#160;</td>
<td class="paramname"><em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for an image to show up on screen. </p>
<p>This method allows you to search for an image on screen and wait for it to show up - this way you can make sure an image exists, and then respond to it. Also makes error checking easy. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to search for an image </td></tr>
<tr><td class="paramname">subImage</td><td>The sub image to search for </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>tolerance</code> </td></tr>
<tr><td class="paramname">timeout</td><td>The time (in seconds) to search for the image </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3f474b9f3ae44e2fcf8997a2a806139e"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_waitForImage_location" ref="a3f474b9f3ae44e2fcf8997a2a806139e" args="(Display *displayLocation, const char *fileName, int searchMethod, int tolerance, int timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xtest_8h.html#a3f474b9f3ae44e2fcf8997a2a806139e">xte_waitForImage_location</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for an image from file to show up on screen. </p>
<p>This method allows you to search for an image on screen and wait for it to show up - this way you can make sure an image exists, and then respond to it. Also makes error checking easy. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to search for an image </td></tr>
<tr><td class="paramname">fileName</td><td>The file to load an image from before searching </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>tolerance</code> </td></tr>
<tr><td class="paramname">timeout</td><td>The time (in seconds) to search for the image </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6c246fab2cf1e45eb11f519d805e0fb2"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_waitForImage_center" ref="a6c246fab2cf1e45eb11f519d805e0fb2" args="(Display *displayLocation, IplImage *subImage, int searchMethod, int tolerance, int timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xtest_8h.html#a6c246fab2cf1e45eb11f519d805e0fb2">xte_waitForImage_center</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IplImage *&#160;</td>
<td class="paramname"><em>subImage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for an image to show up on screen, return the center point. </p>
<p>This method allows you to search for an image on screen and wait for it to show up - this way you can make sure an image exists, and then respond to it. Also makes error checking easy. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to search for an image </td></tr>
<tr><td class="paramname">subImage</td><td>The sub image to search for </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>tolerance</code> </td></tr>
<tr><td class="paramname">timeout</td><td>The time (in seconds) to search for the image </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac95300b7c9f5310967e8ffe793c9c8e9"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_waitForImage_location_center" ref="ac95300b7c9f5310967e8ffe793c9c8e9" args="(Display *displayLocation, const char *fileName, int searchMethod, int tolerance, int timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xtest_8h.html#ac95300b7c9f5310967e8ffe793c9c8e9">xte_waitForImage_location_center</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for an image from file to show up on screen, return the center point. </p>
<p>This method allows you to search for an image on screen and wait for it to show up - this way you can make sure an image exists, and then respond to it. Also makes error checking easy. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to search for an image </td></tr>
<tr><td class="paramname">fileName</td><td>The file to load an image from before searching </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use when searching for <code>subImage</code> </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use when searching for <code>tolerance</code> </td></tr>
<tr><td class="paramname">timeout</td><td>The time (in seconds) to search for the image </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7ea1430ed90d3166f8d9fbb4e240a28f"></a><!-- doxytag: member="libcvautomation&#45;xtest.h::xte_commandString" ref="a7ea1430ed90d3166f8d9fbb4e240a28f" args="(Display *displayLocation, char *commandString, int mouseButton, int searchMethod, int tolerance, int timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcvaPoint.html">cvaPoint</a> <a class="el" href="libcvautomation-xtest_8h.html#a7ea1430ed90d3166f8d9fbb4e240a28f">xte_commandString</a> </td>
<td>(</td>
<td class="paramtype">Display *&#160;</td>
<td class="paramname"><em>displayLocation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>commandString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>mouseButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>searchMethod</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tolerance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Execute a command where the command is coming from a string. </p>
<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 </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">displayLocation</td><td>The Display of which to operate on </td></tr>
<tr><td class="paramname">commandString</td><td>The command string to execute - limit to <a class="el" href="libcvautomation-xtest_8h.html#a17af6c2b164a04cae831df5fb93836f6">COMMAND_STR_LEN</a> characters </td></tr>
<tr><td class="paramname">mouseButton</td><td>The mouse button to click if it is needed by the command being executed </td></tr>
<tr><td class="paramname">searchMethod</td><td>The search method to use if it is needed by the command being executed </td></tr>
<tr><td class="paramname">tolerance</td><td>The tolerance to use if it is needed by the command being executed </td></tr>
<tr><td class="paramname">timeout</td><td>The time in seconds to wait for an image to be displayed when using the <code>waitfor</code> command. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="xtest_command_strings.html">xte_commandString() Command Strings</a> </dd>
<dd>
<a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 11 2012 17:42:49 for libcvautomation by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink