← Back to branch summary

~ara/ubuntu/lucid/ldtp/ldtp_fix_551457

« back to all changes in this revision

Viewing changes to doc/pyldtp-doc.h

  • Committer: Bazaar Package Importer
  • Author(s): Ara Pulido
  • Date: 2009-08-13 09:54:47 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20090813095447-oxj1hf00ff8wljbf
Tags: 1.7.0-0ubuntu1
https://launchpad.net/bugs/412882
https://launchpad.net/bugs/412871
* New upstream release (Fixes LP: #412882)
* debian/control:
  + Changed Depends from deprecated python-gnome2-desktop
    to python-wnck and python-gtksourceview (Fixes LP: #412871)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/pyldtp-doc.h
1062
1062
 *
1063
1063
 * \section WindowAPI Window python API's
1064
1064
 *
 
1065
 * \subpage activatewindow - Activate the given window name or all
 
1066
 * open windows
 
1067
 * \n
 
1068
 * \n
 
1069
 * \subpage closewindow - Close the given window name or all
 
1070
 * open windows
 
1071
 * \n
 
1072
 * \n
1065
1073
 * \subpage getapplist - Get list of accessibility enabled applications
1066
1074
 * \n
1067
1075
 * \n
1092
1100
 * \subpage guitimeout - Modifies the global gui timeout period
1093
1101
 * \n
1094
1102
 * \n
 
1103
 * \subpage maximizewindow - Maximize the given window name or all
 
1104
 * open windows
 
1105
 * \n
 
1106
 * \n
 
1107
 * \subpage minimizewindow - Minimize the given window name or all
 
1108
 * open windows
 
1109
 * \n
 
1110
 * \n
1095
1111
 * \subpage objectexist - To check whether a component exist in a given window
1096
1112
 * \n
1097
1113
 * \n
1181
1197
 * 
1182
1198
 * Application map will be loaded
1183
1199
 * 
1184
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/appmap.c
 
1200
 * Refer:
 
1201
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
 
1202
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/appmap.c
1185
1203
 * 
1186
1204
 * \section Example
1187
1205
 * 
2728
2746
 *
2729
2747
 * \retval 1 on success, LdtpExecutionError exception on failure
2730
2748
 *
2731
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/layered-pane.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/combo-box.c
 
2749
 * Refer:
 
2750
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/layered-pane.c
 
2751
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/combo-box.c
2732
2752
 *
2733
2753
 * \section Example
2734
2754
 *
3782
3802
/** \page doesrowexist doesrowexist
3783
3803
 * \section Syntax
3784
3804
 *
3785
 
 * doesrowexist ('\<window name\>', '\<table name\>', '\<string to be matched\>', no of matches)
 
3805
 * doesrowexist ('\<window name\>', '\<table name\>', '\<string to be
 
3806
 * matched\>'[, \<partial match = False\>])
3786
3807
 *
3787
3808
 * \section Description
3788
3809
 *
3789
 
 * Checks whether the table contains any row with any of its cell containing the given string as its value.Please note that it checks for an exact match.
 
3810
 * Checks whether the table contains any row with any of its cell
 
3811
 * containing the given string as its value.Please note that it checks
 
3812
 * for an exact match, if partial match is set to False. 
3790
3813
 *
3791
3814
 * \section ImplementationDetails
3792
3815
 *
3801
3824
 * With respect to the message list table in Evolution Mailer, the following call will return 1 if there is atleast one mail in the list with the given string in the subject field or sender field or in any other field for that matter.
3802
3825
 * 
3803
3826
 * doesrowexist ('dlgContactListMembers', 'tblContacts', 'Sample subject') 
 
3827
 * 
 
3828
 * doesrowexist ('dlgContactListMembers', 'tblContacts', 'Sample', True) 
3804
3829
 *
3805
3830
 * \author Manu <manunature@rediffmail.com>
3806
3831
 */
3920
3945
 *
3921
3946
 * \retval 1 on success, LdtpExecutionError exception on failure
3922
3947
 *
3923
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
 
3948
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c
 
3949
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
3924
3950
 *
3925
3951
 * \section Example
3926
3952
 *
3940
3966
 *
3941
3967
 * \retval 1 on success, LdtpExecutionError exception on failure
3942
3968
 *
3943
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
 
3969
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c
 
3970
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
3944
3971
 *
3945
3972
 * \section Example
3946
3973
 *
4677
4704
 *
4678
4705
 * \retval 1 on success, else 0.
4679
4706
 *
4680
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
 
4707
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c
 
4708
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
4681
4709
 *
4682
4710
 * \section Example
4683
4711
 *
4697
4725
 *
4698
4726
 * \retval 1 on success, else 0.
4699
4727
 *
4700
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
 
4728
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c
 
4729
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
4701
4730
 *
4702
4731
 * \section Example
4703
4732
 *
4717
4746
 *
4718
4747
 * \retval 1 on success, else 0.
4719
4748
 *
4720
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
 
4749
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/tree-table.c
 
4750
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/table.c
4721
4751
 *
4722
4752
 * \section Example
4723
4753
 *
4937
4967
 *
4938
4968
 * \retval 1 on success, else LdtpExecutionError exception
4939
4969
 *
4940
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/ldtp-gui.c
 
4970
 * Refer:
 
4971
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
 
4972
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/ldtp-gui.c
4941
4973
 *
4942
4974
 * \section Example
4943
4975
 *
5010
5042
 *
5011
5043
 * \retval 1 on success, else LdtpExecutionError exception
5012
5044
 *
5013
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/ldtp-gui.c
 
5045
 * Refer:
 
5046
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
 
5047
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/ldtp-gui.c
5014
5048
 *
5015
5049
 * \section Example
5016
5050
 *
5226
5260
/** \page imagecapture imagecapture
5227
5261
 * \section Syntax
5228
5262
 *
5229
 
 * imagecapture ([\<window name\>, [\<output file\>, (opt)\<resolution-x\>, (opt)\<resolution-y\>, (opt)startx, (opt)starty]])
 
5263
 * imagecapture ([\<window name\>, [\<output file\>, (opt)\<width-x\>, (opt)\<height-y\>, (opt)x, (opt)y]])
5230
5264
 *
5231
5265
 * \section Description
5232
5266
 *
5711
5745
 *
5712
5746
 */
5713
5747
 
 
5748
/** \page windowuptime windowuptime
 
5749
 * \section Syntax
 
5750
 *
 
5751
 * windowuptime(['\<window name\>'])
 
5752
 *
 
5753
 * \section Description
 
5754
 *
 
5755
 * Give the window up time
 
5756
 *
 
5757
 * \retval startime, endtime (python datetime object)
 
5758
 *
 
5759
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py
 
5760
 *
 
5761
 * \section Example
 
5762
 *
 
5763
 * windowuptime('dlgChatWindow')
 
5764
 *
 
5765
 * \author Nagappan Alagappan <nagappan@gmail.com>
 
5766
 *
 
5767
 */
 
5768
 
 
5769
/** \page activatewindow activatewindow
 
5770
 * \section Syntax
 
5771
 *
 
5772
 * activatewindow(['\<window name\>'])
 
5773
 *
 
5774
 * \section Description
 
5775
 *
 
5776
 * Activate window based on the given name, default None. If None,
 
5777
 * will activate all window one by one
 
5778
 *
 
5779
 * \retval None
 
5780
 *
 
5781
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py
 
5782
 *
 
5783
 * \section Example
 
5784
 *
 
5785
 * activatewindow('Mozilla Firefox')
 
5786
 *
 
5787
 * \section Dependency
 
5788
 *
 
5789
 * wnck, pygtk python library
 
5790
 *
 
5791
 * \author Nagappan Alagappan <nagappan@gmail.com>
 
5792
 * \author Arvind Patil <apatil@vmware.com>
 
5793
 *
 
5794
 */
 
5795
 
 
5796
/** \page maximizewindow maximizewindow
 
5797
 * \section Syntax
 
5798
 *
 
5799
 * maximizewindow(['\<window name\>'])
 
5800
 *
 
5801
 * \section Description
 
5802
 *
 
5803
 * Maximize window based on the given name, default None. If None,
 
5804
 * will maximize all window one by one
 
5805
 *
 
5806
 * \retval None
 
5807
 *
 
5808
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py
 
5809
 *
 
5810
 * \section Example
 
5811
 *
 
5812
 * maximizewindow('Mozilla Firefox')
 
5813
 *
 
5814
 * \section Dependency
 
5815
 *
 
5816
 * wnck, pygtk python library
 
5817
 *
 
5818
 * \author Nagappan Alagappan <nagappan@gmail.com>
 
5819
 * \author Arvind Patil <apatil@vmware.com>
 
5820
 *
 
5821
 */
 
5822
 
 
5823
/** \page minimizewindow minimizewindow
 
5824
 * \section Syntax
 
5825
 *
 
5826
 * minimizewindow(['\<window name\>'])
 
5827
 *
 
5828
 * \section Description
 
5829
 *
 
5830
 * Minimize window based on the given name, default None. If None,
 
5831
 * will minimize all window one by one
 
5832
 *
 
5833
 * \retval None
 
5834
 *
 
5835
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py
 
5836
 *
 
5837
 * \section Example
 
5838
 *
 
5839
 * minimizewindow('Mozilla Firefox')
 
5840
 *
 
5841
 * \section Dependency
 
5842
 *
 
5843
 * wnck, pygtk python library
 
5844
 *
 
5845
 * \author Nagappan Alagappan <nagappan@gmail.com>
 
5846
 * \author Arvind Patil <apatil@vmware.com>
 
5847
 *
 
5848
 */
 
5849
 
 
5850
/** \page closewindow closewindow
 
5851
 * \section Syntax
 
5852
 *
 
5853
 * closewindow(['\<window name\>'])
 
5854
 *
 
5855
 * \section Description
 
5856
 *
 
5857
 * Close window based on the given name, default None. If None,
 
5858
 * will close all window one by one
 
5859
 *
 
5860
 * \retval None
 
5861
 *
 
5862
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtputils.py
 
5863
 *
 
5864
 * \section Example
 
5865
 *
 
5866
 * closewindow('Mozilla Firefox')
 
5867
 *
 
5868
 * \section Dependency
 
5869
 *
 
5870
 * wnck, pygtk python library
 
5871
 *
 
5872
 * \author Nagappan Alagappan <nagappan@gmail.com>
 
5873
 * \author Arvind Patil <apatil@vmware.com>
 
5874
 *
 
5875
 */
 
5876
 
5714
5877
/** \page getpanelchildcount getpanelchildcount
5715
5878
 * \section Syntax
5716
5879
 *
5747
5910
 *
5748
5911
 * \retval Returns 1 on success, LdtpExecutionError exception will be thrown on failure
5749
5912
 *
5750
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/localization.c
 
5913
 * Refer:
 
5914
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
 
5915
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/localization.c
5751
5916
 *
5752
5917
 * \section Example
5753
5918
 *
5770
5935
 *
5771
5936
 * \retval Returns 1 on success, LdtpExecutionError exception will be thrown on failure
5772
5937
 *
5773
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/src/localization.c
 
5938
 * Refer:
 
5939
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
 
5940
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/localization.c
5774
5941
 *
5775
5942
 * \section Example
5776
5943
 *
6266
6433
 *
6267
6434
 * \retval 1 on success, 0 on failure
6268
6435
 *
6269
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtp.py
 
6436
 * Refer:
 
6437
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
 
6438
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtp.py
6270
6439
 *
6271
6440
 * \section Example
6272
6441
 *
6276
6445
 *
6277
6446
 * hasstate ('*-gedit', 'txt0', state.FOCUSABLE)
6278
6447
 *
6279
 
 * hasstate ('*-gedit', 'txt0', state.FOCUSABLE + state.VISIBLE)
 
6448
 * hasstate ('*-gedit', 'txt0', state.FOCUSABLE, state.VISIBLE)
6280
6449
 *
6281
6450
 * \author Nagappan Alagappan <nagappan@gmail.com>
6282
6451
 *
6293
6462
 *
6294
6463
 * \retval 1 on success, 0 on failure
6295
6464
 *
6296
 
 * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/toggle-button.c, http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtp.py
 
6465
 * Refer:
 
6466
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/src/toggle-button.c
 
6467
 * http://cgit.freedesktop.org/ldtp/ldtp/tree/python/ldtp.py
6297
6468
 *
6298
6469
 * \section Example
6299
6470
 *