mirror-github-bspeice/libcvautomation
1
0
Fork 0
mirror of https://github.com/bspeice/libcvautomation synced 2025-11-03 18:00:43 -05:00
Code Issues Releases Wiki Activity

Release version 1.1 Documentation

Browse Source
This commit is contained in:
Bradlee Speice
2012-07-17 16:07:18 -04:00
parent 3e5dad3c2e
commit 810e4e9fe8
63 changed files with 7229 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
XTest_command_strings.html Normal file
View File

@ -0,0 +1,83 @@
<!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: xte_commandString() Command Strings</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>
<h1><a class="anchor" name="XTest_command_strings">xte_commandString() Command Strings</a></h1>This page describes the various command strings available for the <a class="el" href="libcvautomation-xtest_8h.html#382af05e5669ea2cbb22608e41cbc49a">xte_commandString()</a> function. <h2><a class="anchor" name="mouseclick">
Mouse Click</a></h2>
<div class="fragment"><pre class="fragment"> 'mouseclick &lt;button_number&gt;'
</pre></div> Click the mouse button <code></code> &lt;button_number&gt; in-place.<h2><a class="anchor" name="imouseclick">
Image Mouse Click</a></h2>
<div class="fragment"><pre class="fragment"> 'imouseclick &lt;image_name&gt;'
</pre></div> Click the mouse at an image's top-left corner.<h2><a class="anchor" name="icmouseclick">
Image Mouse Click (Centered)</a></h2>
<div class="fragment"><pre class="fragment"> 'icmouseclick &lt;image_name&gt;'
</pre></div> Click the mouse at an image's center.<h2><a class="anchor" name="mousexy">
Mouse XY Move</a></h2>
<div class="fragment"><pre class="fragment"> 'mousexy &lt;x-coord&gt; &lt;y-coord&gt;'
</pre></div> Move the mouse to an absolute coordinate. <dl compact><dt><b>Warning:</b></dt><dd>The <code>&lt;x-coord&gt;</code> and <code>&lt;y-coord&gt;</code> are expected to be integers.</dd></dl>
<h2><a class="anchor" name="mouserxy">
Mouse XY Move (Relative)</a></h2>
<div class="fragment"><pre class="fragment"> 'mouserxy &lt;x-increment&gt; &lt;y-increment&gt;'
</pre></div> Move the mouse by the given x and y values (relative motion). <dl compact><dt><b>A positive X increment will move the mouse to the right, and a positive Y increment will move the mouse down.</b></dt><dd></dd></dl>
<dl compact><dt><b>Warning:</b></dt><dd>The <code>&lt;x-increment&gt;</code> and <code>&lt;y-increment&gt;</code> are expected to be integers.</dd></dl>
<h2><a class="anchor" name="mouseimage">
Mouse Image Move</a></h2>
<div class="fragment"><pre class="fragment"> 'mouseimage &lt;image_name&gt;'
</pre></div> Move the mouse to an image's top-left corner.<h2><a class="anchor" name="cmouseimage">
Mouse Image Move (Centered)</a></h2>
<div class="fragment"><pre class="fragment"> 'cmouseimage &lt;image_name&gt;'
</pre></div> Move the mouse to an image's center.<h2><a class="anchor" name="mousedown">
Mouse Button Down</a></h2>
<div class="fragment"><pre class="fragment"> 'mousedown &lt;button_number&gt;'
</pre></div> Push and leave down a mouse button.<h2><a class="anchor" name="mouseup">
Mouse Button Up</a></h2>
<div class="fragment"><pre class="fragment"> 'mouseup &lt;button_number&gt;'
</pre></div> Release mouse button <code></code> &lt;button_number&gt;<h2><a class="anchor" name="mousejiggle">
Mouse Jiggle</a></h2>
<div class="fragment"><pre class="fragment"> 'mousejiggle'
</pre></div> Jiggle the mouse (helps to activate some widgets). Moves the mouse right and down 1 pixel, and then back.<h2><a class="anchor" name="mousescrolld">
Mouse Scroll Down</a></h2>
<div class="fragment"><pre class="fragment"> 'mousescrolld'
</pre></div> Scroll the mouse down 1 time - depending on window manager settings, etc., this may be multiple lines. <dl compact><dt><b>Note:</b></dt><dd>This is a wrapper function for clicking button 4 on the mouse</dd></dl>
<h2><a class="anchor" name="mousescrollu">
Mouse Scroll Up</a></h2>
<div class="fragment"><pre class="fragment"> 'mousescrollu'
</pre></div> Scroll the mouse up 1 time - depending on window manager settings, etc., this may be multiple lines. <dl compact><dt><b>Note:</b></dt><dd>This is a wrapper function for clicking button 5 on the mouse</dd></dl>
<h2><a class="anchor" name="keyclick">
Key Button Click</a></h2>
<div class="fragment"><pre class="fragment"> 'keyclick &lt;key_name&gt;'
</pre></div> 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.<h2><a class="anchor" name="keydown">
Key Button Down</a></h2>
<div class="fragment"><pre class="fragment"> 'keydown &lt;key_name&gt;'
</pre></div> Push down <em>but do not release</em> 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.<h2><a class="anchor" name="keyup">
Key Button Up</a></h2>
<div class="fragment"><pre class="fragment"> 'keyup &lt;key_name&gt;'
</pre></div> 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.<h2><a class="anchor" name="keystring">
Keyboard Input String</a></h2>
<div class="fragment"><pre class="fragment"> 'keystring &lt;string&gt;'
</pre></div> 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. <dl compact><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>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 17 12:19:00 2012 for libcvautomation by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>