Release version 1.4 documentation

This commit is contained in:
Bradlee Speice
2012-07-30 12:55:11 -04:00
parent 256900eefd
commit e59ec0cf90
28 changed files with 136 additions and 114 deletions

View File

@ -34,7 +34,7 @@
<td style="padding-left: 0.5em;">
<div id="projectname">libcvautomation
&#160;<span id="projectnumber">1.3</span>
&#160;<span id="projectnumber">1.4</span>
</div>
</td>
@ -81,8 +81,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This page describes the various command strings available for the <a class="el" href="libcvautomation-xtest_8h.html#a7ea1430ed90d3166f8d9fbb4e240a28f">xte_commandString()</a> function. </p>
<h2><a class="anchor" id="mouseclick"></a>
Mouse Click</h2>
<h2><a class="anchor" id="mousefunctions"></a>
Mouse Functions</h2>
<div class="fragment"><pre class="fragment"> <span class="stringliteral">&#39;mouseclick &lt;button_number&gt;&#39;</span>
</pre></div><p> Click the mouse button <code></code> &lt;button_number&gt; in-place.</p>
<h2><a class="anchor" id="imouseclick"></a>
@ -134,8 +134,12 @@ Mouse Scroll Up</h2>
<div class="fragment"><pre class="fragment"> <span class="stringliteral">&#39;mousescrollu&#39;</span>
</pre></div><p> Scroll the mouse up 1 time - depending on window manager settings, etc., this may be multiple lines. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is a wrapper function for clicking button 5 on the mouse</dd></dl>
<h2><a class="anchor" id="keyclick"></a>
Key Button Click</h2>
<h2><a class="anchor" id="mouselocation"></a>
Mouse Location</h2>
<div class="fragment"><pre class="fragment"> <span class="stringliteral">&#39;mouselocation&#39;</span>
</pre></div><p> Return the current location of the mouse pointer.</p>
<h2><a class="anchor" id="keyboard_functions"></a>
Keyboard Functions</h2>
<div class="fragment"><pre class="fragment"> <span class="stringliteral">&#39;keyclick &lt;key_name&gt;&#39;</span>
</pre></div><p> Push and release a keyboard key. This can be a key like <code>'a'</code>, <code>'b'</code>, or 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 special keys.</p>
<h2><a class="anchor" id="keydown"></a>
@ -150,7 +154,7 @@ Key Button Up</h2>
Keyboard Input String</h2>
<div class="fragment"><pre class="fragment"> <span class="stringliteral">&#39;keystring &lt;string&gt;&#39;</span>
</pre></div><p> Input a string of text to the X11 server. For example, inputting 'Hello, world!" will act as if you typed 'Hello, world!' from the keyboard. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Unlike <a class="el" href="xtest_command_strings.html#keydown">Key Button Down</a>, <a class="el" href="xtest_command_strings.html#keyup">Key Button Up</a>, and <a class="el" href="xtest_command_strings.html#keyclick">Key Button Click</a>, this function can not handle special keys like 'space'.</dd></dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Unlike <a class="el" href="xtest_command_strings.html#keydown">Key Button Down</a>, <a class="el" href="xtest_command_strings.html#keyup">Key Button Up</a>, and keyclick, this function can not handle special keys like 'space'.</dd></dl>
<h2><a class="anchor" id="waitfor"></a>
Wait for Image</h2>
<div class="fragment"><pre class="fragment"> <span class="stringliteral">&#39;waitfor &lt;image_name&gt;&#39;</span>
@ -173,7 +177,7 @@ Wait for Image</h2>
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Jul 30 2012 12:42:34 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>