mirror of
https://github.com/bspeice/libcvautomation
synced 2024-12-04 13:58:11 -05:00
1345 lines
77 KiB
HTML
1345 lines
77 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: libcvautomation_funcs Namespace Reference</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">2.0</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><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li class="current"><a href="namespaces.html"><span>Namespaces</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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
|
|
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">libcvautomation_funcs Namespace Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Namespace to contain all of the features needed to use the <a class="el" href="namespacelibcvautomation__funcs.html" title="Namespace to contain all of the features needed to use the libcvautomation_funcs wrapper.">libcvautomation_funcs</a> wrapper.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibcvautomation__funcs_1_1LibcvImageNotFound.html">LibcvImageNotFound</a></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlibcvautomation__funcs_1_1LibcvDisplayNotOpen.html">LibcvDisplayNotOpen</a></td></tr>
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a46446dc9fde2c1f2cc5ac630b51760ce">open_display</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a display for use in the <a class="el" href="namespacelibcvautomation__funcs.html" title="Namespace to contain all of the features needed to use the libcvautomation_funcs wrapper.">libcvautomation_funcs</a>. <a href="#a46446dc9fde2c1f2cc5ac630b51760ce"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a1592c65a7ffc29016fd3ef1bb6178966">close_display</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a display currently in use by <a class="el" href="namespacelibcvautomation__funcs.html" title="Namespace to contain all of the features needed to use the libcvautomation_funcs wrapper.">libcvautomation_funcs</a>. <a href="#a1592c65a7ffc29016fd3ef1bb6178966"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a44d208a38c591e8b9eb5aff0051f4414">mouse_down</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Press a mouse button down. <a href="#a44d208a38c591e8b9eb5aff0051f4414"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a4046c72b33ac57e1d39431c9cc888d44">mouse_up</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release a mouse button. <a href="#a4046c72b33ac57e1d39431c9cc888d44"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#af4d9b2f324c23336b83399f7fd71852e">mouse_click</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Press and release a mouse button. <a href="#af4d9b2f324c23336b83399f7fd71852e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#ab98166fb3931d7cd7fbbad6a0986d46b">mouse_click_xy</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Click a mouse button at an absolute location. <a href="#ab98166fb3931d7cd7fbbad6a0986d46b"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a633ee669989a44fa6f23fdbd9881a39e">mouse_click_rxy</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Click a mouse button at a relative location. <a href="#a633ee669989a44fa6f23fdbd9881a39e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6">mouse_click_image</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Click a mouse button on an image inside the root X11 window. <a href="#a1a05342b0159044fae6bdb9969d488d6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a65604797ddffcbbfc2efcb470a54a353">mouse_doubleclick</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Press and release a mouse button twice. <a href="#a65604797ddffcbbfc2efcb470a54a353"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#aa15713c985a8799f4866bd13acfa2e17">mouse_doubleclick_xy</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Click a mouse button twice at an absolute location. <a href="#aa15713c985a8799f4866bd13acfa2e17"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#abca5903b1e4208d1c019272f2e05ebdc">mouse_doubleclick_rxy</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Click a mouse button twice at a relative location. <a href="#abca5903b1e4208d1c019272f2e05ebdc"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#ad54f021aae633baac7ae0d3394c54262">mouse_doubleclick_image</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Click a mouse button twice on an image inside the root X11 window. <a href="#ad54f021aae633baac7ae0d3394c54262"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a6585a90832b64e0b75669d458576a98f">mouse_hover_xy</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the mouse to a given coordinate, and leave it there. <a href="#a6585a90832b64e0b75669d458576a98f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a28bf60ba05cbec59985f9655d70ee583">mouse_hover_rxy</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the mouse by a given increment, and leave it there. <a href="#a28bf60ba05cbec59985f9655d70ee583"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#ac952f6f97c0bc2acdf1ad5b4d1d5acc1">mouse_hover_image</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the mouse to an image inside the root X11 window. <a href="#ac952f6f97c0bc2acdf1ad5b4d1d5acc1"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a7c2ecbf863dcd5e4af933f38752e81e5">mouse_jiggle</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jiggle the mouse in place. <a href="#a7c2ecbf863dcd5e4af933f38752e81e5"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a47b44363958312c387e135e9ae484dc0">mouse_scroll_up</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scroll the mouse wheel up. <a href="#a47b44363958312c387e135e9ae484dc0"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#aef8e77ffd828b6803a918cc061d0b92b">mouse_scroll_down</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scroll the mouse wheel down. <a href="#aef8e77ffd828b6803a918cc061d0b92b"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#af3b5f4b294fd2f429e70de18848e1ea8">mouse_drag_n_drop</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Drag and drop one image to another. <a href="#af3b5f4b294fd2f429e70de18848e1ea8"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a9ac61209cab08f17b30fcc33b7b7438f">mouse_location</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current location of the mouse. <a href="#a9ac61209cab08f17b30fcc33b7b7438f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a12177cc9e099247f535f9c87409d4259">key_string</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enter a string of text on the keyboard. <a href="#a12177cc9e099247f535f9c87409d4259"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a75c43acfa38dea829ce26494c7d0bf3f">key_down</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Press a key down on the keyboard, and leave it down. <a href="#a75c43acfa38dea829ce26494c7d0bf3f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#ab12bbd622fcf5e9bb7ae31e86731d9a3">key_up</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release a key on the keyboard. <a href="#ab12bbd622fcf5e9bb7ae31e86731d9a3"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a8f69f7246688b01ac3cfb8dd8d70c955">key_click</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Press and release a key on the keyboard. <a href="#a8f69f7246688b01ac3cfb8dd8d70c955"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a66cb6c90b7dc78917f1cea203e089a5f">image_location</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the location of an image on the screen. <a href="#a66cb6c90b7dc78917f1cea203e089a5f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a13cc6e8f778af64c445b78f53c7a3ab7">wait_for</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the location of an image on the screen, waiting for it to show up. <a href="#a13cc6e8f778af64c445b78f53c7a3ab7"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html#a35d44bdc0e8c0e1e049d701e7c3e64ca">command_string</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a libcvautomation command based on a string. <a href="#a35d44bdc0e8c0e1e049d701e7c3e64ca"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7edd744b08eed255d66bc0f01505ca78"></a><!-- doxytag: member="libcvautomation_funcs::_use_frame_trace" ref="a7edd744b08eed255d66bc0f01505ca78" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><b>_use_frame_trace</b> = None</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad01360bde654281b0c8084e3c855f0ed"></a><!-- doxytag: member="libcvautomation_funcs::outfile" ref="ad01360bde654281b0c8084e3c855f0ed" args="" -->
|
|
string </td><td class="memItemRight" valign="bottom"><b>outfile</b> = '/dev/null'</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e0baa38cb0b18bbc441ddd4fc9c2fe8"></a><!-- doxytag: member="libcvautomation_funcs::_libcvautomation_error_location" ref="a2e0baa38cb0b18bbc441ddd4fc9c2fe8" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><b>_libcvautomation_error_location</b> = libcvautomation.cvaPoint</td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>Namespace to contain all of the features needed to use the <a class="el" href="namespacelibcvautomation__funcs.html" title="Namespace to contain all of the features needed to use the libcvautomation_funcs wrapper.">libcvautomation_funcs</a> wrapper. </p>
|
|
<div class="fragment"><pre class="fragment">
|
|
libcvautomation_funcs.py
|
|
|
|
This is a high-level wrapper intended to give you easy access to
|
|
libcvautomation, while staying flexible and powerful.
|
|
This wrapper was designed to be like the Bash wrapper of the
|
|
same name, but allows access to the advanced features of Python -
|
|
for example, error handling.
|
|
Also, it becomes easy to integrate other systems like dogtail
|
|
into the same application test if you want to combine features.
|
|
|
|
To use:
|
|
import libcvautomation_funcs
|
|
|
|
If there are any questions, comments, concerns, or suggestions,
|
|
notify the developer at <bspeice@uncc.edu></pre></div> </div><hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="a46446dc9fde2c1f2cc5ac630b51760ce"></a><!-- doxytag: member="libcvautomation_funcs::open_display" ref="a46446dc9fde2c1f2cc5ac630b51760ce" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a46446dc9fde2c1f2cc5ac630b51760ce">libcvautomation_funcs.open_display</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>display_name</em> = <code>''</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Open a display for use in the <a class="el" href="namespacelibcvautomation__funcs.html" title="Namespace to contain all of the features needed to use the libcvautomation_funcs wrapper.">libcvautomation_funcs</a>. </p>
|
|
<p>This opens a display that will be used for every other function in <a class="el" href="libcvautomation__funcs_8py.html" title="Libcvautomation wrapper for python.">libcvautomation_funcs.py</a>. If you need to open a different display, use <a class="el" href="namespacelibcvautomation__funcs.html#a1592c65a7ffc29016fd3ef1bb6178966">libcvautomation_funcs.close_display()</a> and then open the new display that you want. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">display_name</td><td>The name of the display to open. The default is to open the first available display, which may not specifically be <code></code>:0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="warning"><dt><b>Warning:</b></dt><dd>You <em>must</em> use this function to open a display before any other functions can be used. </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>True</code> if the display was successfully opened, <code>False</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00113">113</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1592c65a7ffc29016fd3ef1bb6178966"></a><!-- doxytag: member="libcvautomation_funcs::close_display" ref="a1592c65a7ffc29016fd3ef1bb6178966" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a1592c65a7ffc29016fd3ef1bb6178966">libcvautomation_funcs.close_display</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Close a display currently in use by <a class="el" href="namespacelibcvautomation__funcs.html" title="Namespace to contain all of the features needed to use the libcvautomation_funcs wrapper.">libcvautomation_funcs</a>. </p>
|
|
<p>This closes the currently open display. All functions used after this will fail unless you open another display. Use <a class="el" href="namespacelibcvautomation__funcs.html#a46446dc9fde2c1f2cc5ac630b51760ce">libcvautomation_funcs.open_display()</a> to open the new display. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00125">125</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a44d208a38c591e8b9eb5aff0051f4414"></a><!-- doxytag: member="libcvautomation_funcs::mouse_down" ref="a44d208a38c591e8b9eb5aff0051f4414" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a44d208a38c591e8b9eb5aff0051f4414">libcvautomation_funcs.mouse_down</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Press a mouse button down. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The number of the mouse button to press </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00168">168</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="libcvautomation__funcs_8py_source.html#l00550">mouse_drag_n_drop()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4046c72b33ac57e1d39431c9cc888d44"></a><!-- doxytag: member="libcvautomation_funcs::mouse_up" ref="a4046c72b33ac57e1d39431c9cc888d44" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a4046c72b33ac57e1d39431c9cc888d44">libcvautomation_funcs.mouse_up</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Release a mouse button. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The number of the mouse button to release </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00179">179</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="libcvautomation__funcs_8py_source.html#l00550">mouse_drag_n_drop()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af4d9b2f324c23336b83399f7fd71852e"></a><!-- doxytag: member="libcvautomation_funcs::mouse_click" ref="af4d9b2f324c23336b83399f7fd71852e" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#af4d9b2f324c23336b83399f7fd71852e">libcvautomation_funcs.mouse_click</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Press and release a mouse button. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The number of the mouse button to click </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00192">192</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab98166fb3931d7cd7fbbad6a0986d46b"></a><!-- doxytag: member="libcvautomation_funcs::mouse_click_xy" ref="ab98166fb3931d7cd7fbbad6a0986d46b" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#ab98166fb3931d7cd7fbbad6a0986d46b">libcvautomation_funcs.mouse_click_xy</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>x_coord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>y_coord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Click a mouse button at an absolute location. </p>
|
|
<p>Move the mouse to a location given by an x and y coordinate before clicking </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x_coord</td><td>The X-coordinate to move the mouse to </td></tr>
|
|
<tr><td class="paramname">y_coord</td><td>The Y-coordinate to move the mouse to </td></tr>
|
|
<tr><td class="paramname">mouse_button</td><td>The mouse button to click after moving </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00207">207</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a633ee669989a44fa6f23fdbd9881a39e"></a><!-- doxytag: member="libcvautomation_funcs::mouse_click_rxy" ref="a633ee669989a44fa6f23fdbd9881a39e" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a633ee669989a44fa6f23fdbd9881a39e">libcvautomation_funcs.mouse_click_rxy</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>x_inc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>y_inc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Click a mouse button at a relative location. </p>
|
|
<p>Move the mouse horizontally and vertically by an increment, and then click the mouse </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x_inc</td><td>The increment to move the mouse horizontally </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>A positive increment moves the mouse right, a negative increment moves the mouse left </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">y_inc</td><td>The increment to move the mouse vertically </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>A positive increment moves the mouse down, a negative increment moves the mouse up </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The mouse button to click after moving </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00230">230</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1a05342b0159044fae6bdb9969d488d6"></a><!-- doxytag: member="libcvautomation_funcs::mouse_click_image" ref="a1a05342b0159044fae6bdb9969d488d6" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6">libcvautomation_funcs.mouse_click_image</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>image_names</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>search_method</em> = <code>_search_method_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>tolerance</em> = <code>_tolerance_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>timeout</em> = <code>_timeout_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_wait</em> = <code>True</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Click a mouse button on an image inside the root X11 window. </p>
|
|
<p>For each image in <code>image_names</code>, search for it inside the root X11 window. Return once a match has been found, or the timeout value has been exceeded </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image_names</td><td>List of image names to search for </td></tr>
|
|
<tr><td class="paramname">search_method</td><td>The search method to use when finding each <code>image</code>. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use the search methods. </td></tr>
|
|
<tr><td class="paramname">tolerance</td><td>The tolerance to use when finding each <code>image</code>. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use tolerance. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Wait for <code>timeout</code> seconds before giving up the search for <code>image_names</code> in the root X11 window. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd><code>use_wait</code> must be set to <code>True</code> for this parameter to have any effect </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The mouse button to click after finding an image </td></tr>
|
|
<tr><td class="paramname">use_wait</td><td>Set to <code>True</code> to make this function wait <code>timeout</code> seconds before giving up finding an image. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>If set to <code>False</code>, this function will go through the list of <code>image_names</code> once before giving up. </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution or there were no images found, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00252">252</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a65604797ddffcbbfc2efcb470a54a353"></a><!-- doxytag: member="libcvautomation_funcs::mouse_doubleclick" ref="a65604797ddffcbbfc2efcb470a54a353" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a65604797ddffcbbfc2efcb470a54a353">libcvautomation_funcs.mouse_doubleclick</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Press and release a mouse button twice. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The number of the mouse button to click twice </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00302">302</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa15713c985a8799f4866bd13acfa2e17"></a><!-- doxytag: member="libcvautomation_funcs::mouse_doubleclick_xy" ref="aa15713c985a8799f4866bd13acfa2e17" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#aa15713c985a8799f4866bd13acfa2e17">libcvautomation_funcs.mouse_doubleclick_xy</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>x_coord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>y_coord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Click a mouse button twice at an absolute location. </p>
|
|
<p>Move the mouse to a location given by an x and y coordinate before clicking twice </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x_coord</td><td>The X-coordinate to move the mouse to </td></tr>
|
|
<tr><td class="paramname">y_coord</td><td>The Y-coordinate to move the mouse to </td></tr>
|
|
<tr><td class="paramname">mouse_button</td><td>The mouse button to click after moving </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00319">319</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abca5903b1e4208d1c019272f2e05ebdc"></a><!-- doxytag: member="libcvautomation_funcs::mouse_doubleclick_rxy" ref="abca5903b1e4208d1c019272f2e05ebdc" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#abca5903b1e4208d1c019272f2e05ebdc">libcvautomation_funcs.mouse_doubleclick_rxy</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>x_inc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>y_inc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Click a mouse button twice at a relative location. </p>
|
|
<p>Move the mouse horizontally and vertically by an increment, and then click the mouse twice </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x_inc</td><td>The increment to move the mouse horizontally </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>A positive increment moves the mouse right, a negative increment moves the mouse left </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">y_inc</td><td>The increment to move the mouse vertically </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>A positive increment moves the mouse down, a negative increment moves the mouse up </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The mouse button to click after moving </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00343">343</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad54f021aae633baac7ae0d3394c54262"></a><!-- doxytag: member="libcvautomation_funcs::mouse_doubleclick_image" ref="ad54f021aae633baac7ae0d3394c54262" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#ad54f021aae633baac7ae0d3394c54262">libcvautomation_funcs.mouse_doubleclick_image</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>image_names</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>search_method</em> = <code>_search_method_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>tolerance</em> = <code>_tolerance_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>timeout</em> = <code>_timeout_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_wait</em> = <code>True</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_center</em> = <code>True</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Click a mouse button twice on an image inside the root X11 window. </p>
|
|
<p>For each image in <code>image_names</code>, search for it inside the root X11 window. Return once a match has been found, or the timeout value has been exceeded </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image_names</td><td>List of image names to search for </td></tr>
|
|
<tr><td class="paramname">search_method</td><td>The search method to use when finding each <code>image</code>. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use the search methods. </td></tr>
|
|
<tr><td class="paramname">tolerance</td><td>The tolerance to use when finding each <code>image</code>. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use tolerance. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Wait for <code>timeout</code> seconds before giving up the search for <code>image_names</code> in the root X11 window. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd><code>use_wait</code> must be set to <code>True</code> for this parameter to have any effect </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mouse_button</td><td>The mouse button to click after finding an image </td></tr>
|
|
<tr><td class="paramname">use_wait</td><td>Set to <code>True</code> to make this function wait <code>timeout</code> seconds before giving up finding an image. </td></tr>
|
|
<tr><td class="paramname">use_center</td><td>Set to <code>True</code> to make this function return the center coordinate of the matched image. Setting to <code>False</code> will use the top-left corner. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>If set to <code>False</code>, this function will go through the list of <code>image_names</code> once before giving up. </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution or no images were found, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00367">367</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6585a90832b64e0b75669d458576a98f"></a><!-- doxytag: member="libcvautomation_funcs::mouse_hover_xy" ref="a6585a90832b64e0b75669d458576a98f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a6585a90832b64e0b75669d458576a98f">libcvautomation_funcs.mouse_hover_xy</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>x_coord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>y_coord</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Move the mouse to a given coordinate, and leave it there. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x_coord</td><td>The X-coordinate to move the mouse to </td></tr>
|
|
<tr><td class="paramname">y_coord</td><td>The Y-coordinate to move the mouse to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00421">421</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a28bf60ba05cbec59985f9655d70ee583"></a><!-- doxytag: member="libcvautomation_funcs::mouse_hover_rxy" ref="a28bf60ba05cbec59985f9655d70ee583" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a28bf60ba05cbec59985f9655d70ee583">libcvautomation_funcs.mouse_hover_rxy</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>x_inc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>y_inc</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Move the mouse by a given increment, and leave it there. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x_inc</td><td>The increment to move the mouse horizontally </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>A positive increment moves the mouse right, a negative increment moves the mouse left </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">y_inc</td><td>The increment to move the mouse vertically </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>A positive increment moves the mouse down, a negative increment moves the mouse up </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00441">441</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac952f6f97c0bc2acdf1ad5b4d1d5acc1"></a><!-- doxytag: member="libcvautomation_funcs::mouse_hover_image" ref="ac952f6f97c0bc2acdf1ad5b4d1d5acc1" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#ac952f6f97c0bc2acdf1ad5b4d1d5acc1">libcvautomation_funcs.mouse_hover_image</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>image_names</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>search_method</em> = <code>_search_method_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>tolerance</em> = <code>_tolerance_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>timeout</em> = <code>_timeout_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_wait</em> = <code>True</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_center</em> = <code>True</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Move the mouse to an image inside the root X11 window. </p>
|
|
<p>For each image in <code>image_names</code>, search for it inside the root X11 window. Return once a match has been found, or the timeout value has been exceeded </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image_names</td><td>List of image names to search for </td></tr>
|
|
<tr><td class="paramname">search_method</td><td>The search method to use when finding each <code>image</code>. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use the search methods. </td></tr>
|
|
<tr><td class="paramname">tolerance</td><td>The tolerance to use when finding each <code>image</code>. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use tolerance. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Wait for <code>timeout</code> seconds before giving up the search for <code>image_names</code> in the root X11 window. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd><code>use_wait</code> must be set to <code>True</code> for this parameter to have any effect </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">use_wait</td><td>Set to <code>True</code> to make this function wait <code>timeout</code> seconds before giving up finding an image. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>If set to <code>False</code>, this function will go through the list of <code>image_names</code> once before giving up. </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">use_center</td><td>Set to <code>True</code> to make this function return the center coordinate of the matched image. Setting to <code>False</code> will use the top-left corner. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution or no images were found, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00462">462</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="libcvautomation__funcs_8py_source.html#l00550">mouse_drag_n_drop()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7c2ecbf863dcd5e4af933f38752e81e5"></a><!-- doxytag: member="libcvautomation_funcs::mouse_jiggle" ref="a7c2ecbf863dcd5e4af933f38752e81e5" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a7c2ecbf863dcd5e4af933f38752e81e5">libcvautomation_funcs.mouse_jiggle</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Jiggle the mouse in place. </p>
|
|
<p>Move the mouse right and down 1 pixel, and back. Useful for activating menu entries, etc. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise <div class="fragment"><pre class="fragment">Jiggle the mouse in place</pre></div> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00511">511</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a47b44363958312c387e135e9ae484dc0"></a><!-- doxytag: member="libcvautomation_funcs::mouse_scroll_up" ref="a47b44363958312c387e135e9ae484dc0" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a47b44363958312c387e135e9ae484dc0">libcvautomation_funcs.mouse_scroll_up</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Scroll the mouse wheel up. </p>
|
|
<p>This is the same as pressing mouse button 4 </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00524">524</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aef8e77ffd828b6803a918cc061d0b92b"></a><!-- doxytag: member="libcvautomation_funcs::mouse_scroll_down" ref="aef8e77ffd828b6803a918cc061d0b92b" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#aef8e77ffd828b6803a918cc061d0b92b">libcvautomation_funcs.mouse_scroll_down</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Scroll the mouse wheel down. </p>
|
|
<p>This is the same as pressing mouse button 5 </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00536">536</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af3b5f4b294fd2f429e70de18848e1ea8"></a><!-- doxytag: member="libcvautomation_funcs::mouse_drag_n_drop" ref="af3b5f4b294fd2f429e70de18848e1ea8" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#af3b5f4b294fd2f429e70de18848e1ea8">libcvautomation_funcs.mouse_drag_n_drop</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>drag_image</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>drag_to</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_center</em> = <code>True</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Drag and drop one image to another. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">drag_image</td><td>The image to drag from </td></tr>
|
|
<tr><td class="paramname">drag_to</td><td>The image giving the location to drag to </td></tr>
|
|
<tr><td class="paramname">use_center</td><td>Drag and drop the image using the center of the image as the location where the mouse will click and drag to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution or an image was not found, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00550">550</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
<p>References <a class="el" href="libcvautomation__funcs_8py_source.html#l00168">mouse_down()</a>, <a class="el" href="libcvautomation__funcs_8py_source.html#l00462">mouse_hover_image()</a>, and <a class="el" href="libcvautomation__funcs_8py_source.html#l00179">mouse_up()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9ac61209cab08f17b30fcc33b7b7438f"></a><!-- doxytag: member="libcvautomation_funcs::mouse_location" ref="a9ac61209cab08f17b30fcc33b7b7438f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a9ac61209cab08f17b30fcc33b7b7438f">libcvautomation_funcs.mouse_location</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the current location of the mouse. </p>
|
|
<p>This function will return the current location of the mouse as two variables - i.e. `x, y = <a class="el" href="namespacelibcvautomation__funcs.html#a9ac61209cab08f17b30fcc33b7b7438f" title="Get the current location of the mouse.">mouse_location()</a>`. This is a Python-specific function. </p>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Two variables for the <code>x</code> and <code>y</code> locations </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00574">574</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a12177cc9e099247f535f9c87409d4259"></a><!-- doxytag: member="libcvautomation_funcs::key_string" ref="a12177cc9e099247f535f9c87409d4259" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a12177cc9e099247f535f9c87409d4259">libcvautomation_funcs.key_string</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>string</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Enter a string of text on the keyboard. </p>
|
|
<p>This function will simulate pressing the keys exactly as they are entered - unlike <a class="el" href="namespacelibcvautomation__funcs.html#a75c43acfa38dea829ce26494c7d0bf3f" title="Press a key down on the keyboard, and leave it down.">libcvautomation_funcs::key_down</a>, <a class="el" href="namespacelibcvautomation__funcs.html#ab12bbd622fcf5e9bb7ae31e86731d9a3" title="Release a key on the keyboard.">libcvautomation_funcs::key_up</a>, and <a class="el" href="namespacelibcvautomation__funcs.html#a8f69f7246688b01ac3cfb8dd8d70c955" title="Press and release a key on the keyboard.">libcvautomation_funcs::key_click</a>, this function will display exactly what you entered: A string of <code>'!'</code> will produce a <code>!</code> as a keypress. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">string</td><td>The string of text to enter on the keyboard </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00587">587</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a75c43acfa38dea829ce26494c7d0bf3f"></a><!-- doxytag: member="libcvautomation_funcs::key_down" ref="a75c43acfa38dea829ce26494c7d0bf3f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a75c43acfa38dea829ce26494c7d0bf3f">libcvautomation_funcs.key_down</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>key_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Press a key down on the keyboard, and leave it down. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key_name</td><td>The name of the key to press down. Unlike <a class="el" href="namespacelibcvautomation__funcs.html#a12177cc9e099247f535f9c87409d4259" title="Enter a string of text on the keyboard.">libcvautomation_funcs::key_string</a>, this command will press a single key corresponding to the string you give it - for example, <code>'a'</code>, <code>'b'</code>, or something fancy like <code>'space'</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>See <a class="el" href="xtest_key_strings.html">XTest Key Strings</a> for a full list of accepted key strings. </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00600">600</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab12bbd622fcf5e9bb7ae31e86731d9a3"></a><!-- doxytag: member="libcvautomation_funcs::key_up" ref="ab12bbd622fcf5e9bb7ae31e86731d9a3" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#ab12bbd622fcf5e9bb7ae31e86731d9a3">libcvautomation_funcs.key_up</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>key_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Release a key on the keyboard. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key_name</td><td>The name of the key to release. Unlike <a class="el" href="namespacelibcvautomation__funcs.html#a12177cc9e099247f535f9c87409d4259" title="Enter a string of text on the keyboard.">libcvautomation_funcs::key_string</a>, this command will press a single key corresponding to the string you give it - for example, <code>'a'</code>, <code>'b'</code>, or something fancy like <code>'space'</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>See <a class="el" href="xtest_key_strings.html">XTest Key Strings</a> for a full list of accepted key strings. </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00613">613</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8f69f7246688b01ac3cfb8dd8d70c955"></a><!-- doxytag: member="libcvautomation_funcs::key_click" ref="a8f69f7246688b01ac3cfb8dd8d70c955" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a8f69f7246688b01ac3cfb8dd8d70c955">libcvautomation_funcs.key_click</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>key_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Press and release a key on the keyboard. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key_name</td><td>The name of the key to click. Unlike <a class="el" href="namespacelibcvautomation__funcs.html#a12177cc9e099247f535f9c87409d4259" title="Enter a string of text on the keyboard.">libcvautomation_funcs::key_string</a>, this command will press a single key corresponding to the string you give it - for example, <code>'a'</code>, <code>'b'</code>, or something fancy like <code>'space'</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>See <a class="el" href="xtest_key_strings.html">XTest Key Strings</a> for a full list of accepted key strings. </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Return <code>False</code> if the X11 display was not opened before execution, and <code>True</code> otherwise </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00626">626</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a66cb6c90b7dc78917f1cea203e089a5f"></a><!-- doxytag: member="libcvautomation_funcs::image_location" ref="a66cb6c90b7dc78917f1cea203e089a5f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a66cb6c90b7dc78917f1cea203e089a5f">libcvautomation_funcs.image_location</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>image_names</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>search_method</em> = <code>_search_method_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>tolerance</em> = <code>_tolerance_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_center</em> = <code>True</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the location of an image on the screen. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image_names</td><td>List of image names to search for in the root X11 window </td></tr>
|
|
<tr><td class="paramname">search_method</td><td>The search method to use when matching images. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on using the <code>search_method</code> parameter </td></tr>
|
|
<tr><td class="paramname">tolerance</td><td>The tolerance to use when matching images. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more informatino on using the <code>tolerance</code> parameter </td></tr>
|
|
<tr><td class="paramname">use_center</td><td>Set to <code>True</code> to return the center coordinate of an image. Set to <code>False</code> to use the top-left corner of an image </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="warning"><dt><b>Warning:</b></dt><dd>Unlike <a class="el" href="namespacelibcvautomation__funcs.html#a13cc6e8f778af64c445b78f53c7a3ab7" title="Get the location of an image on the screen, waiting for it to show up.">libcvautomation_funcs::wait_for()</a>, this method will not wait for an image to show up before looking for it. </dd></dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>A dictionary pairing each image name with a <a class="el" href="structcvaPoint.html" title="Very simple structure to standardize how points are used in libcvautomation.">cvaPoint</a> class indicating the location it was found at (a point of (-1, -1) indicates the image was not found), or an empty dictionary if the X11 display was not opened before execution. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00642">642</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a13cc6e8f778af64c445b78f53c7a3ab7"></a><!-- doxytag: member="libcvautomation_funcs::wait_for" ref="a13cc6e8f778af64c445b78f53c7a3ab7" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a13cc6e8f778af64c445b78f53c7a3ab7">libcvautomation_funcs.wait_for</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>image_names</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>search_method</em> = <code>_search_method_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>tolerance</em> = <code>_tolerance_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>timeout</em> = <code>_timeout_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>use_center</em> = <code>True</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Get the location of an image on the screen, waiting for it to show up. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image_names</td><td>List of image names to search for in the root X11 window </td></tr>
|
|
<tr><td class="paramname">search_method</td><td>The search method to use when matching images. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on using the <code>search_method</code> parameter </td></tr>
|
|
<tr><td class="paramname">tolerance</td><td>The tolerance to use when matching images. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more informatino on using the <code>tolerance</code> parameter </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>The time (in seconds) to wait when searching for an image on the root X11 window </td></tr>
|
|
<tr><td class="paramname">use_center</td><td>Set to <code>True</code> to return the center coordinate of an image. Set to <code>False</code> to use the top-left corner of an image </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>A dictionary pairing each image name with a <a class="el" href="structcvaPoint.html" title="Very simple structure to standardize how points are used in libcvautomation.">cvaPoint</a> class indicating the location it was found at (a point of (-1, -1) indicates the image was not found), or an empty dictionary if the X11 display was not opened before execution. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00670">670</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a35d44bdc0e8c0e1e049d701e7c3e64ca"></a><!-- doxytag: member="libcvautomation_funcs::command_string" ref="a35d44bdc0e8c0e1e049d701e7c3e64ca" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def <a class="el" href="namespacelibcvautomation__funcs.html#a35d44bdc0e8c0e1e049d701e7c3e64ca">libcvautomation_funcs.command_string</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>string</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>mouse_button</em> = <code>_mouse_button_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>search_method</em> = <code>_search_method_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>tolerance</em> = <code>_tolerance_default</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>timeout</em> = <code>_timeout_default</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Execute a libcvautomation command based on a string. </p>
|
|
<p>This is a handler for the <a class="el" href="libcvautomation-xtest_8h.html#a7ea1430ed90d3166f8d9fbb4e240a28f" title="Execute a command where the command is coming from a string.">xte_commandString()</a> function. </p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>Not all commands need all the parameters specified. See <a class="el" href="xtest_command_strings.html">xte_commandString() Command Strings</a> for more information on how to use this function. </dd></dl>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">string</td><td>The command string to execute </td></tr>
|
|
<tr><td class="paramname">mouse_button</td><td>The mouse button to click, if applicable </td></tr>
|
|
<tr><td class="paramname">search_method</td><td>The search method to use, if applicable. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use the <code>search_method</code> parameter </td></tr>
|
|
<tr><td class="paramname">tolerance</td><td>The tolerance to use, if applicable. See <a class="el" href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how to use the <code>tolerance</code> parameter </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>The timeout (in seconds) to use, if applicable </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="structcvaPoint.html" title="Very simple structure to standardize how points are used in libcvautomation.">cvaPoint</a> class with the following points:<br/>
|
|
(0, 0) or up indicates a success.<br/>
|
|
(-1, -1) indicates either the command was not successful, or that the command was not recognized.<br/>
|
|
(-2, -2) indicates that the command did not need to return anything - For example, commands like <a class="el" href="xtest_command_strings.html#mousejiggle">Mouse Jiggle</a> don't normally return a value. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="libcvautomation__funcs_8py_source.html#l00701">701</a> of file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
|
|
</div>
|
|
</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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><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 Thu Oct 11 2012 17:42:49 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>
|