Release version 2.0 documentation for Libcvautomation

This commit is contained in:
Bradlee Speice
2012-10-11 17:43:53 -04:00
parent 9545011a28
commit e49636e36d
64 changed files with 4109 additions and 150 deletions

View File

@ -34,7 +34,7 @@
<td style="padding-left: 0.5em;">
<div id="projectname">libcvautomation
&#160;<span id="projectnumber">1.5</span>
&#160;<span id="projectnumber">2.0</span>
</div>
</td>
@ -54,6 +54,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related&#160;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><a href="files.html"><span>Files</span></a></li>
<li>
@ -217,18 +218,18 @@ The following is the (strongly) recommended process, but is not strictly necessa
start_libreoffice_writer ()
{
click_i <span class="stringliteral">&quot;screens/gnome-menu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-menu.png&quot;</span>
click_i <span class="stringliteral">&quot;screens/gnome-officeMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-officeMenu.png&quot;</span>
hover_i <span class="stringliteral">&quot;screens/gnome-LibreOfficeWriter.png&quot;</span> <span class="stringliteral">&quot;screens/kde-LibreOfficeWriter.png&quot;</span>
jiggle_mouse
click
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-menu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-menu.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-officeMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-officeMenu.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#ac952f6f97c0bc2acdf1ad5b4d1d5acc1" title="Move the mouse to an image inside the root X11 window.">mouse_hover_image</a> <span class="stringliteral">&quot;screens/gnome-LibreOfficeWriter.png&quot;</span> <span class="stringliteral">&quot;screens/kde-LibreOfficeWriter.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a7c2ecbf863dcd5e4af933f38752e81e5" title="Jiggle the mouse in place.">mouse_jiggle</a>
<a class="code" href="namespacelibcvautomation__funcs.html#af4d9b2f324c23336b83399f7fd71852e" title="Press and release a mouse button.">mouse_click</a>
}
close_libreoffice_writer()
{
click_i <span class="stringliteral">&quot;screens/gnome-fileMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileMenu.png&quot;</span>
click_i <span class="stringliteral">&quot;screens/gnome-fileExit.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileExit.png&quot;</span>
click_i <span class="stringliteral">&quot;screens/gnome-discard.png&quot;</span> <span class="stringliteral">&quot;screens/kde-discard.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-fileMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileMenu.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-fileExit.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileExit.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-discard.png&quot;</span> <span class="stringliteral">&quot;screens/kde-discard.png&quot;</span>
}
start_libreoffice_writer
@ -243,7 +244,7 @@ The following is the (strongly) recommended process, but is not strictly necessa
<span class="preprocessor"> TIMEOUT=30</span>
</pre></div> </li>
<li>
The purpose of these lines is just the standard BASH header. Additionally, we import a wrapper created for libcvautomation to make our job easier. Please note that this is the default directory for the wrapper, your installation may be different. Use the command <code>locate libcvautomation_funcs</code> to find it on your computer. The wrapper itself is a handful of macros used to make our job easy. </li>
The purpose of these lines is just the standard BASH header. Additionally, we import a wrapper created for libcvautomation to make our job easier. Please note that this is the default directory for the wrapper, your installation may be different. Use the command <code>locate <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></code> to find it on your computer. The wrapper itself is a handful of macros used to make our job easy. </li>
<li>
The <code>set</code> line will abort the test if an error is ever encountered - for example, no images are found. </li>
<li>
@ -251,11 +252,11 @@ Changing any wrapper parameters should go after sourcing the wrapper functions.
<br/>
<div class="fragment"><pre class="fragment"> start_libreoffice_writer ()
{
click_i <span class="stringliteral">&quot;screens/gnome-menu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-menu.png&quot;</span>
click_i <span class="stringliteral">&quot;screens/gnome-officeMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-officeMenu.png&quot;</span>
hover_i <span class="stringliteral">&quot;screens/gnome-LibreOfficeWriter.png&quot;</span> <span class="stringliteral">&quot;screens/kde-LibreOfficeWriter.png&quot;</span>
jiggle_mouse
click
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-menu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-menu.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-officeMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-officeMenu.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#ac952f6f97c0bc2acdf1ad5b4d1d5acc1" title="Move the mouse to an image inside the root X11 window.">mouse_hover_image</a> <span class="stringliteral">&quot;screens/gnome-LibreOfficeWriter.png&quot;</span> <span class="stringliteral">&quot;screens/kde-LibreOfficeWriter.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a7c2ecbf863dcd5e4af933f38752e81e5" title="Jiggle the mouse in place.">mouse_jiggle</a>
<a class="code" href="namespacelibcvautomation__funcs.html#af4d9b2f324c23336b83399f7fd71852e" title="Press and release a mouse button.">mouse_click</a>
}
</pre></div> </li>
<li>
@ -279,9 +280,9 @@ Then we jiggle the mouse to make sure that the item activates, click, and wait f
<br/>
<div class="fragment"><pre class="fragment"> close_libreoffice_writer()
{
click_i <span class="stringliteral">&quot;screens/gnome-fileMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileMenu.png&quot;</span>
click_i <span class="stringliteral">&quot;screens/gnome-fileExit.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileExit.png&quot;</span>
click_i <span class="stringliteral">&quot;screens/gnome-discard.png&quot;</span> <span class="stringliteral">&quot;screens/kde-discard.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-fileMenu.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileMenu.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-fileExit.png&quot;</span> <span class="stringliteral">&quot;screens/kde-fileExit.png&quot;</span>
<a class="code" href="namespacelibcvautomation__funcs.html#a1a05342b0159044fae6bdb9969d488d6" title="Click a mouse button on an image inside the root X11 window.">mouse_click_image</a> <span class="stringliteral">&quot;screens/gnome-discard.png&quot;</span> <span class="stringliteral">&quot;screens/kde-discard.png&quot;</span>
}
</pre></div> </li>
<li>
@ -327,7 +328,7 @@ If you have questions, comments, concerns, suggestions, or feedback in general,
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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
@ -339,7 +340,7 @@ If you have questions, comments, concerns, suggestions, or feedback in general,
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 13 2012 09:14:32 for libcvautomation by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Oct 11 2012 17:42:49 for libcvautomation by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>