mirror of
https://github.com/bspeice/libcvautomation
synced 2025-07-04 15:27:04 -04:00
Release version 1.2 documentation
This commit is contained in:
Bradlee Speice
@ -1,83 +1,178 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
<!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: 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 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 Pages</span></a></li>
|
||||
<li>
|
||||
<form action="search.php" method="get">
|
||||
<table cellspacing="0" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td><label> <u>S</u>earch for </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 <button_number>'
|
||||
</pre></div> Click the mouse button <code></code> <button_number> in-place.<h2><a class="anchor" name="imouseclick">
|
||||
Image Mouse Click</a></h2>
|
||||
<div class="fragment"><pre class="fragment"> 'imouseclick <image_name>'
|
||||
</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 <image_name>'
|
||||
</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 <x-coord> <y-coord>'
|
||||
</pre></div> Move the mouse to an absolute coordinate. <dl compact><dt><b>Warning:</b></dt><dd>The <code><x-coord></code> and <code><y-coord></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 <x-increment> <y-increment>'
|
||||
</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><x-increment></code> and <code><y-increment></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 <image_name>'
|
||||
</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 <image_name>'
|
||||
</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 <button_number>'
|
||||
</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 <button_number>'
|
||||
</pre></div> Release mouse button <code></code> <button_number><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 <key_name>'
|
||||
</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 <key_name>'
|
||||
</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 <key_name>'
|
||||
</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 <string>'
|
||||
</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
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
|
||||
|
||||
<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"><a class="el" href="libcvautomation-xtest_8h.html#a8c3574a6eff4b080840806dca53aa5b8" title="Execute a command where the command is coming from a string.">xte_commandString()</a> Command Strings </div> </div>
|
||||
</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#a8c3574a6eff4b080840806dca53aa5b8">xte_commandString()</a> function. </p>
|
||||
<h2><a class="anchor" id="mouseclick"></a>
|
||||
Mouse Click</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mouseclick <button_number>'</span>
|
||||
</pre></div><p> Click the mouse button <code></code> <button_number> in-place.</p>
|
||||
<h2><a class="anchor" id="imouseclick"></a>
|
||||
Image Mouse Click</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'imouseclick <image_name>'</span>
|
||||
</pre></div><p> Click the mouse at an image's top-left corner.</p>
|
||||
<h2><a class="anchor" id="icmouseclick"></a>
|
||||
Image Mouse Click (Centered)</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'icmouseclick <image_name>'</span>
|
||||
</pre></div><p> Click the mouse at an image's center.</p>
|
||||
<h2><a class="anchor" id="mousexy"></a>
|
||||
Mouse XY Move</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mousexy <x-coord> <y-coord>'</span>
|
||||
</pre></div><p> Move the mouse to an absolute coordinate. </p>
|
||||
<dl class="warning"><dt><b>Warning:</b></dt><dd>The <code><x-coord></code> and <code><y-coord></code> are expected to be integers.</dd></dl>
|
||||
<h2><a class="anchor" id="mouserxy"></a>
|
||||
Mouse XY Move (Relative)</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mouserxy <x-increment> <y-increment>'</span>
|
||||
</pre></div><p> Move the mouse by the given x and y values (relative motion). </p>
|
||||
<dl class="user"><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 class="warning"><dt><b>Warning:</b></dt><dd>The <code><x-increment></code> and <code><y-increment></code> are expected to be integers.</dd></dl>
|
||||
<h2><a class="anchor" id="mouseimage"></a>
|
||||
Mouse Image Move</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mouseimage <image_name>'</span>
|
||||
</pre></div><p> Move the mouse to an image's top-left corner.</p>
|
||||
<h2><a class="anchor" id="cmouseimage"></a>
|
||||
Mouse Image Move (Centered)</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'cmouseimage <image_name>'</span>
|
||||
</pre></div><p> Move the mouse to an image's center.</p>
|
||||
<h2><a class="anchor" id="mousedown"></a>
|
||||
Mouse Button Down</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mousedown <button_number>'</span>
|
||||
</pre></div><p> Push and leave down a mouse button.</p>
|
||||
<h2><a class="anchor" id="mouseup"></a>
|
||||
Mouse Button Up</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mouseup <button_number>'</span>
|
||||
</pre></div><p> Release mouse button <code></code> <button_number></p>
|
||||
<h2><a class="anchor" id="mousejiggle"></a>
|
||||
Mouse Jiggle</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mousejiggle'</span>
|
||||
</pre></div><p> Jiggle the mouse (helps to activate some widgets). Moves the mouse right and down 1 pixel, and then back.</p>
|
||||
<h2><a class="anchor" id="mousescrolld"></a>
|
||||
Mouse Scroll Down</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mousescrolld'</span>
|
||||
</pre></div><p> Scroll the mouse down 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 4 on the mouse</dd></dl>
|
||||
<h2><a class="anchor" id="mousescrollu"></a>
|
||||
Mouse Scroll Up</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'mousescrollu'</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>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'keyclick <key_name>'</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>
|
||||
Key Button Down</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'keydown <key_name>'</span>
|
||||
</pre></div><p> 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.</p>
|
||||
<h2><a class="anchor" id="keyup"></a>
|
||||
Key Button Up</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'keyup <key_name>'</span>
|
||||
</pre></div><p> 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="keystring"></a>
|
||||
Keyboard Input String</h2>
|
||||
<div class="fragment"><pre class="fragment"> <span class="stringliteral">'keystring <string>'</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>
|
||||
</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>
|
||||
|
||||
Reference in New Issue
Block a user