From e59ec0cf90f2269e5361b4476b6869107cc0a77f Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Mon, 30 Jul 2012 12:55:11 -0400 Subject: [PATCH] Release version 1.4 documentation --- annotated.html | 4 +-- classes.html | 4 +-- files.html | 4 +-- globals.html | 12 ++++---- globals_defs.html | 4 +-- globals_func.html | 12 ++++---- index.html | 4 +-- libcvautomation-opencv_8h.html | 4 +-- libcvautomation-opencv_8h_source.html | 4 +-- libcvautomation-xlib_8h.html | 4 +-- libcvautomation-xlib_8h_source.html | 4 +-- libcvautomation-xtest_8h.html | 26 ++++++++-------- libcvautomation-xtest_8h_source.html | 10 +++--- libcvautomation.html | 4 +-- libcvautomation_8h.html | 8 ++--- libcvautomation_8h_source.html | 6 ++-- libcvautomation_search_methods.html | 4 +-- pages.html | 4 +-- search/all_78.js | 4 +-- search/functions_78.js | 4 +-- structcvaPoint-members.html | 4 +-- structcvaPoint.html | 4 +-- structcvautomationList-members.html | 4 +-- structcvautomationList.html | 4 +-- wrapper_functions.html | 44 +++++++++++++++++++-------- writing_app_tests.html | 38 +++++++++++------------ xtest_command_strings.html | 18 ++++++----- xtest_key_strings.html | 4 +-- 28 files changed, 136 insertions(+), 114 deletions(-) diff --git a/annotated.html b/annotated.html index d032349..71f24f2 100644 --- a/annotated.html +++ b/annotated.html @@ -34,7 +34,7 @@
libcvautomation -  1.3 +  1.4
@@ -107,7 +107,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
-Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
diff --git a/classes.html b/classes.html index f09543e..08f35e8 100644 --- a/classes.html +++ b/classes.html @@ -34,7 +34,7 @@
libcvautomation -  1.3 +  1.4
@@ -112,7 +112,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
-Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
diff --git a/files.html b/files.html index 7dff409..01f9b67 100644 --- a/files.html +++ b/files.html @@ -34,7 +34,7 @@
libcvautomation -  1.3 +  1.4
@@ -110,7 +110,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
-Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
diff --git a/globals.html b/globals.html index 9538a29..15d39cc 100644 --- a/globals.html +++ b/globals.html @@ -34,7 +34,7 @@
libcvautomation -  1.3 +  1.4
@@ -231,8 +231,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • xte_mouseJiggle() : libcvautomation-xtest.h
    • +
  • xte_mouseLocation() +: libcvautomation-xtest.h +
  • xte_mouseScrollDown() -: libcvautomation-xtest.h +: libcvautomation-xtest.h
  • xte_mouseScrollUp() : libcvautomation-xtest.h @@ -240,9 +243,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • xte_mouseUp() : libcvautomation-xtest.h
    • -
  • xte_pointerLocation() -: libcvautomation-xtest.h -
  • xte_waitForImage() : libcvautomation-xtest.h
    • @@ -271,7 +271,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/globals_defs.html b/globals_defs.html index 52d38ee..cbe1fd5 100644 --- a/globals_defs.html +++ b/globals_defs.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -121,7 +121,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/globals_func.html b/globals_func.html index 6a157a4..f37c310 100644 --- a/globals_func.html +++ b/globals_func.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -209,8 +209,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • xte_mouseJiggle() : libcvautomation-xtest.h
    • +
  • xte_mouseLocation() +: libcvautomation-xtest.h +
  • xte_mouseScrollDown() -: libcvautomation-xtest.h +: libcvautomation-xtest.h
  • xte_mouseScrollUp() : libcvautomation-xtest.h @@ -218,9 +221,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • xte_mouseUp() : libcvautomation-xtest.h
    • -
  • xte_pointerLocation() -: libcvautomation-xtest.h -
  • xte_waitForImage() : libcvautomation-xtest.h
    • @@ -249,7 +249,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/index.html b/index.html index 430b260..e02e2ec 100644 --- a/index.html +++ b/index.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -153,7 +153,7 @@ Questions? Comments? Concerns?
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation-opencv_8h.html b/libcvautomation-opencv_8h.html index 85b3cfa..f3ce752 100644 --- a/libcvautomation-opencv_8h.html +++ b/libcvautomation-opencv_8h.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -532,7 +532,7 @@ Functions
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation-opencv_8h_source.html b/libcvautomation-opencv_8h_source.html index 420fd8a..f7cdb04 100644 --- a/libcvautomation-opencv_8h_source.html +++ b/libcvautomation-opencv_8h_source.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -161,7 +161,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation-xlib_8h.html b/libcvautomation-xlib_8h.html index ff99ec9..eea9d10 100644 --- a/libcvautomation-xlib_8h.html +++ b/libcvautomation-xlib_8h.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -404,7 +404,7 @@ The program using this library is responsible to close the display as well.
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation-xlib_8h_source.html b/libcvautomation-xlib_8h_source.html index ecec9b2..df68a02 100644 --- a/libcvautomation-xlib_8h_source.html +++ b/libcvautomation-xlib_8h_source.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -147,7 +147,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation-xtest_8h.html b/libcvautomation-xtest_8h.html index cddac74..0f3e692 100644 --- a/libcvautomation-xtest_8h.html +++ b/libcvautomation-xtest_8h.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -107,8 +107,8 @@ Defines Functions Bool xte_XTestSupported (Display *displayLocation)  Check if the XTest extension is supported.
    -cvaPoint xte_pointerLocation (Display *displayLocation) - Grab the current location of the pointer.
    +cvaPoint xte_mouseLocation (Display *displayLocation) + Grab the current location of the mouse.
    void xte_clickMouse (Display *displayLocation, int mouseButton)  Click the mouse in its current location.
    void xte_clickMouseXY (Display *displayLocation, int xLocation, int yLocation, int mouseButton) @@ -143,8 +143,8 @@ Functions  Jiggle the mouse in place.
    void xte_mouseScrollUp (Display *displayLocation)  Scroll the mouse up.
    -void xte_mouseScrollDown (Display *displayLocation) - Scroll the mouse down.
    +void xte_mouseScrollDown (Display *displayLocation) + Scroll the mouse down.
    void xte_clickKey (Display *displayLocation, char *key)  Press and release a keyboard key.
    void xte_clickKeyStr (Display *displayLocation, char *string) @@ -225,12 +225,12 @@ Functions - +
    - + @@ -240,14 +240,14 @@ Functions
    -

    Grab the current location of the pointer.

    +

    Grab the current location of the mouse.

    Parameters:
    cvaPoint xte_pointerLocation cvaPoint xte_mouseLocation ( Display *  displayLocation)
    - +
    displayLocationThe Display of which to grab the pointer location from
    displayLocationThe Display of which to grab the mouse location from
    -
    Returns:
    cvaPoint with the current location of the pointer
    +
    Returns:
    cvaPoint with the current location of the mouse
    @@ -1052,12 +1052,12 @@ Functions - +
    - + @@ -1433,7 +1433,7 @@ Functions
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation-xtest_8h_source.html b/libcvautomation-xtest_8h_source.html index dfda24b..0a6b09b 100644 --- a/libcvautomation-xtest_8h_source.html +++ b/libcvautomation-xtest_8h_source.html @@ -34,7 +34,7 @@ @@ -115,8 +115,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00027 * If it's not, return 0 (false) */00028 Bool xte_XTestSupported ( Display *displayLocation ); 00029 -00030 /* Get the current location of the pointer */ -00031 cvaPointxte_pointerLocation ( Display *displayLocation ); +00030 /* Get the current location of the mouse */ +00031 cvaPointxte_mouseLocation ( Display *displayLocation ); 00032 00033 /* Click the mouse where it is currently at */00034 voidxte_clickMouse ( Display *displayLocation, int mouseButton ); @@ -176,7 +176,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00088 voidxte_mouseScrollUp ( Display *displayLocation ); 00089 00090 /* Scroll the mouse down */ -00091 voidxte_mouseScrollDown ( Display *displayLocation ); +00091 voidxte_mouseScrollDown ( Display *displayLocation ); 00092 00093 /* Press and release a key 00094 * Note that we use a string for *key, since keys like "space" are still valid. */ @@ -221,7 +221,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation.html b/libcvautomation.html index 55b40f5..c819f8a 100644 --- a/libcvautomation.html +++ b/libcvautomation.html @@ -34,7 +34,7 @@ @@ -110,7 +110,7 @@ Questions? Comments? Concerns?
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation_8h.html b/libcvautomation_8h.html index 7c7d516..8104dae 100644 --- a/libcvautomation_8h.html +++ b/libcvautomation_8h.html @@ -34,7 +34,7 @@ @@ -116,7 +116,7 @@ Classes - + @@ -133,7 +133,7 @@ Defines
    void void xte_mouseScrollDown void xte_mouseScrollDown ( Display *  displayLocation)
    libcvautomation -  1.3 +  1.4
    libcvautomation -  1.3 +  1.4
    libcvautomation -  1.3 +  1.4
     Implements a structure to build an array for methods like matchSubImage_a() More...

    Defines

    #define LIBCVAUTOMATION_VERSION   "1.3"
    #define LIBCVAUTOMATION_VERSION   "1.4"
     Define what version of Libcvautomation we are using.
    #define LIBCVAUTOMATION_BUGREPORT   "bspeice@uncc.edu"
     Define who to send bug reports to for Libcvautomation.
    - +
    #define LIBCVAUTOMATION_VERSION   "1.3"#define LIBCVAUTOMATION_VERSION   "1.4"
    @@ -178,7 +178,7 @@ Defines
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation_8h_source.html b/libcvautomation_8h_source.html index 99920f1..a01c10f 100644 --- a/libcvautomation_8h_source.html +++ b/libcvautomation_8h_source.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -105,7 +105,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); 00017 #ifndef LIBCVAUTOMATION_H 00018 #define LIBCVAUTOMATION_H 00019 -00020 #define LIBCVAUTOMATION_VERSION "1.3" +00020 #define LIBCVAUTOMATION_VERSION "1.4" 00021 #define LIBCVAUTOMATION_BUGREPORT "bspeice@uncc.edu" 00022 00023 /* C includes */ @@ -171,7 +171,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/libcvautomation_search_methods.html b/libcvautomation_search_methods.html index a2138bd..da2e7a2 100644 --- a/libcvautomation_search_methods.html +++ b/libcvautomation_search_methods.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -141,7 +141,7 @@ Correlation Coefficient (Normalized)
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/pages.html b/pages.html index 9116415..36efbdf 100644 --- a/pages.html +++ b/pages.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -112,7 +112,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/search/all_78.js b/search/all_78.js index a87849d..3f165f0 100644 --- a/search/all_78.js +++ b/search/all_78.js @@ -20,10 +20,10 @@ var searchData= ['xte_5fkeyup',['xte_keyUp',['../libcvautomation-xtest_8h.html#a6af5c14f862dd91fec682fde44a10e23',1,'libcvautomation-xtest.h']]], ['xte_5fmousedown',['xte_mouseDown',['../libcvautomation-xtest_8h.html#acca8cce58009ce177265bea29e8223e8',1,'libcvautomation-xtest.h']]], ['xte_5fmousejiggle',['xte_mouseJiggle',['../libcvautomation-xtest_8h.html#ad4a4b4739bf494478dccb520d6946fbd',1,'libcvautomation-xtest.h']]], - ['xte_5fmousescrolldown',['xte_mouseScrollDown',['../libcvautomation-xtest_8h.html#a9630d64e7c2e9206c88e61c0cf8813db',1,'libcvautomation-xtest.h']]], + ['xte_5fmouselocation',['xte_mouseLocation',['../libcvautomation-xtest_8h.html#aaa6da04691328c02b3fc3442eaa9bb44',1,'libcvautomation-xtest.h']]], + ['xte_5fmousescrolldown',['xte_mouseScrollDown',['../libcvautomation-xtest_8h.html#a5942cc208d0adc9ac8f74175803466b5',1,'libcvautomation-xtest.h']]], ['xte_5fmousescrollup',['xte_mouseScrollUp',['../libcvautomation-xtest_8h.html#a18f5cc7307329ce2e13ceb25b274822b',1,'libcvautomation-xtest.h']]], ['xte_5fmouseup',['xte_mouseUp',['../libcvautomation-xtest_8h.html#a317610586ac31c5c501290099b7ebf63',1,'libcvautomation-xtest.h']]], - ['xte_5fpointerlocation',['xte_pointerLocation',['../libcvautomation-xtest_8h.html#afe460d54f6977c431d1c37d42b0264be',1,'libcvautomation-xtest.h']]], ['xte_5fwaitforimage',['xte_waitForImage',['../libcvautomation-xtest_8h.html#abfbad79445cce59c95940649210f1b31',1,'libcvautomation-xtest.h']]], ['xte_5fwaitforimage_5flocation',['xte_waitForImage_location',['../libcvautomation-xtest_8h.html#a3f474b9f3ae44e2fcf8997a2a806139e',1,'libcvautomation-xtest.h']]], ['xte_5fxtestsupported',['xte_XTestSupported',['../libcvautomation-xtest_8h.html#af5b751f28a87f6ca4c1b3969c2ddb7f4',1,'libcvautomation-xtest.h']]] diff --git a/search/functions_78.js b/search/functions_78.js index a87849d..3f165f0 100644 --- a/search/functions_78.js +++ b/search/functions_78.js @@ -20,10 +20,10 @@ var searchData= ['xte_5fkeyup',['xte_keyUp',['../libcvautomation-xtest_8h.html#a6af5c14f862dd91fec682fde44a10e23',1,'libcvautomation-xtest.h']]], ['xte_5fmousedown',['xte_mouseDown',['../libcvautomation-xtest_8h.html#acca8cce58009ce177265bea29e8223e8',1,'libcvautomation-xtest.h']]], ['xte_5fmousejiggle',['xte_mouseJiggle',['../libcvautomation-xtest_8h.html#ad4a4b4739bf494478dccb520d6946fbd',1,'libcvautomation-xtest.h']]], - ['xte_5fmousescrolldown',['xte_mouseScrollDown',['../libcvautomation-xtest_8h.html#a9630d64e7c2e9206c88e61c0cf8813db',1,'libcvautomation-xtest.h']]], + ['xte_5fmouselocation',['xte_mouseLocation',['../libcvautomation-xtest_8h.html#aaa6da04691328c02b3fc3442eaa9bb44',1,'libcvautomation-xtest.h']]], + ['xte_5fmousescrolldown',['xte_mouseScrollDown',['../libcvautomation-xtest_8h.html#a5942cc208d0adc9ac8f74175803466b5',1,'libcvautomation-xtest.h']]], ['xte_5fmousescrollup',['xte_mouseScrollUp',['../libcvautomation-xtest_8h.html#a18f5cc7307329ce2e13ceb25b274822b',1,'libcvautomation-xtest.h']]], ['xte_5fmouseup',['xte_mouseUp',['../libcvautomation-xtest_8h.html#a317610586ac31c5c501290099b7ebf63',1,'libcvautomation-xtest.h']]], - ['xte_5fpointerlocation',['xte_pointerLocation',['../libcvautomation-xtest_8h.html#afe460d54f6977c431d1c37d42b0264be',1,'libcvautomation-xtest.h']]], ['xte_5fwaitforimage',['xte_waitForImage',['../libcvautomation-xtest_8h.html#abfbad79445cce59c95940649210f1b31',1,'libcvautomation-xtest.h']]], ['xte_5fwaitforimage_5flocation',['xte_waitForImage_location',['../libcvautomation-xtest_8h.html#a3f474b9f3ae44e2fcf8997a2a806139e',1,'libcvautomation-xtest.h']]], ['xte_5fxtestsupported',['xte_XTestSupported',['../libcvautomation-xtest_8h.html#af5b751f28a87f6ca4c1b3969c2ddb7f4',1,'libcvautomation-xtest.h']]] diff --git a/structcvaPoint-members.html b/structcvaPoint-members.html index e5bafaa..de30ddb 100644 --- a/structcvaPoint-members.html +++ b/structcvaPoint-members.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -106,7 +106,7 @@ This is the complete list of members for
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/structcvaPoint.html b/structcvaPoint.html index d60d705..a29360b 100644 --- a/structcvaPoint.html +++ b/structcvaPoint.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -134,7 +134,7 @@ int y
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/structcvautomationList-members.html b/structcvautomationList-members.html index c0fcdc0..fcdd495 100644 --- a/structcvautomationList-members.html +++ b/structcvautomationList-members.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -109,7 +109,7 @@ This is the complete list of members for
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/structcvautomationList.html b/structcvautomationList.html index 4301171..9b39e39 100644 --- a/structcvautomationList.html +++ b/structcvautomationList.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -145,7 +145,7 @@ int tolerance
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/wrapper_functions.html b/wrapper_functions.html index 78901c6..f134450 100644 --- a/wrapper_functions.html +++ b/wrapper_functions.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -116,24 +116,38 @@ Output and Debugging Functions

    Click the mouse

    -
     click 
-

    Click the mouse where it is currently located
    +

     click [mouse-button] 
+

    Click the mouse where it is currently located Optionally specify a mouse button to click

    -
     click_xy <x-coordinate> <y-coordinate> 
-

    Click the mouse on an absolute point on screen

    +
     click_xy <x-coordinate> <y-coordinate> [mouse-button] 
+

    Click the mouse on an absolute point on screen Optionally specify a mouse button to click

    Note:
    The actual process is to move the mouse to the given location, then click there.

    -
     clickr_xy <x-increment> <y-increment> 
-

    Click the mouse on the screen relative to where the mouse is at

    +
     clickr_xy <x-increment> <y-increment> [mouse-button] 
+

    Click the mouse on the screen relative to where the mouse is at Optionally specify a mouse button to click

    Note:
    The actual process is to move the mouse the given distance, then click there.
    Also, note that a positive x-increment moves the mouse to the right, and a positive y-increment moves the mouse down.

    -
     click_i <filename> 
-

    Click the mouse on a screenshot from filename

    +
     click_i <filename> [filename-2] ... [filename-n] 
+

    Click the mouse on a screenshot from filename Optionally specify multiple files to search in.

    +
    Note:
    This is affected by the CENTER, TOLERANCE, and SEARCH_METHOD variables. See Environment Variables for more information on these.
    +
    +
    +
     doubleclick [mouse-button] 
+

    Click the mouse twice Optionally specify a mouse button to click
    +
    +

    +
     doubleclick_xy [mouse-button] 
+

    Click the mouse twice on an absolute point on screen Optionally specify a mouse button to click

    +
    Note:
    The actual process is to move the mouse to the given location, then click there.
    +
    +
    +
     doubleclick_i <filename> [filename-2] ... [filename-n] 
+

    Click the mouse twice on a screenshot from filename Optionally specify multiple files to search in.

    Note:
    This is affected by the CENTER, TOLERANCE, and SEARCH_METHOD variables. See Environment Variables for more information on these.

    @@ -148,11 +162,15 @@ Move the mouse
    Note:
    Note that a positive x-increment moves the mouse to the right, and a positive y-increment moves the mouse down.

    -
     hover_i <filename> 
-

    Move the mouse to a location on screen based on screenshot

    +
     hover_i <filename> [filename-2] ... [filename-n] 
+

    Move the mouse to a location on screen based on screenshot Optionally specify multiple files to search in.

    Note:
    This is affected by the CENTER, TOLERANCE, and SEARCH_METHOD variables. See Environment Variables for more information on these.

    +
     jiggle_mouse 
+

    Very simple wrapper to move the mouse 1 pixel right and 1 pixel down - useful for activating menu items.
    +
    +

     mouse_scrollu

    Scroll the mouse wheel up one

     mouse_scrolld 
@@ -165,7 +183,7 @@ Find an Image
 
    
 
 
     waitfor <filename> 
-
     Wait for an image to display on screen 
    
+

    Wait for an image to display on screen, and then return

    Note:
    This is affected by the TOLERANCE, SEARCH_METHOD, and TIMEOUT variables. See Environment Variables for more information on these.

    Click the keyboard

    @@ -219,7 +237,7 @@ Useful extras
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/writing_app_tests.html b/writing_app_tests.html index 4fbef14..6046518 100644 --- a/writing_app_tests.html +++ b/writing_app_tests.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -81,7 +81,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    Author:
    Bradlee Speice <bspeice@uncc.edu>
    -
    Date:
    7/23/2012
    +
    Date:
    7/30/2012

    Audience

      @@ -212,23 +212,23 @@ The following is the (strongly) recommended process, but is not strictly necessa set -o errexit #Changing any wrapper parameters should go here - + TIMEOUT=30 + start_libreoffice_writer () { - click_i "screens/gnome-1_menu.png" "screens/kde-1_menu.png" - click_i "screens/gnome-2_officeMenu.png" "screens/kde-2_officeMenu.png" - hover_i "screens/gnome-3_LibreOfficeWriter.png" "screens/kde-3_LibreOfficeWriter.png" + click_i "screens/gnome-menu.png" "screens/kde-menu.png" + click_i "screens/gnome-officeMenu.png" "screens/kde-officeMenu.png" + hover_i "screens/gnome-LibreOfficeWriter.png" "screens/kde-LibreOfficeWriter.png" jiggle_mouse click - sleep 30 } close_libreoffice_writer() { - click_i "screens/gnome-4_fileMenu.png" "screens/kde-4_fileMenu.png" - click_i "screens/gnome-5_fileExit.png" "screens/kde-5_fileExit.png" - click_i "screens/gnome-6_discard.png" "screens/kde-6_discard.png" + click_i "screens/gnome-fileMenu.png" "screens/kde-fileMenu.png" + click_i "screens/gnome-fileExit.png" "screens/kde-fileExit.png" + click_i "screens/gnome-discard.png" "screens/kde-discard.png" } start_libreoffice_writer @@ -240,22 +240,22 @@ The following is the (strongly) recommended process, but is not strictly necessa set -o errexit #Changing any wrapper parameters should go here + TIMEOUT=30
  • 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 locate libcvautomation_funcs to find it on your computer. The wrapper itself is a handful of macros used to make our job easy.
  • The set line will abort the test if an error is ever encountered - for example, no images are found.
  • -Changing any wrapper parameters should go after sourcing the wrapper functions. See Environment Variables for more information.
    +Changing any wrapper parameters should go after sourcing the wrapper functions. See Environment Variables for more information. We set the TIMEOUT to 30 seconds here, so that the wrapper will wait 30 seconds (max) for an image to appear before giving up. This way if LibreOffice takes 30 seconds to load, we will wait 30 seconds. If it takes only 5 seconds to load, we will click after those 5 seconds. 

     start_libreoffice_writer ()
  {
-    click_i "screens/gnome-1_menu.png" "screens/kde-1_menu.png"
-    click_i "screens/gnome-2_officeMenu.png" "screens/kde-2_officeMenu.png"
-    hover_i "screens/gnome-3_LibreOfficeWriter.png" "screens/kde-3_LibreOfficeWriter.png"
+    click_i "screens/gnome-menu.png" "screens/kde-menu.png"
+    click_i "screens/gnome-officeMenu.png" "screens/kde-officeMenu.png"
+    hover_i "screens/gnome-LibreOfficeWriter.png" "screens/kde-LibreOfficeWriter.png"
     jiggle_mouse
     click
-    sleep 30
  }
  • @@ -279,9 +279,9 @@ Then we jiggle the mouse to make sure that the item activates, click, and wait f 
     close_libreoffice_writer()
  {
-    click_i "screens/gnome-4_fileMenu.png" "screens/kde-4_fileMenu.png"
-    click_i "screens/gnome-5_fileExit.png" "screens/kde-5_fileExit.png"
-    click_i "screens/gnome-6_discard.png" "screens/kde-6_discard.png"
+    click_i "screens/gnome-fileMenu.png" "screens/kde-fileMenu.png"
+    click_i "screens/gnome-fileExit.png" "screens/kde-fileExit.png"
+    click_i "screens/gnome-discard.png" "screens/kde-discard.png"
  }
  • @@ -339,7 +339,7 @@ If you have questions, comments, concerns, suggestions, or feedback in general,
    -Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by   +Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by   doxygen 1.7.6.1
    diff --git a/xtest_command_strings.html b/xtest_command_strings.html index c2621b5..2eff778 100644 --- a/xtest_command_strings.html +++ b/xtest_command_strings.html @@ -34,7 +34,7 @@
    libcvautomation -  1.3 +  1.4
    @@ -81,8 +81,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

    • This page describes the various command strings available for the xte_commandString() function.

    -

    -Mouse Click

    +

    +Mouse Functions

     'mouseclick <button_number>'

    Click the mouse button <button_number> in-place.

    @@ -134,8 +134,12 @@ Mouse Scroll Up

     'mousescrollu'

    Scroll the mouse up 1 time - depending on window manager settings, etc., this may be multiple lines.

    Note:
    This is a wrapper function for clicking button 5 on the mouse
    -

    -Key Button Click

    +

    +Mouse Location

    +
     'mouselocation' 
+

    Return the current location of the mouse pointer.

    +

    +Keyboard Functions

     'keyclick <key_name>'

    Push and release a keyboard key. This can be a key like 'a', 'b', or something fancy like 'space'. Please see XTest Key Strings for a full list of special keys.

    @@ -150,7 +154,7 @@ Key Button Up

    Keyboard Input String 
     'keystring <string>'

    Input a string of text to the X11 server. For example, inputting 'Hello, world!" will act as if you typed 'Hello, world!' from the keyboard.

    -
    Warning:
    Unlike Key Button Down, Key Button Up, and Key Button Click, this function can not handle special keys like 'space'.
    +
    Warning:
    Unlike Key Button Down, Key Button Up, and keyclick, this function can not handle special keys like 'space'.

    Wait for Image

     'waitfor <image_name>' 
@@ -173,7 +177,7 @@ Wait for Image
 
 
 
    
-Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by  
+Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by  
 doxygen
  1.7.6.1
 
    
diff --git a/xtest_key_strings.html b/xtest_key_strings.html
index 71b695f..5242287 100644
--- a/xtest_key_strings.html
+++ b/xtest_key_strings.html
@@ -34,7 +34,7 @@
   
   
    
    libcvautomation
-    1.3
+    1.4
    
    
    
   
@@ -341,7 +341,7 @@ XF86MonBrightnessDown
 
 
 
    
-Generated on Tue Jul 24 2012 09:24:56 for libcvautomation by  
+Generated on Mon Jul 30 2012 12:42:34 for libcvautomation by  
 doxygen
  1.7.6.1