</pre></div><p> This controls how each of the functions searches for an image. See <aclass="el"href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more instruction on how to use this option.</p>
</pre></div><p> These control how tolerant each function is when searching for an image. Acceptable values are anywhere between <code>INT_MIN</code> to <code>INT_MAX</code>. See <aclass="el"href="libcvautomation_search_methods.html">Libcv Search Methods</a> for more information on how the tolerance values work. Additionally, the cva-input and cva-match programs (which this wrapper depends on) implement a "sane-tolerance" option. This allows you to set a tolerance between 1 - 100, where: \( 1 \approx 0 \), and \( 100 \approx INT\_MAX \) By default, functions will not use sane tolerance. To make the functions search using sane tolerance, set </p>
</pre></div><p> This controls whether each function will return a value based on the center of the sub-image, rather than the top-left corner. By default, functions will use center-based matching. To make the functions use the top-left corner, set </p>
</pre></div><p> These control how the "waitfor" function is used. By default, all image-matching functions will wait for an image to appear, and then click on it. This way, it won't click randomly if it can or can't find an image, and provides very easy error recognition. The functions will wait for a period of <code>TIMEOUT</code> seconds before complaining. To disable waiting before performing an action, set </p>
</pre></div><dlclass="warning"><dt><b>Warning:</b></dt><dd>Without setting a tolerance value, the waitfor function becomes totally useless, as the first search will always find an image. <code>Make sure to set the tolerance</code> (or just leave it as the default value in the wrapper).</dd></dl>
</pre></div><p> These files control the reporting of libcvautomation_funcs. The wrapper generates a decent amount of output to help in debugging application tests, and by default these get redirected to /dev/null. To instead redirect them to a file, you can do something like this: </p>
<dlclass="note"><dt><b>Note:</b></dt><dd>This is affected by the <code>CENTER</code>, <code>TOLERANCE</code>, and <code>SEARCH_METHOD</code> variables. See <aclass="el"href="wrapper_functions.html#appendix_variables">Environment Variables</a> for more information on these. <br/>
</pre></div><p> Move the mouse to a location on screen using relative positioning </p>
<dlclass="note"><dt><b>Note:</b></dt><dd>Note that a positive <code>x-increment</code> moves the mouse to the right, and a positive <code>y-increment</code> moves the mouse down. <br/>
<dlclass="note"><dt><b>Note:</b></dt><dd>This is affected by the <code>CENTER</code>, <code>TOLERANCE</code>, and <code>SEARCH_METHOD</code> variables. See <aclass="el"href="wrapper_functions.html#appendix_variables">Environment Variables</a> for more information on these. <br/>
<dlclass="note"><dt><b>Note:</b></dt><dd>This is affected by the <code>CENTER</code>, <code>TOLERANCE</code>, and <code>SEARCH_METHOD</code> variables. See <aclass="el"href="wrapper_functions.html#appendix_variables">Environment Variables</a> for more information on these. <br/>
</pre></div><p> Wait for an image to display on screen </p>
<dlclass="note"><dt><b>Note:</b></dt><dd>This is affected by the <code>TOLERANCE</code>, <code>SEARCH_METHOD</code>, and <code>TIMEOUT</code> variables. See <aclass="el"href="wrapper_functions.html#appendix_variables">Environment Variables</a> for more information on these.</dd></dl>
</pre></div><p> Enter a string of characters on the keyboard rather than a single character at a time. </p>
<dlclass="warning"><dt><b>Warning:</b></dt><dd>This function <b>does not</b> accept key strings like "Space" as <code>key_down</code>, <code>key_up</code>, and <code>key_click</code> do. If you pass in "Space", that is exactly what will be typed. <br/>
<dlclass="note"><dt><b>Note:</b></dt><dd>This function accepts special keys like "Space" - see <aclass="el"href="xtest_key_strings.html">XTest Key Strings</a> for a full list of characters allowed. <br/>
<dlclass="note"><dt><b>Note:</b></dt><dd>This function accepts special keys like "Space" - see <aclass="el"href="xtest_key_strings.html">XTest Key Strings</a> for a full list of characters allowed. <br/>
<dlclass="note"><dt><b>Note:</b></dt><dd>This function accepts special keys like "Space" - see <aclass="el"href="xtest_key_strings.html">XTest Key Strings</a> for a full list of characters allowed. <br/>
</pre></div><p> Display a notification to the user, and wait for a response </p>
<dlclass="warning"><dt><b>Warning:</b></dt><dd>Uses <code>zenity</code> - if <code>zenity</code> isn't available, will return an error without pausing, and will not display anything. </dd></dl>