tools/telemetry/docs/telemetry.page.actions.page_action.html - Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts

Unified Diff: tools/telemetry/docs/telemetry.page.actions.page_action.html

Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: update with nits Created 7 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html ('k') | tools/telemetry/docs/telemetry.page.actions.reload.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/telemetry.page.actions.page_action.html

diff --git a/tools/telemetry/docs/telemetry.page.actions.page_action.html b/tools/telemetry/docs/telemetry.page.actions.page_action.html

new file mode 100644

index 0000000000000000000000000000000000000000..4ca1b520bc79d9e89f7c633a819bfb40931b236d

--- /dev/null

+++ b/tools/telemetry/docs/telemetry.page.actions.page_action.html

@@ -0,0 +1,205 @@

+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

+<html><head><title>Python: module telemetry.page.actions.page_action</title>

+</head><body bgcolor="#f0f0f8">

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

+<tr bgcolor="#7799ee">

+<td valign=bottom>

+  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.page.html">page</a>.<a href="telemetry.page.actions.html">actions</a>.page_action</big></big></td

+><td align=right valign=bottom

+><a href=".">index</a> <a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/page_action.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/page_action.py</a></td></tr></table>

+ <tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.

+# Use of this source code is governed by a BSD-style license that can be

+# found in the LICENSE file.</tt>

+

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ee77aa">

+<td colspan=3 valign=bottom>

+<big>Classes</big></td></tr>

+<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>

+<td width="100%"><dl>

+<dt><a href="__builtin__.html#object">__builtin__.object</a>

+</dt><dd>

+<dl>

+<dt><a href="telemetry.page.actions.page_action.html#PageAction">PageAction</a>

+</dt></dl>

+</dd>

+<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

+</dt><dd>

+<dl>

+<dt><a href="telemetry.page.actions.page_action.html#PageActionFailed">PageActionFailed</a>

+</dt><dt><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">PageActionNotSupported</a>

+</dt></dl>

+</dd>

+</dl>

+

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="PageAction">class PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

+<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

+<td colspan=2><tt>Represents an action that a user might try to perform to a page.  </tt></td></tr>

+<tr><td> </td>

+<td width="100%">Methods defined here:

+<dl><dt><a name="PageAction-BindMeasurementJavaScript">BindMeasurementJavaScript</a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.

+

+A measurement can call this method to provide the action

+with JavaScript code that starts and stops measurements. The action

+determines when to execute the provided JavaScript code, for more accurate

+timings.

+

+Args:

+  tab: The tab to do everything on.

+  start_js: JavaScript code that starts measurements.

+  stop_js: JavaScript code that stops measurements.</tt></dd></dl>

+<dl><dt><a name="PageAction-CanBeBound">CanBeBound</a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound

+to return True so that a test knows it can bind measurements.</tt></dd></dl>

+<dl><dt><a name="PageAction-CleanUp">CleanUp</a>(self, page, tab)</dt></dl>

+<dl><dt><a name="PageAction-CustomizeBrowserOptions">CustomizeBrowserOptions</a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions

+<a href="__builtin__.html#object">object</a>.</tt></dd></dl>

+<dl><dt><a name="PageAction-RunAction">RunAction</a>(self, page, tab, previous_action)</dt></dl>

+<dl><dt><a name="PageAction-RunsPreviousAction">RunsPreviousAction</a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the

+previous action. For example, wait for href change needs to record the old

+href before the previous action changes it. Therefore, we allow actions to

+run the previous action. An action that does this should override this to

+return True in order to prevent the previous action from being run twice.</tt></dd></dl>

+<dl><dt><a name="PageAction-WillRunAction">WillRunAction</a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before

+Test.WillRunAction is called.</tt></dd></dl>

+<dl><dt><a name="PageAction-__init__">__init__</a>(self, attributes=None)</dt></dl>

+<hr>

+Data descriptors defined here:

+<dl><dt>__dict__</dt>

+<dd><tt>dictionary for instance variables (if defined)</tt></dd>

+</dl>

+<dl><dt>__weakref__</dt>

+<dd><tt>list of weak references to the object (if defined)</tt></dd>

+</dl>

+</td></tr></table>

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="PageActionFailed">class PageActionFailed</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

+<tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

+<td width="100%"><dl><dt>Method resolution order:</dt>

+<dd><a href="telemetry.page.actions.page_action.html#PageActionFailed">PageActionFailed</a></dd>

+<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

+<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

+<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

+</dl>

+<hr>

+Data descriptors defined here:

+<dl><dt>__weakref__</dt>

+<dd><tt>list of weak references to the object (if defined)</tt></dd>

+</dl>

+<hr>

+Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt><a name="PageActionFailed-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

+<hr>

+Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#PageActionFailed-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

+<hr>

+Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt><a name="PageActionFailed-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

+<dl><dt><a name="PageActionFailed-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

+<dl><dt><a name="PageActionFailed-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

+<dl><dt><a name="PageActionFailed-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

+

+Use of negative indices is not supported.</tt></dd></dl>

+<dl><dt><a name="PageActionFailed-__reduce__">__reduce__</a>(...)</dt></dl>

+<dl><dt><a name="PageActionFailed-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

+<dl><dt><a name="PageActionFailed-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

+<dl><dt><a name="PageActionFailed-__setstate__">__setstate__</a>(...)</dt></dl>

+<dl><dt><a name="PageActionFailed-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

+<dl><dt><a name="PageActionFailed-__unicode__">__unicode__</a>(...)</dt></dl>

+<hr>

+Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt>__dict__</dt>

+</dl>

+<dl><dt>args</dt>

+</dl>

+<dl><dt>message</dt>

+</dl>

+</td></tr></table>

+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="PageActionNotSupported">class PageActionNotSupported</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

+<tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

+<td width="100%"><dl><dt>Method resolution order:</dt>

+<dd><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">PageActionNotSupported</a></dd>

+<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

+<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

+<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

+</dl>

+<hr>

+Data descriptors defined here:

+<dl><dt>__weakref__</dt>

+<dd><tt>list of weak references to the object (if defined)</tt></dd>

+</dl>

+<hr>

+Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt><a name="PageActionNotSupported-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

+<hr>

+Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

+<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#PageActionNotSupported-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

+<hr>

+Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt><a name="PageActionNotSupported-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

+<dl><dt><a name="PageActionNotSupported-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

+<dl><dt><a name="PageActionNotSupported-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

+<dl><dt><a name="PageActionNotSupported-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

+

+Use of negative indices is not supported.</tt></dd></dl>

+<dl><dt><a name="PageActionNotSupported-__reduce__">__reduce__</a>(...)</dt></dl>

+<dl><dt><a name="PageActionNotSupported-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

+<dl><dt><a name="PageActionNotSupported-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

+<dl><dt><a name="PageActionNotSupported-__setstate__">__setstate__</a>(...)</dt></dl>

+<dl><dt><a name="PageActionNotSupported-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

+<dl><dt><a name="PageActionNotSupported-__unicode__">__unicode__</a>(...)</dt></dl>

+<hr>

+Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

+<dl><dt>__dict__</dt>

+</dl>

+<dl><dt>args</dt>

+</dl>

+<dl><dt>message</dt>

+</dl>

+</td></tr></table></td></tr></table>

+</body></html>