testing/marionette/client/docs/index.rst

branch
TOR_BUG_9701
changeset 15
b8a032363ba2
equal deleted inserted replaced
-1:000000000000 0:de88a04d438a
1 .. Marionette Python Client documentation master file, created by
2 sphinx-quickstart on Tue Aug 6 13:54:46 2013.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6 Marionette Python Client
7 ========================
8
9 The Marionette python client library allows you to remotely control a
10 Gecko-based browser or device which is running a Marionette_
11 server.
12
13 .. _Marionette: https://developer.mozilla.org/en-US/docs/Marionette
14
15 You can install this library from pypi. The package name is
16 marionette_client_.
17
18 .. _marionette_client: https://pypi.python.org/pypi/marionette_client
19
20 .. automodule:: marionette
21
22 Marionette Objects
23 ------------------
24 .. autoclass:: Marionette
25
26 Session Management
27 ``````````````````
28 .. automethod:: Marionette.start_session
29 .. autoattribute:: Marionette.session_capabilities
30 .. automethod:: Marionette.get_cookie
31 .. automethod:: Marionette.get_cookies
32 .. automethod:: Marionette.add_cookie
33 .. automethod:: Marionette.delete_all_cookies
34
35 Context Management
36 ``````````````````
37 .. autoattribute:: Marionette.current_window_handle
38 .. autoattribute:: Marionette.window_handles
39 .. automethod:: Marionette.set_context
40 .. automethod:: Marionette.switch_to_frame
41 .. automethod:: Marionette.switch_to_window
42 .. automethod:: Marionette.get_active_frame
43 .. automethod:: Marionette.close
44
45 Navigation Methods
46 ``````````````````
47 .. autoattribute:: Marionette.title
48 .. automethod:: Marionette.navigate
49 .. automethod:: Marionette.get_url
50 .. automethod:: Marionette.go_back
51 .. automethod:: Marionette.go_forward
52 .. automethod:: Marionette.refresh
53 .. automethod:: Marionette.absolute_url
54 .. automethod:: Marionette.get_window_type
55
56 DOM Element Methods
57 ```````````````````
58 .. automethod:: Marionette.set_search_timeout
59 .. automethod:: Marionette.find_element
60 .. automethod:: Marionette.find_elements
61
62 Script Execution
63 ````````````````
64 .. automethod:: Marionette.execute_script
65 .. automethod:: Marionette.execute_async_script
66 .. automethod:: Marionette.set_script_timeout
67
68 Debugging
69 `````````
70 .. autoattribute:: Marionette.page_source
71 .. automethod:: Marionette.log
72 .. automethod:: Marionette.get_logs
73 .. automethod:: Marionette.screenshot
74
75 Querying and Modifying Document Content
76 ---------------------------------------
77 .. autoclass:: HTMLElement
78
79 .. autoattribute:: HTMLElement.text
80 .. autoattribute:: HTMLElement.location
81 .. autoattribute:: HTMLElement.size
82 .. autoattribute:: HTMLElement.tag_name
83 .. automethod:: HTMLElement.send_keys
84 .. automethod:: HTMLElement.clear
85 .. automethod:: HTMLElement.click
86 .. automethod:: HTMLElement.is_selected
87 .. automethod:: HTMLElement.is_enabled
88 .. automethod:: HTMLElement.is_displayed
89 .. automethod:: HTMLElement.value_of_css_property
90
91 .. autoclass:: DateTimeValue
92
93 .. autoattribute:: DateTimeValue.date
94 .. autoattribute:: DateTimeValue.time
95
96 Action Objects
97 --------------
98
99 Action Sequences
100 ````````````````
101 .. autoclass:: Actions
102
103 .. automethod:: Actions.press
104 .. automethod:: Actions.release
105 .. automethod:: Actions.move
106 .. automethod:: Actions.move_by_offset
107 .. automethod:: Actions.wait
108 .. automethod:: Actions.cancel
109 .. automethod:: Actions.long_press
110 .. automethod:: Actions.flick
111 .. automethod:: Actions.tap
112 .. automethod:: Actions.double_tap
113 .. automethod:: Actions.perform
114
115 Multi-action Sequences
116 ``````````````````````
117 .. autoclass:: MultiActions
118
119 .. automethod:: MultiActions.add
120 .. automethod:: MultiActions.perform
121
122
123 Indices and tables
124 ==================
125
126 * :ref:`genindex`
127 * :ref:`modindex`
128 * :ref:`search`
129

mercurial