mirror of
https://github.com/bspeice/libcvautomation
synced 2024-12-04 13:58:11 -05:00
208 lines
20 KiB
HTML
208 lines
20 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.py File 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><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">libcvautomation_funcs.py File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Libcvautomation wrapper for python.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="libcvautomation__funcs_8py_source.html">Go to the source code of this file.</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">libcvautomation_funcs.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">libcvautomation_funcs.LibcvDisplayNotOpen</a></td></tr>
|
|
<tr><td colspan="2"><h2><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacelibcvautomation__funcs.html">libcvautomation_funcs</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight"><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>
|
|
<br/></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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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">libcvautomation_funcs.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.py::_use_frame_trace" ref="a7edd744b08eed255d66bc0f01505ca78" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><b>libcvautomation_funcs._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.py::outfile" ref="ad01360bde654281b0c8084e3c855f0ed" args="" -->
|
|
string </td><td class="memItemRight" valign="bottom"><b>libcvautomation_funcs.outfile</b> = '/dev/null'</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e0baa38cb0b18bbc441ddd4fc9c2fe8"></a><!-- doxytag: member="libcvautomation_funcs.py::_libcvautomation_error_location" ref="a2e0baa38cb0b18bbc441ddd4fc9c2fe8" args="" -->
|
|
 </td><td class="memItemRight" valign="bottom"><b>libcvautomation_funcs._libcvautomation_error_location</b> = libcvautomation.cvaPoint</td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>Libcvautomation wrapper for python. </p>
|
|
<p>This source file is designed to give high-level access to libcvautomation using Python. It was modeled after the Bash wrapper, but allows for access to all the extra features of Python.<br/>
|
|
To use: </p>
|
|
<div class="fragment"><pre class="fragment"> <span class="keyword">import</span> libcvautomation_funcs
|
|
</pre></div> <dl class="author"><dt><b>Author:</b></dt><dd>Bradlee Speice </dd></dl>
|
|
|
|
<p>Definition in file <a class="el" href="libcvautomation__funcs_8py_source.html">libcvautomation_funcs.py</a>.</p>
|
|
</div></div><!-- contents -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </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>
|