Release version 1.2 documentation

This commit is contained in:
Bradlee Speice
2012-07-18 14:11:30 -04:00
parent 810e4e9fe8
commit 295c31692c
82 changed files with 8726 additions and 2780 deletions

View File

@ -1,65 +1,146 @@
<!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: </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><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>
<dl compact><dt><b>Author:</b></dt><dd>Bradlee Speice &lt;<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>&gt; </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>7/11/2012 </dd></dl>
<h2><a class="anchor" name="usage">
Usage:</a></h2>
This program works kind of like a mini-language. All options are parsed left-to-right, and executed right there. Thus, specifying "--display" at different places in the options will cause this program to use the most recent given display. <h2><a class="anchor" name="example">
Example Usage:</a></h2>
Click the mouse:<p>
cva-input -s 'click 1'<p>
Press key 'a':<p>
cva-input -s 'keyclick a'<h2><a class="anchor" name="options">
Full Options:</a></h2>
-h, --help: Display this usage message.<p>
-u, --usage: Display this usage message.<p>
-d, --display: Specify the X display to use.<p>
-m, --search-method: Specify a method to search by. See <code>cva-match --help</code> for more information on this.<p>
-t, --tolerance: Specify how strict the match is.<p>
-b, --button: Specify the mouse button to press (default 1).<p>
-c, --center: Instead of matching the top-left corner of an image, match the center of the image.<p>
-o, --sane-tolerance: Set the tolerance using a scale of 1-100, rather than INT_MIN to INT_MAX (100 ~= INT_MAX)<p>
-s, --string: Command string - see below.<h2><a class="anchor" name="commands">
Full Command List:</a></h2>
mouseclick: Click the mouse in-place.<p>
imouseclick: Click the mouse at an image's top-left corner.<p>
icmouseclick: Click the mouse at an image's center.<p>
mousexy: Move the mouse to the given coordinate.<p>
mouserxy: Move the mouse by the given x and y values (relative motion).<p>
mouseimage: Move the mouse to an image's top-left corner.<p>
cmouseimage: Move the mouse to an image's center.<p>
mousedown: Push and leave down a mouse button.<p>
mouseup: Release a mouse button.<p>
mousejiggle: Jiggle the mouse (helps to activate some widgets).<p>
keyclick: Click a keyboard button.<p>
keydown: Push and leave down a keyboard button.<p>
keyup: Release a keyboard button.<p>
keystring: Input a string of keys to X11.<h2><a class="anchor" name="contact">
Contact Information:</a></h2>
Questions? Comments? Concerns? Suggestions? Send all feedback to Bradlee Speice at &lt;<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>&gt; <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>
<!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: $title</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">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&#160;Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related&#160;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="contents">
<div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>Bradlee Speice &lt;<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>&gt; </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>7/18/2012 </dd></dl>
<h2><a class="anchor" id="usage"></a>
Usage:</h2>
<p>This program works kind of like a mini-language. All options are parsed left-to-right, and executed right there. Thus, specifying "--display" at different places in the options will cause this program to use the most recent given display. </p>
<h2><a class="anchor" id="example"></a>
Example Usage:</h2>
<p>Click the mouse:</p>
<p>cva-input -s 'click 1'</p>
<p>Press key 'a':</p>
<p>cva-input -s 'keyclick a'</p>
<h2><a class="anchor" id="options"></a>
Full Options:</h2>
<p>-h, --help: Display this usage message.</p>
<p>-u, --usage: Display this usage message.</p>
<p>-d, --display: Specify the X display to use.</p>
<p>-m, --search-method: Specify a method to search by. See <code>cva-match --help</code> for more information on this.</p>
<p>-t, --tolerance: Specify how strict the match is.</p>
<p>-b, --button: Specify the mouse button to press (default 1).</p>
<p>-c, --center: Instead of matching the top-left corner of an image, match the center of the image.</p>
<p>-o, --sane-tolerance: Set the tolerance using a scale of 1-100, rather than INT_MIN to INT_MAX (100 ~= INT_MAX)</p>
<p>-s, --string: Command string - see below.</p>
<h2><a class="anchor" id="commands"></a>
Full Command List:</h2>
<p><code>mouseclick:</code> Click the mouse in-place.</p>
<p><code>imouseclick:</code> Click the mouse at an image's top-left corner.</p>
<p><code>icmouseclick:</code> Click the mouse at an image's center.</p>
<p><code>mousexy:</code> Move the mouse to the given coordinate.</p>
<p><code>mouserxy:</code> Move the mouse by the given x and y values (relative motion).</p>
<p><code>mouseimage:</code> Move the mouse to an image's top-left corner.</p>
<p><code>cmouseimage:</code> Move the mouse to an image's center.</p>
<p><code>mousedown:</code> Push and leave down a mouse button.</p>
<p><code>mouseup:</code> Release a mouse button.</p>
<p><code>mousejiggle:</code> Jiggle the mouse (helps to activate some widgets).</p>
<p><code>mousescrollu:</code> Scroll the mouse wheel up</p>
<p><code>mousescrolld:</code> Scroll the mouse wheel down</p>
<p><code>keyclick:</code> Click a keyboard button.</p>
<p><code>keydown:</code> Push and leave down a keyboard button.</p>
<p><code>keyup:</code> Release a keyboard button.</p>
<p><code>keystring:</code> Input a string of keys to X11.</p>
<h2><a class="anchor" id="contact"></a>
Contact Information:</h2>
<p>Questions? Comments? Concerns? Suggestions? Send all feedback to Bradlee Speice at &lt;<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>&gt; </p>
</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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><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 Wed Jul 18 2012 14:10:15 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>