diff options
author | rafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-09-22 00:20:08 +0000 |
---|---|---|
committer | rafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-09-22 00:20:08 +0000 |
commit | 6e3785e255862f1c927b040ef9603e05dc36dde1 (patch) | |
tree | 5b92ea72742e4483d2c10ce683cb29213d46807e /chrome/common/extensions/docs/tabs.html | |
parent | 0d85afc71c8038e51d1f75ecbcc4621f4e47e2a3 (diff) | |
download | chromium_src-6e3785e255862f1c927b040ef9603e05dc36dde1.zip chromium_src-6e3785e255862f1c927b040ef9603e05dc36dde1.tar.gz chromium_src-6e3785e255862f1c927b040ef9603e05dc36dde1.tar.bz2 |
Extension Doc Changes (no building or testable changes).
Removing stray comma that was breaking the extension docs build.
TBR=aa
Review URL: http://codereview.chromium.org/217009
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@26769 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/tabs.html')
-rwxr-xr-x | chrome/common/extensions/docs/tabs.html | 612 |
1 files changed, 602 insertions, 10 deletions
diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index f3c5e32..7c76c18 100755 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -173,16 +173,20 @@ </li><li jsinstance="3"> <a href="#method-detectLanguage">detectLanguage</a> </li><li jsinstance="4"> - <a href="#method-get">get</a> + <a href="#method-executeScript">executeScript</a> </li><li jsinstance="5"> - <a href="#method-getAllInWindow">getAllInWindow</a> + <a href="#method-get">get</a> </li><li jsinstance="6"> - <a href="#method-getSelected">getSelected</a> + <a href="#method-getAllInWindow">getAllInWindow</a> </li><li jsinstance="7"> - <a href="#method-move">move</a> + <a href="#method-getSelected">getSelected</a> </li><li jsinstance="8"> + <a href="#method-insertCSS">insertCSS</a> + </li><li jsinstance="9"> + <a href="#method-move">move</a> + </li><li jsinstance="10"> <a href="#method-remove">remove</a> - </li><li jsinstance="*9"> + </li><li jsinstance="*11"> <a href="#method-update">update</a> </li> </ol> @@ -1173,6 +1177,300 @@ For example: </div> <!-- /description --> </div><div class="apiItem" jsinstance="4"> + <a name="method-executeScript"></a> <!-- method-anchor --> + <h4>executeScript</h4> + + <div class="summary"><span>boolean</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.tabs.executeScript</span>(<span jsinstance="0" class="optional"><span style="display: none; ">, </span><span>integer</span> + <var><span>tabId</span></var></span><span jsinstance="1" class="optional"><span>, </span><span>object</span> + <var><span>scriptDef</span></var></span><span jsinstance="*2" class="optional"><span>, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p style="display: none; "> + A description from the json schema def of the function goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div jsinstance="0"> + <div> + <dt> + <var>tabId</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>integer</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>The id of tab which run the script, default to selected tab of current window.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div><div jsinstance="1"> + <div> + <dt> + <var>scriptDef</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Note:scripts are injected in the following definition order.</dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div jsinstance="0"> + <div> + <dt> + <var>code</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>JavaScript code to execute.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div><div jsinstance="*1"> + <div> + <dt> + <var>file</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>JavaScript file to execute.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div> + </dl> + </dd> + </div> + </div><div jsinstance="*2"> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>When all scripts are executed, this callback is called.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4>Returns</h4> + <dl> + <div> + <div> + <dt> + <var style="display: none; ">paramName</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>boolean</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Whether this call is successful</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + If you specify the <em>callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span></span>) <span class="subdued">{...}</span>);</pre> + <dl> + <div jsinstance="*0" style="display: none; "> + <div> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div><div class="apiItem" jsinstance="5"> <a name="method-get"></a> <!-- method-anchor --> <h4>get</h4> @@ -1349,7 +1647,7 @@ For example: </div> <!-- /description --> - </div><div class="apiItem" jsinstance="5"> + </div><div class="apiItem" jsinstance="6"> <a name="method-getAllInWindow"></a> <!-- method-anchor --> <h4>getAllInWindow</h4> @@ -1534,7 +1832,7 @@ For example: </div> <!-- /description --> - </div><div class="apiItem" jsinstance="6"> + </div><div class="apiItem" jsinstance="7"> <a name="method-getSelected"></a> <!-- method-anchor --> <h4>getSelected</h4> @@ -1709,7 +2007,301 @@ For example: </div> <!-- /description --> - </div><div class="apiItem" jsinstance="7"> + </div><div class="apiItem" jsinstance="8"> + <a name="method-insertCSS"></a> <!-- method-anchor --> + <h4>insertCSS</h4> + + <div class="summary"><span>boolean</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.tabs.insertCSS</span>(<span jsinstance="0" class="optional"><span style="display: none; ">, </span><span>integer</span> + <var><span>tabId</span></var></span><span jsinstance="1" class="optional"><span>, </span><span>object</span> + <var><span>scriptDef</span></var></span><span jsinstance="*2" class="optional"><span>, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p style="display: none; "> + A description from the json schema def of the function goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div jsinstance="0"> + <div> + <dt> + <var>tabId</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>integer</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>The id of tab which run the script, default to selected tab of current window.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div><div jsinstance="1"> + <div> + <dt> + <var>scriptDef</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>object</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Note:css are injected in the following definition order.</dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div jsinstance="0"> + <div> + <dt> + <var>code</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>CSS code to be injected.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div><div jsinstance="*1"> + <div> + <dt> + <var>file</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>CSS file to be injected.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div> + </dl> + </dd> + </div> + </div><div jsinstance="*2"> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>When all css are inserted, this callback is called.</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4>Returns</h4> + <dl> + <div> + <div> + <dt> + <var style="display: none; ">paramName</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>boolean</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Whether this call is successful</dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + If you specify the <em>callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span></span>) <span class="subdued">{...}</span>);</pre> + <dl> + <div jsinstance="*0" style="display: none; "> + <div> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div><div class="apiItem" jsinstance="9"> <a name="method-move"></a> <!-- method-anchor --> <h4>move</h4> @@ -2007,7 +2599,7 @@ For example: </div> <!-- /description --> - </div><div class="apiItem" jsinstance="8"> + </div><div class="apiItem" jsinstance="10"> <a name="method-remove"></a> <!-- method-anchor --> <h4>remove</h4> @@ -2144,7 +2736,7 @@ For example: </div> <!-- /description --> - </div><div class="apiItem" jsinstance="*9"> + </div><div class="apiItem" jsinstance="*11"> <a name="method-update"></a> <!-- method-anchor --> <h4>update</h4> |