chrome/common/extensions/docs/experimental.devtools.panels.html - Issue 8538005: Anoher clean-up for chrome.experimental.devtools.* docs

Unified Diff: chrome/common/extensions/docs/experimental.devtools.panels.html

Issue 8538005: Anoher clean-up for chrome.experimental.devtools.* docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Added onShown/onHidden events on ExtensionPanel and ExtensionSidebarPane Created 9 years, 1 month 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

Index: chrome/common/extensions/docs/experimental.devtools.panels.html

diff --git a/chrome/common/extensions/docs/experimental.devtools.panels.html b/chrome/common/extensions/docs/experimental.devtools.panels.html

index 2c54d9b52b8459c797a7c392065c4454165b3d64..fe2dc803bc2192d11f88df2445e5aed62a708695 100644

--- a/chrome/common/extensions/docs/experimental.devtools.panels.html

+++ b/chrome/common/extensions/docs/experimental.devtools.panels.html

@@ -345,33 +345,13 @@

<a href="#types">Types</a>

<ol>

<li>

- <a href="#type-PanelWithSidebars">PanelWithSidebars</a>

- <ol>

- <li>

- <a href="#global-PanelWithSidebars-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-PanelWithSidebars-createSidebarPane">createSidebarPane</a>

- </li>

- </ol>

- </li>

- <li style="display: none; ">

- <a>Events</a>

- <ol>

- <li>

- <a href="#event-anchor">eventName</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

<a href="#type-ElementsPanel">ElementsPanel</a>

<ol>

- <li style="display: none; ">

- <a>Methods</a>

+ <li>

+ <a href="#global-ElementsPanel-methods">Methods</a>

<ol>

<li>

- <a href="#method-anchor">methodName</a>

+ <a href="#method-ElementsPanel-createSidebarPane">createSidebarPane</a>

</li>

</ol>

</li>

@@ -399,7 +379,11 @@

<a href="#global-ExtensionPanel-events">Events</a>

<ol>

<li>

+ <a href="#event-ExtensionPanel-onHidden">onHidden</a>

+ </li><li>

<a href="#event-ExtensionPanel-onSearch">onSearch</a>

+ </li><li>

+ <a href="#event-ExtensionPanel-onShown">onShown</a>

</li>

</ol>

</li>

@@ -421,11 +405,13 @@

</li>

</ol>

</li>

- <li style="display: none; ">

- <a>Events</a>

+ <li>

+ <a href="#global-ExtensionSidebarPane-events">Events</a>

<ol>

<li>

- <a href="#event-anchor">eventName</a>

+ <a href="#event-ExtensionSidebarPane-onHidden">onHidden</a>

+ </li><li>

+ <a href="#event-ExtensionSidebarPane-onShown">onShown</a>

</li>

</ol>

</li>

@@ -609,8 +595,8 @@ You can find examples that use this API in

<span>chrome.experimental.devtools.panels.create</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>

<var><span>title</span></var></span><span class="null"><span>, </span><span>string</span>

- <var><span>iconURL</span></var></span><span class="null"><span>, </span><span>string</span>

- <var><span>pageURL</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>iconPath</span></var></span><span class="null"><span>, </span><span>string</span>

+ <var><span>pagePath</span></var></span><span class="optional"><span>, </span><span>function</span>

<var><span>callback</span></var></span>)</div>

@@ -651,7 +637,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>Title that is displayed under the extension icon in the toolbar.</dd>

+ <dd>Title that is displayed next to the extension icon in the Developer Tools toolbar.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -691,7 +677,7 @@ You can find examples that use this API in

</div><div>

<div>

<dt>

- <var>iconURL</var>

+ <var>iconPath</var>

<em>

@@ -719,7 +705,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>A URL of the toolbar icon.</dd>

+ <dd>Path of the panel's icon relative to the extension directory.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -759,7 +745,7 @@ You can find examples that use this API in

</div><div>

<div>

<dt>

- <var>pageURL</var>

+ <var>pagePath</var>

<em>

@@ -787,7 +773,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>A URL of the page that represents this panel.</dd>

+ <dd>Path of the panel's HTML page relative to the extension directory.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -833,7 +819,7 @@ You can find examples that use this API in

(

- <span class="optional" style="display: none; ">optional</span>

+ <span class="optional">optional</span>

<span class="enum" style="display: none; ">enumerated</span>

@@ -855,7 +841,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>A function that is called upon request completion.</dd>

+ <dd>A function that is called when the panel is created.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -908,11 +894,11 @@ You can find examples that use this API in

<div>

<h4>Callback function</h4>

- <p>

+ <p style="display: none; ">

The callback <em>parameter</em> should specify a function

that looks like this:

</p>

- <p style="display: none; ">

+ <p>

If you specify the <em>callback</em> parameter, it should

specify a function that looks like this:

</p>

@@ -1263,8 +1249,8 @@ You can find examples that use this API in

- <a name="type-PanelWithSidebars"></a>

- <h4>PanelWithSidebars</h4>

+ <a name="type-ElementsPanel"></a>

+ <h4>ElementsPanel</h4>

<div>

<dt>

@@ -1284,7 +1270,7 @@ You can find examples that use this API in

array of <span><span></span></span>

</span>

- <span>Panel</span>

+ <span>object</span>

</span>

@@ -1296,7 +1282,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>A panel within Web Inspector UI that has sidebars.</dd>

+ <dd>Represents the Elements panel</dd>

mkearney 2011/11/15 20:09:12 Missing a full-stop here.

This parameter was added in version

<b><span></span></b>.

@@ -1320,18 +1306,18 @@ You can find examples that use this API in

<dd>

- <a name="global-PanelWithSidebars-methods"></a>

- <h3>Methods of PanelWithSidebars</h3>

+ <a name="global-ElementsPanel-methods"></a>

+ <h3>Methods of ElementsPanel</h3>

- <a name="method-PanelWithSidebars-createSidebarPane"></a>

+ <a name="method-ElementsPanel-createSidebarPane"></a>

<h4>createSidebarPane</h4>

- <span>panelWithSidebars.createSidebarPane</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>

- <var><span>title</span></var></span><span class="null"><span>, </span><span>function</span>

+ <span>elementsPanel.createSidebarPane</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>

+ <var><span>title</span></var></span><span class="optional"><span>, </span><span>function</span>

<var><span>callback</span></var></span>)</div>

@@ -1372,7 +1358,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>A text that is displayed in sidebar caption.</dd>

+ <dd>Text that is displayed in sidebar caption.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -1418,7 +1404,7 @@ You can find examples that use this API in

(

- <span class="optional" style="display: none; ">optional</span>

+ <span class="optional" style="">optional</span>

<span class="enum" style="display: none; ">enumerated</span>

@@ -1440,7 +1426,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>A callback invoked when sidebar is created.</dd>

+ <dd>A callback invoked when the sidebar is created.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -1493,11 +1479,11 @@ You can find examples that use this API in

<div>

<h4>Callback function</h4>

- <p>

+ <p style="display: none; ">

The callback <em>parameter</em> should specify a function

that looks like this:

</p>

- <p style="display: none; ">

+ <p>

If you specify the <em>callback</em> parameter, it should

specify a function that looks like this:

</p>

@@ -1593,8 +1579,59 @@ You can find examples that use this API in

</dd>

- <dd style="display: none; ">

- <div></div>

+ <dd>

+ <div class="apiGroup" style="">

+ <a name="global-ElementsPanel-events"></a>

+ <h3>Events of ElementsPanel</h3>

+

+ <div class="apiItem">

+ <a name="event-ElementsPanel-onSelectionChanged"></a>

+ <h4>onSelectionChanged</h4>

+ <div class="summary">

+

+ <span class="subdued">elementsPanel.</span><span>onSelectionChanged</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p class="todo" style="display: none; ">Undocumented.</p>

+ <p>Fired when an object is selected in the panel.</p>

+

+ <div style="display: none; ">

+ <h4>Listener parameters</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <div style="display: none; ">

+ <h4>Extra parameters to addListener</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <h4 style="display: none; ">Listener returns</h4>

+ <dl>

+ <div style="display: none; ">

+ <div>

+ </div>

+ </dl>

+ </div>

+ </div>

+ </div>

</dd>

@@ -1605,8 +1642,8 @@ You can find examples that use this API in

</div>

</div><div class="apiItem">

- <a name="type-ElementsPanel"></a>

- <h4>ElementsPanel</h4>

+ <a name="type-ExtensionPanel"></a>

+ <h4>ExtensionPanel</h4>

<div>

<dt>

@@ -1626,7 +1663,7 @@ You can find examples that use this API in

array of <span><span></span></span>

</span>

- <span>PanelWithSidebars</span>

+ <span>object</span>

</span>

@@ -1638,7 +1675,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>Represents Elements panel</dd>

+ <dd>Represents a panel created by extension.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -1667,21 +1704,21 @@ You can find examples that use this API in

<dd>

- <a name="global-ElementsPanel-events"></a>

- <h3>Events of ElementsPanel</h3>

+ <a name="global-ExtensionPanel-events"></a>

+ <h3>Events of ExtensionPanel</h3>

- <a name="event-ElementsPanel-onSelectionChanged"></a>

- <h4>onSelectionChanged</h4>

+ <a name="event-ExtensionPanel-onHidden"></a>

+ <h4>onHidden</h4>

- <span class="subdued">elementsPanel.</span><span>onSelectionChanged</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

+ <span class="subdued">extensionPanel.</span><span>onHidden</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

</div>

<p class="todo" style="display: none; ">Undocumented.</p>

- <p>Fired when an object is selected in the panel.</p>

+ <p>Fired when the user switches away from the panel.</p>

@@ -1715,25 +1752,27 @@ You can find examples that use this API in

</dl>

</div>

- </div>

- </div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

+ </div><div class="apiItem">

+ <a name="event-ExtensionPanel-onSearch"></a>

+ <h4>onSearch</h4>

- </div>

+ <div class="summary">

+

+ <span class="subdued">extensionPanel.</span><span>onSearch</span><span class="subdued">.addListener</span>(function(<span>string action, string queryString</span>) <span class="subdued">{...}</span><span></span>);

+ </div>

- </div><div class="apiItem">

- <a name="type-ExtensionPanel"></a>

- <h4>ExtensionPanel</h4>

+ <div class="description">

+ <p class="todo" style="display: none; ">Undocumented.</p>

+ <p>Fired upon a search action (start of a new search, search result navigation, or search being canceled).</p>

- <div>

+

+ <div>

+ <h4>Listener parameters</h4>

+ <dl>

+ <div>

<dt>

- <var style="display: none; ">paramName</var>

+ <var>action</var>

<em>

@@ -1749,7 +1788,7 @@ You can find examples that use this API in

array of <span><span></span></span>

</span>

- <span>Panel</span>

+ <span>string</span>

</span>

@@ -1761,7 +1800,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>Represents a panel created by extension.</dd>

+ <dd>Type of search action being performed.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -1788,38 +1827,26 @@ You can find examples that use this API in

</dd>

- <dd>

- <div class="apiGroup" style="">

- <a name="global-ExtensionPanel-events"></a>

- <h3>Events of ExtensionPanel</h3>

-

- <div class="apiItem">

- <a name="event-ExtensionPanel-onSearch"></a>

- <h4>onSearch</h4>

- <div class="summary">

-

- <span class="subdued">extensionPanel.</span><span>onSearch</span><span class="subdued">.addListener</span>(function(<span>string action, string queryString</span>) <span class="subdued">{...}</span><span></span>);

- </div>

+ <dd style="display: none; ">

+ <div></div>

+ </dd>

- <div class="description">

- <p class="todo" style="display: none; ">Undocumented.</p>

- <p>Fired upon a search action (start of a new search, search result navigation or search being canceled).</p>

+

+ <dd style="display: none; ">

+ <div></div>

+ </dd>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

+ </div>

+ </div><div>

<div>

<dt>

- <var>action</var>

+ <var>queryString</var>

<em>

(

- <span class="optional" style="display: none; ">optional</span>

+ <span class="optional">optional</span>

<span class="enum" style="display: none; ">enumerated</span>

@@ -1841,7 +1868,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>Type of search action being performed.</dd>

+ <dd>Query string (only for 'performSearch').</dd>

This parameter was added in version

<b><span></span></b>.

@@ -1878,16 +1905,58 @@ You can find examples that use this API in

</dd>

</div>

- </div><div>

+ </div>

+ </dl>

+ </div>

+

+ <div style="display: none; ">

+ <h4>Extra parameters to addListener</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <h4 style="display: none; ">Listener returns</h4>

+ <dl>

+ <div style="display: none; ">

+ <div>

+ </div>

+ </dl>

+ </div>

+ </div><div class="apiItem">

+ <a name="event-ExtensionPanel-onShown"></a>

+ <h4>onShown</h4>

+ <div class="summary">

+

+ <span class="subdued">extensionPanel.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p class="todo" style="display: none; ">Undocumented.</p>

+ <p>Fired when the user switches to the panel.</p>

+

+ <div>

+ <h4>Listener parameters</h4>

+ <dl>

+ <div>

<div>

<dt>

- <var>queryString</var>

+ <var>window</var>

<em>

(

- <span class="optional">optional</span>

+ <span class="optional" style="display: none; ">optional</span>

<span class="enum" style="display: none; ">enumerated</span>

@@ -1897,7 +1966,7 @@ You can find examples that use this API in

array of <span><span></span></span>

</span>

- <span>string</span>

+ <span>DOMWindow</span>

</span>

@@ -1909,7 +1978,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>Query string (only for 'performSearch').</dd>

+ <dd>The <code>window</code> object of panel's page.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -2214,11 +2283,11 @@ You can find examples that use this API in

<div>

<h4>Callback function</h4>

- <p>

+ <p style="display: none; ">

The callback <em>parameter</em> should specify a function

that looks like this:

</p>

- <p style="display: none; ">

+ <p>

If you specify the <em>callback</em> parameter, it should

specify a function that looks like this:

</p>

@@ -2772,7 +2841,7 @@ You can find examples that use this API in

<span>extensionSidebarPane.setPage</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>

- <var><span>url</span></var></span>)</div>

+ <var><span>path</span></var></span>)</div>

<p class="todo" style="display: none; ">Undocumented.</p>

@@ -2784,7 +2853,7 @@ You can find examples that use this API in

<div>

<dt>

- <var>url</var>

+ <var>path</var>

<em>

@@ -2812,7 +2881,7 @@ You can find examples that use this API in

Undocumented.

</dd>

- <dd>A URL of an extension page to display within the sidebar.</dd>

+ <dd>Relative path of an extension page to display within the sidebar.</dd>

This parameter was added in version

<b><span></span></b>.

@@ -2965,10 +3034,171 @@ You can find examples that use this API in

</dd>

+ <dd>

+ <div class="apiGroup" style="">

+ <a name="global-ExtensionSidebarPane-events"></a>

+ <h3>Events of ExtensionSidebarPane</h3>

+

+ <div class="apiItem">

+ <a name="event-ExtensionSidebarPane-onHidden"></a>

+ <h4>onHidden</h4>

+ <div class="summary">

+

+ <span class="subdued">extensionSidebarPane.</span><span>onHidden</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p class="todo" style="display: none; ">Undocumented.</p>

+ <p>Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar pane.</p>

+

+ <div style="display: none; ">

+ <h4>Listener parameters</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <div style="display: none; ">

+ <h4>Extra parameters to addListener</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <h4 style="display: none; ">Listener returns</h4>

+ <dl>

+ <div style="display: none; ">

+ <div>

+ </div>

+ </dl>

+ </div>

+ </div><div class="apiItem">

+ <a name="event-ExtensionSidebarPane-onShown"></a>

+ <h4>onShown</h4>

+ <div class="summary">

+

+ <span class="subdued">extensionSidebarPane.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p class="todo" style="display: none; ">Undocumented.</p>

+ <p>Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.</p>

+

+ <div>

+ <h4>Listener parameters</h4>

+ <dl>

+ <div>

+ <dt>

+ <var>window</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional">optional</span>

+ <span class="enum" style="display: none; ">enumerated</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>DOMWindow</span>

+ <span style="display: none; "></span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="display: none; ">

+ Undocumented.

+ </dd>

+ <dd>The <code>window</code> object of the sidebar page, if one was set with the <code>setPage()</code> method.</dd>

+ <dd style="display: none; ">

+ This parameter was added in version

+ <b><span></span></b>.

+ You must omit this parameter in earlier versions,

+ and you may omit it in any version. If you require this

+ parameter, the manifest key

+ <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

+ can ensure that your extension won't be run in an earlier browser version.

+ </dd>

+

+ <dd style="display: none; ">

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </dd>

+

+ <dd style="display: none; ">

+ <div></div>

+ </dd>

+

+ <dd style="display: none; ">

+ <div></div>

+ </dd>

+

</dd>

+ </div>

+ </dl>

+ </div>

+

+ <div style="display: none; ">

+ <h4>Extra parameters to addListener</h4>

+ <dl>

+ <div>

+ </div>

+ </dl>

+ </div>

+

+ <h4 style="display: none; ">Listener returns</h4>

+ <dl>

+ <div style="display: none; ">

+ <div>

+ </div>

+ </dl>

+ </div>

+ </div>

+ </div>

+ </dd>

« no previous file with comments | « chrome/common/extensions/docs/experimental.devtools.network.html ('k') | no next file » | no next file with comments »