1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/marionette/client/docs/index.rst Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,129 @@
1.4 +.. Marionette Python Client documentation master file, created by
1.5 + sphinx-quickstart on Tue Aug 6 13:54:46 2013.
1.6 + You can adapt this file completely to your liking, but it should at least
1.7 + contain the root `toctree` directive.
1.8 +
1.9 +Marionette Python Client
1.10 +========================
1.11 +
1.12 +The Marionette python client library allows you to remotely control a
1.13 +Gecko-based browser or device which is running a Marionette_
1.14 +server.
1.15 +
1.16 +.. _Marionette: https://developer.mozilla.org/en-US/docs/Marionette
1.17 +
1.18 +You can install this library from pypi. The package name is
1.19 +marionette_client_.
1.20 +
1.21 +.. _marionette_client: https://pypi.python.org/pypi/marionette_client
1.22 +
1.23 +.. automodule:: marionette
1.24 +
1.25 +Marionette Objects
1.26 +------------------
1.27 +.. autoclass:: Marionette
1.28 +
1.29 +Session Management
1.30 +``````````````````
1.31 +.. automethod:: Marionette.start_session
1.32 +.. autoattribute:: Marionette.session_capabilities
1.33 +.. automethod:: Marionette.get_cookie
1.34 +.. automethod:: Marionette.get_cookies
1.35 +.. automethod:: Marionette.add_cookie
1.36 +.. automethod:: Marionette.delete_all_cookies
1.37 +
1.38 +Context Management
1.39 +``````````````````
1.40 +.. autoattribute:: Marionette.current_window_handle
1.41 +.. autoattribute:: Marionette.window_handles
1.42 +.. automethod:: Marionette.set_context
1.43 +.. automethod:: Marionette.switch_to_frame
1.44 +.. automethod:: Marionette.switch_to_window
1.45 +.. automethod:: Marionette.get_active_frame
1.46 +.. automethod:: Marionette.close
1.47 +
1.48 +Navigation Methods
1.49 +``````````````````
1.50 +.. autoattribute:: Marionette.title
1.51 +.. automethod:: Marionette.navigate
1.52 +.. automethod:: Marionette.get_url
1.53 +.. automethod:: Marionette.go_back
1.54 +.. automethod:: Marionette.go_forward
1.55 +.. automethod:: Marionette.refresh
1.56 +.. automethod:: Marionette.absolute_url
1.57 +.. automethod:: Marionette.get_window_type
1.58 +
1.59 +DOM Element Methods
1.60 +```````````````````
1.61 +.. automethod:: Marionette.set_search_timeout
1.62 +.. automethod:: Marionette.find_element
1.63 +.. automethod:: Marionette.find_elements
1.64 +
1.65 +Script Execution
1.66 +````````````````
1.67 +.. automethod:: Marionette.execute_script
1.68 +.. automethod:: Marionette.execute_async_script
1.69 +.. automethod:: Marionette.set_script_timeout
1.70 +
1.71 +Debugging
1.72 +`````````
1.73 +.. autoattribute:: Marionette.page_source
1.74 +.. automethod:: Marionette.log
1.75 +.. automethod:: Marionette.get_logs
1.76 +.. automethod:: Marionette.screenshot
1.77 +
1.78 +Querying and Modifying Document Content
1.79 +---------------------------------------
1.80 +.. autoclass:: HTMLElement
1.81 +
1.82 +.. autoattribute:: HTMLElement.text
1.83 +.. autoattribute:: HTMLElement.location
1.84 +.. autoattribute:: HTMLElement.size
1.85 +.. autoattribute:: HTMLElement.tag_name
1.86 +.. automethod:: HTMLElement.send_keys
1.87 +.. automethod:: HTMLElement.clear
1.88 +.. automethod:: HTMLElement.click
1.89 +.. automethod:: HTMLElement.is_selected
1.90 +.. automethod:: HTMLElement.is_enabled
1.91 +.. automethod:: HTMLElement.is_displayed
1.92 +.. automethod:: HTMLElement.value_of_css_property
1.93 +
1.94 +.. autoclass:: DateTimeValue
1.95 +
1.96 +.. autoattribute:: DateTimeValue.date
1.97 +.. autoattribute:: DateTimeValue.time
1.98 +
1.99 +Action Objects
1.100 +--------------
1.101 +
1.102 +Action Sequences
1.103 +````````````````
1.104 +.. autoclass:: Actions
1.105 +
1.106 +.. automethod:: Actions.press
1.107 +.. automethod:: Actions.release
1.108 +.. automethod:: Actions.move
1.109 +.. automethod:: Actions.move_by_offset
1.110 +.. automethod:: Actions.wait
1.111 +.. automethod:: Actions.cancel
1.112 +.. automethod:: Actions.long_press
1.113 +.. automethod:: Actions.flick
1.114 +.. automethod:: Actions.tap
1.115 +.. automethod:: Actions.double_tap
1.116 +.. automethod:: Actions.perform
1.117 +
1.118 +Multi-action Sequences
1.119 +``````````````````````
1.120 +.. autoclass:: MultiActions
1.121 +
1.122 +.. automethod:: MultiActions.add
1.123 +.. automethod:: MultiActions.perform
1.124 +
1.125 +
1.126 +Indices and tables
1.127 +==================
1.128 +
1.129 +* :ref:`genindex`
1.130 +* :ref:`modindex`
1.131 +* :ref:`search`
1.132 +
