michael@0: .. Marionette Python Client documentation master file, created by
michael@0:    sphinx-quickstart on Tue Aug  6 13:54:46 2013.
michael@0:    You can adapt this file completely to your liking, but it should at least
michael@0:    contain the root `toctree` directive.
michael@0: 
michael@0: Marionette Python Client
michael@0: ========================
michael@0: 
michael@0: The Marionette python client library allows you to remotely control a
michael@0: Gecko-based browser or device which is running a Marionette_
michael@0: server.
michael@0: 
michael@0: .. _Marionette: https://developer.mozilla.org/en-US/docs/Marionette
michael@0: 
michael@0: You can install this library from pypi. The package name is
michael@0: marionette_client_.
michael@0: 
michael@0: .. _marionette_client: https://pypi.python.org/pypi/marionette_client
michael@0: 
michael@0: .. automodule:: marionette
michael@0: 
michael@0: Marionette Objects
michael@0: ------------------
michael@0: .. autoclass:: Marionette
michael@0: 
michael@0: Session Management
michael@0: ``````````````````
michael@0: .. automethod:: Marionette.start_session
michael@0: .. autoattribute:: Marionette.session_capabilities
michael@0: .. automethod:: Marionette.get_cookie
michael@0: .. automethod:: Marionette.get_cookies
michael@0: .. automethod:: Marionette.add_cookie
michael@0: .. automethod:: Marionette.delete_all_cookies
michael@0: 
michael@0: Context Management
michael@0: ``````````````````
michael@0: .. autoattribute:: Marionette.current_window_handle
michael@0: .. autoattribute:: Marionette.window_handles
michael@0: .. automethod:: Marionette.set_context
michael@0: .. automethod:: Marionette.switch_to_frame
michael@0: .. automethod:: Marionette.switch_to_window
michael@0: .. automethod:: Marionette.get_active_frame
michael@0: .. automethod:: Marionette.close
michael@0: 
michael@0: Navigation Methods
michael@0: ``````````````````
michael@0: .. autoattribute:: Marionette.title
michael@0: .. automethod:: Marionette.navigate
michael@0: .. automethod:: Marionette.get_url
michael@0: .. automethod:: Marionette.go_back
michael@0: .. automethod:: Marionette.go_forward
michael@0: .. automethod:: Marionette.refresh
michael@0: .. automethod:: Marionette.absolute_url
michael@0: .. automethod:: Marionette.get_window_type
michael@0: 
michael@0: DOM Element Methods
michael@0: ```````````````````
michael@0: .. automethod:: Marionette.set_search_timeout
michael@0: .. automethod:: Marionette.find_element
michael@0: .. automethod:: Marionette.find_elements
michael@0: 
michael@0: Script Execution
michael@0: ````````````````
michael@0: .. automethod:: Marionette.execute_script
michael@0: .. automethod:: Marionette.execute_async_script
michael@0: .. automethod:: Marionette.set_script_timeout
michael@0: 
michael@0: Debugging
michael@0: `````````
michael@0: .. autoattribute:: Marionette.page_source
michael@0: .. automethod:: Marionette.log
michael@0: .. automethod:: Marionette.get_logs
michael@0: .. automethod:: Marionette.screenshot
michael@0: 
michael@0: Querying and Modifying Document Content
michael@0: ---------------------------------------
michael@0: .. autoclass:: HTMLElement
michael@0: 
michael@0: .. autoattribute:: HTMLElement.text
michael@0: .. autoattribute:: HTMLElement.location
michael@0: .. autoattribute:: HTMLElement.size
michael@0: .. autoattribute:: HTMLElement.tag_name
michael@0: .. automethod:: HTMLElement.send_keys
michael@0: .. automethod:: HTMLElement.clear
michael@0: .. automethod:: HTMLElement.click
michael@0: .. automethod:: HTMLElement.is_selected
michael@0: .. automethod:: HTMLElement.is_enabled
michael@0: .. automethod:: HTMLElement.is_displayed
michael@0: .. automethod:: HTMLElement.value_of_css_property
michael@0: 
michael@0: .. autoclass:: DateTimeValue
michael@0: 
michael@0: .. autoattribute:: DateTimeValue.date
michael@0: .. autoattribute:: DateTimeValue.time
michael@0: 
michael@0: Action Objects
michael@0: --------------
michael@0: 
michael@0: Action Sequences
michael@0: ````````````````
michael@0: .. autoclass:: Actions
michael@0: 
michael@0: .. automethod:: Actions.press
michael@0: .. automethod:: Actions.release
michael@0: .. automethod:: Actions.move
michael@0: .. automethod:: Actions.move_by_offset
michael@0: .. automethod:: Actions.wait
michael@0: .. automethod:: Actions.cancel
michael@0: .. automethod:: Actions.long_press
michael@0: .. automethod:: Actions.flick
michael@0: .. automethod:: Actions.tap
michael@0: .. automethod:: Actions.double_tap
michael@0: .. automethod:: Actions.perform
michael@0: 
michael@0: Multi-action Sequences
michael@0: ``````````````````````
michael@0: .. autoclass:: MultiActions
michael@0: 
michael@0: .. automethod:: MultiActions.add
michael@0: .. automethod:: MultiActions.perform
michael@0: 
michael@0: 
michael@0: Indices and tables
michael@0: ==================
michael@0: 
michael@0: * :ref:`genindex`
michael@0: * :ref:`modindex`
michael@0: * :ref:`search`
michael@0: