diff options
-rw-r--r-- | doc/pyldtp-doc.h | 585 |
1 files changed, 288 insertions, 297 deletions
diff --git a/doc/pyldtp-doc.h b/doc/pyldtp-doc.h index 1086493..e96b310 100644 --- a/doc/pyldtp-doc.h +++ b/doc/pyldtp-doc.h @@ -1072,27 +1072,22 @@ * \subpage getobjectproperty - Get a class (label, type) property of an object * \n * \n - * \subpage getwindowlist - Get current list of window titles - * \n - * \n - * \subpage getwindowsize - Get size of the given window title + * \subpage getobjectnameatcoords - Get object name at the mouse coordinates * \n * \n * \subpage getobjectsize - Get size of the given object * \n * \n - * \subpage guiexist - Checks whether a window exist + * \subpage getwindowlist - Get current list of window titles * \n * \n - * \subpage guitimeout - Modifies the global gui timeout period + * \subpage getwindowsize - Get size of the given window title * \n * \n - * \subpage maximizewindow - Maximize the given window name or all - * open windows + * \subpage guiexist - Checks whether a window exist * \n * \n - * \subpage minimizewindow - Minimize the given window name or all - * open windows + * \subpage guitimeout - Modifies the global gui timeout period * \n * \n * \subpage objectexist - To check whether a component exist in a given window @@ -1137,29 +1132,21 @@ * \subpage activatewin - Activate the window with the given title * \n * \n - * \subpage activatewinpartialname - Activate the window with the - * given partial title - * \n - * \n - * \subpage getactivewin - Get the window title thats currently in focus - * \n - * \n - * \subpage partialexists - Check the window whether it exist based on - * the partial given title - * \n + * \subpage maximizewindow - Maximize the given window name or all + * open windows * \n - * \subpage typekey - Generate keyboard events as if user key in * \n + * \subpage minimizewindow - Minimize the given window name or all + * open windows * \n - * \subpage waitwinname - Wait for window to appear with the given title * \n + * \subpage unmaximizewindow - Unmaximize the given window name or all + * open windows * \n - * \subpage waitwinpartialname - Wait for window to appear with the - * given partial title * \n + * \subpage unminimizewindow - Unminimize the given window name or all + * open windows * \n - * \subpage windowexists - Check the window whether it exist based on - * the given title * \n * * \section WNCKAssumptions Assumptions @@ -1219,7 +1206,7 @@ * \page waittillguiexist waittillguiexist * \section Syntax * - * waittillguiexist ('\<window name\>'[, '\<component name\>'[, guiTimeOut]]) + * waittillguiexist ('\<window name\>'[, '\<component name\>'[, guiTimeOut][, \<'state'\>]]) * * \section Description * @@ -1297,8 +1284,19 @@ * \retval 1 on success, 0 otherwise * * \section Example + * @code + * from ldtp import * + * + * launchapp('gedit') * - * waittillguiexist ('dlgOpen') + * waittillguiexist('*-gedit') + * + * settextvalue('*-gedit', 'txt1', 'test') + * + * # Wait for Undo button state enabled + * waittillguiexist('*-gedit', 'btnUndo', state = state.ENABLED) + * + * @endcode * * This function will be useful, when some event is fired and after that if a new window is expected, we can use this function to wait for window to appear. * @@ -1309,7 +1307,7 @@ * \page waittillguinotexist waittillguinotexist * \section Syntax * - * waittillguinotexist ('\<window name\>'[, '\<component name\>'[, guiTimeOut]]) + * waittillguinotexist ('\<window name\>'[, '\<component name\>'[, guiTimeOut][, \<'state'\>]]) * * \section Description * @@ -1388,7 +1386,28 @@ * * \section Example * - * waittillguinotexist ('dlgOpen') + * @code + * from ldtp import * + * + * launchapp('gedit') + * + * waittillguiexist('*-gedit') + * + * settextvalue('*-gedit', 'txt1', 'test') + * + * # Wait for Undo button state enabled + * waittillguiexist('*-gedit', 'btnUndo', state = state.ENABLED) + * + * click('*-gedit', 'btnUndo') + * + * # Wait for Redo button state enabled + * waittillguiexist('*-gedit', 'btnRedo', state = state.ENABLED) + * # Quit gedit application + * selectmenuitem('*-gedit', 'mnuFile;mnuQuit') + * # Wait for Gedit window to close + * waittillguinotexist('*-gedit') + * + * @endcode * * This function will be useful, when some event is fired and after that if an existing window should close, we can use this function to wait till the window closes. * @@ -4990,6 +5009,9 @@ * from ldtp import * * import threading * + * launchapp('gedit') + * waittillguiexist('*-gedit') + * * callbackRunning = threading.Event() * callbackRunning.clear() * callbackState = threading.Event() @@ -5048,12 +5070,14 @@ * * With respect to gedit application, replace dialog * - * <pre> + * @code * * from ldtp import * - * * import threading * + * launchapp('gedit') + * waittillguiexist('*-gedit') + * * callbackRunning = threading.Event() * callbackRunning.clear() * callbackState = threading.Event() @@ -5091,7 +5115,7 @@ * removecallback('dlgReplace') * removecallback('dlgOpenFiles') * - * </pre> + * @endcode * * \author Nagappan Alagappan <nagappan@gmail.com> */ @@ -5214,8 +5238,6 @@ * * \section Dependency * - * Digwin binary - http://sourceforge.net/projects/ltfx If a specific window has to be captured, then digwin is used to get the window id. - * * Import utility of ImageMagick - http://www.imagemagick.org/script/import.php # Mandatory dependency, if you want to use this function. * * \author Nagashree <mnagashree@novell.com> @@ -5621,189 +5643,6 @@ * */ -/** \page getactivewin getactivewin - * \section Syntax - * - * getactivewin () - * - * \section Description - * - * - * - * \retval The active window title string. - * - * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py - * - * \section Example - * - * title = getactivewin () - * - * print 'Current active window title - ' + title - * - * Gets the current active window title (window that is currently in focus). - * - * \section Dependency - * - * ltfx binary - http://sourceforge.net/projects/ltfx - * - * \author Nagappan Alagappan <nagappan@gmail.com> - * \author Shankar Ganesh <shagan.glare@gmail.com> - * - */ - -/** \page windowexists windowexists - * \section Syntax - * - * windowexists ('\<window name\>') - * - * \section Description - * - * Check window name exists with the given name. - * - * \retval 1 if window exist and 0 otherwise. - * - * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py - * - * \section Example - * - * windowexists ('Mozilla Firefox') - * - * \section Dependency - * - * ltfx binary - http://sourceforge.net/projects/ltfx - * - * \author Nagappan Alagappan <nagappan@gmail.com> - * \author Shankar Ganesh <shagan.glare@gmail.com> - * - */ - -/** \page partialexists partialexists - * \section Syntax - * - * partialexists ('\<window name\>') - * - * \section Description - * - * Check window name partially matches with the given name. - * - * \retval 1 if window exist and 0 otherwise. - * - * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py - * - * \section Example - * - * partialexists ('Firefox') - * - * \section Dependency - * - * ltfx binary - http://sourceforge.net/projects/ltfx - * - * \author Nagappan Alagappan <nagappan@gmail.com> - * \author Shankar Ganesh <shagan.glare@gmail.com> - * - */ - -/** \page activatewinpartialname activatewinpartialname - * \section Syntax - * - * activatewinpartialname ('\<window name\>') - * - * \section Description - * - * Activate window based on the given name that matches partially. - * - * \retval 1 if window exist and 0 otherwise. - * - * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py - * - * \section Example - * - * activatewinpartialname ('Firefox') - * - * \section Dependency - * - * ltfx binary - http://sourceforge.net/projects/ltfx - * - * \author Nagappan Alagappan <nagappan@gmail.com> - * \author Shankar Ganesh <shagan.glare@gmail.com> - * - */ - -/** \page typekey typekey - * \section Syntax - * - * typekey ('\<string to be typed\>') - * - * \section Description - * - * On the current focus area, the string given as argument will be typed. - * - * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py - * - * \section ImplementationDetails - * - * \retval 1 if window exist and 0 otherwise. - * - * This function supports - * - * \<alt\> - for alt key - * - * \<ctrl\> - for control key - * - * \<shift\> - for pressing shift key - * - * \<enter\> - for pressing enter key - * - * \<tab\> - for pressing tab key - * - * \<del\> - for pressing del key - * - * \<bksp\> - for pressing back space key - * - * \<f1\> - for pressing F1 function key - * - * ... - * - * \<f12\> - for pressing F1 function key - * - * \<up\> - for pressing up arrow key - * - * \<down\> - for pressing down arrow key - * - * \<right\> - for pressing right arrow key - * - * \<left\> - for pressing left arrow key - * - * \<esc\> - for pressing escape key - * - * \<space\> - for pressing space bar - * - * \<home\> - for pressing home key - * - * \<end\> - for pressing end key - * - * \<pageup\> - for pressing page up key - * - * \<pagedown\> - for pressing page down key - * - * \<prtscrn\> - for pressing print screen key - * - * - * \section Example - * - * typekey ('\<tab\>testing LDTP using ltfx\<enter\>') - * - * Intially a tab key will be pressed and then text will be typed and then enter key will be pressed - * - * \section Dependency - * - * ltfx binary - http://sourceforge.net/projects/ltfx - * - * \author Nagappan Alagappan <nagappan@gmail.com> - * \author Shankar Ganesh <shagan.glare@gmail.com> - * - */ - /** \page activatewin activatewin * \section Syntax * @@ -5823,95 +5662,97 @@ * * \section Dependency * - * ltfx binary - http://sourceforge.net/projects/ltfx + * Python WNCK * * \author Nagappan Alagappan <nagappan@gmail.com> * \author Shankar Ganesh <shagan.glare@gmail.com> * */ -/** \page waitwinname waitwinname +/** \page windowuptime windowuptime * \section Syntax * - * waitwinname ('\<window name\>') + * windowuptime(['\<window name\>']) * * \section Description * - * Wait for window with the given name to appear. + * Give the window up time * - * \retval 1 if window exist and 0 otherwise. + * \retval startime, endtime (python datetime object) * * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py * * \section Example * - * waitwinname ('Mozilla Firefox') - * - * \section Dependency - * - * ltfx binary - http://sourceforge.net/projects/ltfx + * windowuptime('dlgChatWindow') * * \author Nagappan Alagappan <nagappan@gmail.com> - * \author Shankar Ganesh <shagan.glare@gmail.com> * */ -/** \page waitwinpartialname waitwinpartialname +/** \page activatewindow activatewindow * \section Syntax * - * waitwinpartialname ('\<window name\>') + * activatewindow(['\<window name\>']) * * \section Description * - * Wait for window with the given name partially matches to appear. + * Activate window based on the given name, default None. If None, + * will activate all window one by one * - * \retval 1 if window exist and 0 otherwise. + * \retval None * * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py * * \section Example * - * waitwinpartialname ('Firefox') + * activatewindow('Mozilla Firefox') * * \section Dependency * - * ltfx binary - http://sourceforge.net/projects/ltfx + * wnck, pygtk python library * * \author Nagappan Alagappan <nagappan@gmail.com> - * \author Shankar Ganesh <shagan.glare@gmail.com> + * \author Arvind Patil <apatil@vmware.com> * */ -/** \page windowuptime windowuptime +/** \page maximizewindow maximizewindow * \section Syntax * - * windowuptime(['\<window name\>']) + * maximizewindow(['\<window name\>']) * * \section Description * - * Give the window up time + * Maximize window based on the given name, default None. If None, + * will maximize all window one by one * - * \retval startime, endtime (python datetime object) + * \retval None * * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py * * \section Example * - * windowuptime('dlgChatWindow') + * maximizewindow('Mozilla Firefox') + * + * \section Dependency + * + * wnck, pygtk python library * * \author Nagappan Alagappan <nagappan@gmail.com> + * \author Arvind Patil <apatil@vmware.com> * */ -/** \page activatewindow activatewindow +/** \page minimizewindow minimizewindow * \section Syntax * - * activatewindow(['\<window name\>']) + * minimizewindow(['\<window name\>']) * * \section Description * - * Activate window based on the given name, default None. If None, - * will activate all window one by one + * Minimize window based on the given name, default None. If None, + * will minimize all window one by one * * \retval None * @@ -5919,7 +5760,7 @@ * * \section Example * - * activatewindow('Mozilla Firefox') + * minimizewindow('Mozilla Firefox') * * \section Dependency * @@ -5930,15 +5771,15 @@ * */ -/** \page maximizewindow maximizewindow +/** \page unmaximizewindow unmaximizewindow * \section Syntax * - * maximizewindow(['\<window name\>']) + * unmaximizewindow(['\<window name\>']) * * \section Description * - * Maximize window based on the given name, default None. If None, - * will maximize all window one by one + * Unmaximize window based on the given name, default None. If None, + * will unmaximize all window one by one * * \retval None * @@ -5946,7 +5787,7 @@ * * \section Example * - * maximizewindow('Mozilla Firefox') + * unmaximizewindow('Mozilla Firefox') * * \section Dependency * @@ -5957,15 +5798,15 @@ * */ -/** \page minimizewindow minimizewindow +/** \page unminimizewindow unminimizewindow * \section Syntax * - * minimizewindow(['\<window name\>']) + * unminimizewindow(['\<window name\>']) * * \section Description * - * Minimize window based on the given name, default None. If None, - * will minimize all window one by one + * Unminimize window based on the given name, default None. If None, + * will unminimize all window one by one * * \retval None * @@ -5973,7 +5814,7 @@ * * \section Example * - * minimizewindow('Mozilla Firefox') + * unminimizewindow('Mozilla Firefox') * * \section Dependency * @@ -6723,41 +6564,54 @@ * from ldtp import * * import threading * + * launchapp('gedit') + * waittillguiexist('*-gedit') + * * callbackRunning = threading.Event() - * callbackRunning.clear() - * callbackState = threading.Event() - * callbackState.clear() + * callbackRunning.set() * * def cb(): - * callbackState.set() - * waittillguiexist('dlgReplace') - * click('dlgReplace', 'btnClose') - * callbackState.clear() + * if waittillguiexist('dlgReplace', guiTimeOut = 5): + * wait(0.5) + * click('dlgReplace', 'btnClose') + * waittillguinotexist('dlgReplace') * callbackRunning.set() - * print 'callbackend' - * + * print 'cb callbackend' + * * def cbwithvarargs(*args): * for arg in args: - * print arg - * print 'callbackend' - * + * print arg + * if waittillguiexist('dlgOpenFiles', guiTimeOut = 5): + * wait(0.5) + * click('dlgOpenFiles', 'btnCancel') + * waittillguinotexist('dlgOpenFiles') + * callbackRunning.set() + * print 'cbwithvarargs callbackend' + * * registerevent('window:create', cb) - * registerevent('window:destroy', cbwithvarargs, 'test', 'var', 'args') - * * click('*gedit', 'btnReplace') + * if callbackRunning.isSet(): + * callbackRunning.clear() + * print 'Waiting for callback to complete' + * callbackRunning.wait() + * print 'callbackset' + * deregisterevent('window:create') + * print 'wait' + * callbackRunning.set() + * registerevent('window:create', cbwithvarargs, 'test', 'var', 'args') + * * click('*gedit', 'btnOpen') - * - * waittillguiexist('dlgOpenFiles') - * click('dlgOpenFiles', 'btnCancel') - * - * if callbackState.isSet(): + * + * if callbackRunning.isSet(): + * callbackRunning.clear() * print 'Waiting for callback to complete' * callbackRunning.wait() * print 'callbackset' - * + * * print 'test end' * deregisterevent('window:create') - * deregisterevent('window:destroy') + * selectmenuitem('*-gedit', 'mnuFile;mnuQuit') + * waittillguinotexist('*-gedit') * * @endcode * @@ -6784,41 +6638,178 @@ * from ldtp import * * import threading * + * launchapp('gedit') + * waittillguiexist('*-gedit') + * * callbackRunning = threading.Event() - * callbackRunning.clear() - * callbackState = threading.Event() - * callbackState.clear() + * callbackRunning.set() * * def cb(): - * callbackState.set() - * waittillguiexist('dlgReplace') - * click('dlgReplace', 'btnClose') - * callbackState.clear() + * if waittillguiexist('dlgReplace', guiTimeOut = 5): + * wait(0.5) + * click('dlgReplace', 'btnClose') + * waittillguinotexist('dlgReplace') * callbackRunning.set() - * print 'callbackend' - * + * print 'cb callbackend' + * * def cbwithvarargs(*args): * for arg in args: - * print arg - * print 'callbackend' - * + * print arg + * if waittillguiexist('dlgOpenFiles', guiTimeOut = 5): + * wait(0.5) + * click('dlgOpenFiles', 'btnCancel') + * waittillguinotexist('dlgOpenFiles') + * callbackRunning.set() + * print 'cbwithvarargs callbackend' + * * registerevent('window:create', cb) - * registerevent('window:destroy', cbwithvarargs, 'test', 'var', 'args') - * * click('*gedit', 'btnReplace') + * if callbackRunning.isSet(): + * callbackRunning.clear() + * print 'Waiting for callback to complete' + * callbackRunning.wait() + * print 'callbackset' + * deregisterevent('window:create') + * print 'wait' + * callbackRunning.set() + * registerevent('window:create', cbwithvarargs, 'test', 'var', 'args') + * * click('*gedit', 'btnOpen') + * + * if callbackRunning.isSet(): + * callbackRunning.clear() + * print 'Waiting for callback to complete' + * callbackRunning.wait() + * print 'callbackset' + * + * print 'test end' + * deregisterevent('window:create') + * selectmenuitem('*-gedit', 'mnuFile;mnuQuit') + * waittillguinotexist('*-gedit') * - * waittillguiexist('dlgOpenFiles') - * click('dlgOpenFiles', 'btnCancel') + * @endcode * - * if callbackState.isSet(): + * \author Nagappan Alagappan <nagappan@gmail.com> + * + */ + +/** \page registerkbevent registerkbevent + * \section Syntax + * + * registerkbevent(\<'keys'\>, \<modifiers\>, \<fn_name\>[, *args]) + * + * \section Description + * + * Register keyboard event + * + * \retval 1 on success, 0 on failure + * + * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtp.py + * + * \section Example + * + * @code + * import gtk + * from ldtp import * + * import threading + * + * callbackRunning = threading.Event() + * callbackRunning.set() + * + * def cb(): + * callbackRunning.set() + * print 'cb callbackend' + * + * def fnname(): + * print getobjectnameatcoords() + * print 'fnname callbackend' + * + * registerkbevent('.', int(gtk.gdk.CONTROL_MASK), cb) + * registerkbevent(',', int(gtk.gdk.CONTROL_MASK), fnname) + * if callbackRunning.isSet(): + * callbackRunning.clear() * print 'Waiting for callback to complete' * callbackRunning.wait() * print 'callbackset' + * deregisterkbevent(',', int(gtk.gdk.CONTROL_MASK)) + * deregisterkbevent('.', int(gtk.gdk.CONTROL_MASK)) + * wait(1) + * + * @endcode * - * print 'test end' - * deregisterevent('window:create') - * deregisterevent('window:destroy') + * \author Nagappan Alagappan <nagappan@gmail.com> + * + */ + +/** \page deregisterkbevent deregisterkbevent + * \section Syntax + * + * deregisterkbevent(\<'keys'\>, \<modifiers\>) + * + * \section Description + * + * De-Register keyboard event + * + * \retval 1 on success, 0 on failure + * + * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtp.py + * + * \section Example + * + * @code + * import gtk + * from ldtp import * + * import threading + * + * callbackRunning = threading.Event() + * callbackRunning.set() + * + * def cb(): + * callbackRunning.set() + * print 'cb callbackend' + * + * def fnname(): + * print getobjectnameatcoords() + * print 'fnname callbackend' + * + * registerkbevent('.', int(gtk.gdk.CONTROL_MASK), cb) + * registerkbevent(',', int(gtk.gdk.CONTROL_MASK), fnname) + * if callbackRunning.isSet(): + * callbackRunning.clear() + * print 'Waiting for callback to complete' + * callbackRunning.wait() + * print 'callbackset' + * deregisterkbevent(',', int(gtk.gdk.CONTROL_MASK)) + * deregisterkbevent('.', int(gtk.gdk.CONTROL_MASK)) + * wait(1) + * + * @endcode + * + * \author Nagappan Alagappan <nagappan@gmail.com> + * + */ + +/** \page getobjectnameatcoords getobjectnameatcoords + * \section Syntax + * + * getobjectnameatcoords([wait]) + * + * \section Description + * + * Get object name at the mouse coordinates + * + * \retval 1 on success, 0 on failure + * + * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtp.py + * + * \section Example + * + * @code + * from ldtp import * + * + * print getobjectnameatcoords() + * + * print getobjectnameatcoords(5) * * @endcode * |