mirror of
https://github.com/bspeice/libcvautomation
synced 2025-01-09 15:30:05 -05:00
192 lines
10 KiB
HTML
192 lines
10 KiB
HTML
<!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: Appendix of Wrapper Functions</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
|
|
 <span id="projectnumber">1.2</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 Page</span></a></li>
|
|
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><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>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Appendix of Wrapper Functions </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h2><a class="anchor" id="appendix_click"></a>
|
|
Click the mouse</h2>
|
|
<div class="fragment"><pre class="fragment"> click
|
|
</pre></div><p> Click the mouse where it is currently located <br/>
|
|
<br/>
|
|
</p>
|
|
<div class="fragment"><pre class="fragment"> click_xy <x-coordinate> <y-coordinate>
|
|
</pre></div><p> Click the mouse on an absolute point on screen </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>The actual process is to move the mouse to the given location, then click there. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> clickr_xy <x-increment> <y-increment>
|
|
</pre></div><p> Click the mouse on the screen relative to where the mouse is at </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>The actual process is to move the mouse the given distance, then click there. </dd>
|
|
<dd>
|
|
Also, note that a positive <code>x-increment</code> moves the mouse to the right, and a positive <code>y-increment</code> moves the mouse down. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> click_i <filename>
|
|
</pre></div><p> Click the mouse on a screenshot from <code>filename</code> </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is affected by the <code>CENTER</code>, <code>TOLERANCE</code>, and <code>SEARCH_METHOD</code> variables. See <a class="el" href="writing_app_tests.html#testing_test_wrapper">Testing the Testing Wrapper</a> for more information on these. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<h2><a class="anchor" id="appendix_move"></a>
|
|
Move the mouse</h2>
|
|
<div class="fragment"><pre class="fragment"> hover_xy <x-coordinate> <y-increment>
|
|
</pre></div><p> Move the mouse to a location on screen using absolute positioning <br/>
|
|
<br/>
|
|
</p>
|
|
<div class="fragment"><pre class="fragment"> hoverr_xy <x-increment> <y-increment>
|
|
</pre></div><p> Move the mouse to a location on screen using relative positioning </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Note that a positive <code>x-increment</code> moves the mouse to the right, and a positive <code>y-increment</code> moves the mouse down. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> hover_i <filename>
|
|
</pre></div><p> Move the mouse to a location on screen based on screenshot </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is affected by the <code>CENTER</code>, <code>TOLERANCE</code>, and <code>SEARCH_METHOD</code> variables. See <a class="el" href="writing_app_tests.html#testing_test_wrapper">Testing the Testing Wrapper</a> for more information on these. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> mouse_scrollu
|
|
</pre></div><p> Scroll the mouse wheel up one</p>
|
|
<div class="fragment"><pre class="fragment"> mouse_scrolld
|
|
</pre></div><p> Scroll the mouse wheel down one</p>
|
|
<h2><a class="anchor" id="appendix_find"></a>
|
|
Find an Image</h2>
|
|
<div class="fragment"><pre class="fragment"> image_location <filename>
|
|
</pre></div><p> Get the location of an image on screen </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This is affected by the <code>CENTER</code>, <code>TOLERANCE</code>, and <code>SEARCH_METHOD</code> variables. See <a class="el" href="writing_app_tests.html#testing_test_wrapper">Testing the Testing Wrapper</a> for more information on these. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<h2><a class="anchor" id="appendix_keyboard"></a>
|
|
Click the keyboard</h2>
|
|
<div class="fragment"><pre class="fragment"> key_str <span class="stringliteral">"<string>"</span>
|
|
</pre></div><p> Enter a string of characters on the keyboard rather than a single character at a time. </p>
|
|
<dl class="warning"><dt><b>Warning:</b></dt><dd>This function <b>does not</b> accept key strings like "Space" as <code>key_down</code>, <code>key_up</code>, and <code>key_click</code> do. If you pass in "Space", that is exactly what will be typed. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> key_down <span class="stringliteral">"<key-name>"</span>
|
|
</pre></div><p> Press a key down and leave it down </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This function accepts special keys like "Space" - see <a class="el" href="XTest_key_strings.html">XTest Key Strings</a> for a full list of characters allowed. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> key_up <span class="stringliteral">"<key-name>"</span>
|
|
</pre></div><p> Release a key </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This function accepts special keys like "Space" - see <a class="el" href="XTest_key_strings.html">XTest Key Strings</a> for a full list of characters allowed. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<div class="fragment"><pre class="fragment"> key_click <span class="stringliteral">"<key-name>"</span>
|
|
</pre></div><p> Press a key down and then release it immediately after </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>This function accepts special keys like "Space" - see <a class="el" href="XTest_key_strings.html">XTest Key Strings</a> for a full list of characters allowed. <br/>
|
|
<br/>
|
|
</dd></dl>
|
|
<h2><a class="anchor" id="appendix_utilities"></a>
|
|
Useful extras</h2>
|
|
<div class="fragment"><pre class="fragment"> run_process <span class="stringliteral">"<process-name>"</span>
|
|
</pre></div><p> Start a process on the system, background it, and return the PID of the created process. <br/>
|
|
<br/>
|
|
</p>
|
|
<div class="fragment"><pre class="fragment"> is_running <span class="stringliteral">"<process-name>"</span>
|
|
</pre></div> <div class="fragment"><pre class="fragment"> is_running <span class="stringliteral">"<process-id>"</span>
|
|
</pre></div><p> Check if a program name or PID is currently running</p>
|
|
<div class="fragment"><pre class="fragment"> notify <span class="stringliteral">"<string_to_display>"</span>
|
|
</pre></div><p> Display a notification to the user, and wait for a response </p>
|
|
<dl class="warning"><dt><b>Warning:</b></dt><dd>Uses <code>zenity</code> - if <code>zenity</code> isn't available, will return an error without pausing, and will not display anything. </dd></dl>
|
|
</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </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 Wed Jul 18 2012 14:10:15 for libcvautomation by  <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>
|