diff options
| author | kalman@chromium.org <kalman@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-02-02 05:41:48 +0000 |
|---|---|---|
| committer | kalman@chromium.org <kalman@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-02-02 05:41:48 +0000 |
| commit | e34acbbaecc29d97d9242930cc30492069d3c513 (patch) | |
| tree | 6d8d307216966b03e95fefef7b3c668a018566a1 /chrome/common/extensions/docs/contextMenus.html | |
| parent | b66bfd6cbcb3e14d0bcb4609d869485dbc9d5271 (diff) | |
| download | chromium_src-e34acbbaecc29d97d9242930cc30492069d3c513.zip chromium_src-e34acbbaecc29d97d9242930cc30492069d3c513.tar.gz chromium_src-e34acbbaecc29d97d9242930cc30492069d3c513.tar.bz2 | |
Delete display:none nodes while generating the extension API documentation.
This significantly cuts down on the size of the generated documentation: git
says "92 files changed, 3716 insertions, 84733 deletions".
BUG=
TEST=eyeballs
Review URL: https://chromiumcodereview.appspot.com/9295046
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@120164 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/contextMenus.html')
| -rw-r--r-- | chrome/common/extensions/docs/contextMenus.html | 2029 |
1 files changed, 10 insertions, 2019 deletions
diff --git a/chrome/common/extensions/docs/contextMenus.html b/chrome/common/extensions/docs/contextMenus.html index d0f6ef4..99fe2e2 100644 --- a/chrome/common/extensions/docs/contextMenus.html +++ b/chrome/common/extensions/docs/contextMenus.html @@ -41,130 +41,7 @@ <!-- In particular, sub-templates that recurse, must be used by allowing jstemplate to make a copy of the template in this section which are not operated on by way of the jsskip="true" --> - <div style="display:none"> - - <!-- VALUE --> - <div id="valueTemplate"> - <dt> - <var>paramName</var> - <em> - - <!-- TYPE --> - <div style="display:inline"> - ( - <span class="optional">optional</span> - <span class="enum">enumerated</span> - <span id="typeTemplate"> - <span> - <a> Type</a> - </span> - <span> - <span> - array of <span><span></span></span> - </span> - <span>paramType</span> - <span></span> - </span> - </span> - ) - </div> - - </em> - </dt> - <dd class="todo"> - Undocumented. - </dd> - <dd> - Description of this parameter from the json schema. - </dd> - <dd> - 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> - - <!-- OBJECT PROPERTIES --> - <dd> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - - <!-- OBJECT METHODS --> - <dd> - <div></div> - </dd> - - <!-- OBJECT EVENT FIELDS --> - <dd> - <div></div> - </dd> - - <!-- FUNCTION PARAMETERS --> - <dd> - <div></div> - </dd> - - </div> <!-- /VALUE --> - - <div id="functionParametersTemplate"> - <h5>Parameters</h5> - <dl> - <div> - <div> - </div> - </div> - </dl> - </div> - - <!-- Individual subsections from the table of contents --> - <ol> - <li id="propertiesTocTemplate"> - <a href="#properties">Properties</a> - <ol> - <li> - <a href="#property-anchor">propertyName</a> - </li> - </ol> - </li> - <li id="methodsTocTemplate"> - <a>Methods</a> - <ol> - <li> - <a href="#method-anchor">methodName</a> - </li> - </ol> - </li> - <li id="eventsTocTemplate"> - <a>Events</a> - <ol> - <li> - <a href="#event-anchor">eventName</a> - </li> - </ol> - </li> - <li id="typesTocTemplate"> - <a href="#types">Types</a> - <ol> - <li> - <a href="#id-anchor">id</a> - <ol> - <div></div> - <div></div> - </ol> - </li> - </ol> - </li> - </ol> - </div> <!-- /SUBTEMPLATES --> - + <!-- /SUBTEMPLATES --> <a id="top"></a> <div id="skipto"> <a href="#gc-pagecontent">Skip to page content</a> @@ -185,7 +62,6 @@ <span class="greytext">e.g. "page action" or "tabs"</span> </div> </form> - <script type="text/javascript" src="https://www.google.com/jsapi"></script> <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> @@ -193,9 +69,7 @@ </td> </tr> </tbody></table> - <div id="codesiteContent" class=""> - <a id="gc-topnav-anchor"></a> <div id="gc-topnav"> <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> @@ -220,7 +94,6 @@ </li> </ul> </div> <!-- end gc-topnav --> - <div class="g-section g-tpl-170"> <!-- SIDENAV --> <div class="g-unit g-first" id="gc-toc"> @@ -308,7 +181,6 @@ <script> initToggles(); </script> - <div class="g-unit" id="gc-pagecontent"> <div id="pageTitle"> <h1 class="page_title">Context Menus</h1> @@ -320,29 +192,15 @@ <li> <a href="#manifest">Manifest</a> <ol> - <li style="display: none; "> - <a>h3Name</a> - </li> </ol> </li><li> <a href="#examples">Examples</a> <ol> - <li style="display: none; "> - <a>h3Name</a> - </li> </ol> </li> <li> <a href="#apiReference">API reference: chrome.contextMenus</a> <ol> - <li style="display: none; "> - <a href="#properties">Properties</a> - <ol> - <li> - <a href="#property-anchor">propertyName</a> - </li> - </ol> - </li> <li> <a href="#global-methods">Methods</a> <ol> @@ -357,36 +215,12 @@ </li> </ol> </li> - <li style="display: none; "> - <a>Events</a> - <ol> - <li> - <a href="#event-anchor">eventName</a> - </li> - </ol> - </li> <li> <a href="#types">Types</a> <ol> <li> <a href="#type-OnClickData">OnClickData</a> <ol> - <li style="display: none; "> - <a>Methods</a> - <ol> - <li> - <a href="#method-anchor">methodName</a> - </li> - </ol> - </li> - <li style="display: none; "> - <a>Events</a> - <ol> - <li> - <a href="#event-anchor">eventName</a> - </li> - </ol> - </li> </ol> </li> </ol> @@ -396,27 +230,19 @@ </ol> </div> <!-- /TABLE OF CONTENTS --> - <!-- Standard content lead-in for experimental API pages --> - <p id="classSummary" style="display: none; "> - For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. - </p> - <!-- STATIC CONTENT PLACEHOLDER --> <div id="static"><div id="pageData-name" class="pageData">Context Menus</div> - <!-- BEGIN AUTHORED CONTENT --> <p> The context menus module allows you to add items to Google Chrome's context menu. </p> - <p> You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages. </p> - <p> You can create as many context menu items as you need, but if more than one @@ -424,7 +250,6 @@ from your extension is visible at once, Google Chrome automatically collapses them into a single parent menu. </p> - <p> Context menu items can appear in any document (or frame within a document), @@ -433,14 +258,12 @@ To control which documents your items can appear in, specify the documentUrlPatterns field when you call the create() or update() method. </p> - <p class="note"> <strong>Version note:</strong> Before Chrome 14, <!-- PENDING(asargent): fix version # --> your items could appear only in documents with http:// or https:// URLs. </p> - <h2 id="manifest">Manifest</h2> <p>You must declare the "contextMenus" permission in your extension's manifest to use the API. @@ -448,7 +271,6 @@ Also, you should specify a 16x16-pixel icon for display next to your menu item. For example: </p> - <pre>{ "name": "My extension", ... @@ -462,59 +284,33 @@ For example: }, ... }</pre> - <h2 id="examples">Examples</h2> - <p> You can find samples of this API on the <a href="samples.html#contextMenus">sample page</a>. - <!-- END AUTHORED CONTENT --> </p></div> - <!-- API PAGE --> <div class="apiPage"> <a name="apiReference"></a> <h2>API reference: chrome.contextMenus</h2> - <!-- PROPERTIES --> - <div class="apiGroup" style="display: none; "> - <a name="properties"></a> - <h3 id="properties">Properties</h3> - - <div> - <a></a> - <h4>getLastError</h4> - <div class="summary"> - <!-- Note: intentionally longer 80 columns --> - <span>chrome.extension</span><span>lastError</span> - </div> - <div> - </div> - </div> - - </div> <!-- /apiGroup --> - + <!-- /apiGroup --> <!-- METHODS --> <div id="methodsTemplate" class="apiGroup"> <a name="global-methods"></a> <h3>Methods</h3> - <!-- iterates over all functions --> <div class="apiItem"> <a name="method-create"></a> <!-- method-anchor --> <h4>create</h4> - <div class="summary"><span>integer</span> <!-- Note: intentionally longer 80 columns --> - <span>chrome.contextMenus.create</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> + <span>chrome.contextMenus.create</span>(<span class="null"><span>object</span> <var><span>createProperties</span></var></span><span class="optional"><span>, </span><span>function</span> <var><span>callback</span></var></span>)</div> - <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> <p>Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in chrome.extension.lastError).</p> - <!-- PARAMETERS --> <h4>Parameters</h4> <dl> @@ -523,45 +319,21 @@ You can find samples of this API on the <dt> <var>createProperties</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>object</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> <dd> <dl> @@ -570,346 +342,128 @@ You can find samples of this API on the <dt> <var>type</var> <em> - <!-- TYPE --> <div style="display:inline"> ( <span class="optional">optional</span> <span class="enum">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>string</span> <span>["normal", "checkbox", "radio", "separator"]</span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The type of menu item. Defaults to 'normal' if not specified.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>title</var> <em> - <!-- TYPE --> <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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The text to be displayed in the item; this is <em>required</em> unless <em>type</em> is 'separator'. When the context is 'selection', you can use <code>%s</code> within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin".</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>checked</var> <em> - <!-- TYPE --> <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>boolean</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>contexts</var> <em> - <!-- TYPE --> <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> array of <span><span> - <span style="display: none; "> - <a> Type</a> - </span> <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> <span>string</span> <span>["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"]</span> </span> </span></span> </span> - <span style="display: none; ">paramType</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>List of contexts this menu item will appear in. Defaults to ['page'] if not specified.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>onclick</var> <em> - <!-- TYPE --> <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>function</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>A function that will be called back when the menu item is clicked.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> <dd> <div> @@ -920,581 +474,222 @@ You can find samples of this API on the <dt> <var>info</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> <span id="typeTemplate"> <span> <a href="contextMenus.html#type-OnClickData">OnClickData</a> </span> - <span style="display: none; "> - <span> - array of <span><span></span></span> - </span> - <span>paramType</span> - <span></span> - </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Information about the item clicked and the context where the click happened.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>tab</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> <span id="typeTemplate"> <span> <a href="tabs.html#type-Tab">Tab</a> </span> - <span style="display: none; "> - <span> - array of <span><span></span></span> - </span> - <span>paramType</span> - <span></span> - </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The details of the tab where the click took place.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> </div> </dd> - </div> </div><div> <div> <dt> <var>parentId</var> <em> - <!-- TYPE --> <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>integer</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The ID of a parent menu item; this makes the item a child of a previously added item.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>documentUrlPatterns</var> <em> - <!-- TYPE --> <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> array of <span><span> - <span style="display: none; "> - <a> Type</a> - </span> <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> <span>string</span> - <span style="display: none; "></span> </span> </span></span> </span> - <span style="display: none; ">paramType</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see <a href="match_patterns.html">Match Patterns</a>.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>targetUrlPatterns</var> <em> - <!-- TYPE --> <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> array of <span><span> - <span style="display: none; "> - <a> Type</a> - </span> <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> <span>string</span> - <span style="display: none; "></span> </span> </span></span> </span> - <span style="display: none; ">paramType</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>callback</var> <em> - <!-- TYPE --> <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>function</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.extension.lastError.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </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 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>integer</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The ID of the newly created item.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> - <!-- CALLBACK --> <div> <div> <h4>Callback function</h4> - <p style="display: none; "> - The callback <em>parameter</em> should specify a function - that looks like this: - </p> <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 style="display: none; "> - <div> - </div> - </div> </dl> </div> </div> - <!-- MIN_VERSION --> - <p style="display: none; "> - This function was added in version <b><span></span></b>. - If you require this function, 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. - </p> </div> <!-- /description --> - </div><div class="apiItem"> <a name="method-remove"></a> <!-- method-anchor --> <h4>remove</h4> - - <div class="summary"><span style="display: none; ">void</span> + <div class="summary"> <!-- Note: intentionally longer 80 columns --> - <span>chrome.contextMenus.remove</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> + <span>chrome.contextMenus.remove</span>(<span class="null"><span>integer</span> <var><span>menuItemId</span></var></span><span class="optional"><span>, </span><span>function</span> <var><span>callback</span></var></span>)</div> - <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> <p>Removes a context menu item.</p> - <!-- PARAMETERS --> <h4>Parameters</h4> <dl> @@ -1503,195 +698,78 @@ You can find samples of this API on the <dt> <var>menuItemId</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>integer</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The ID of the context menu item to remove.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>callback</var> <em> - <!-- TYPE --> <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>function</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Called when the context menu has been removed.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> - <!-- RETURNS --> - <h4 style="display: none; ">Returns</h4> <dl> - <div style="display: none; "> - <div> - </div> - </div> </dl> - <!-- CALLBACK --> <div> <div> <h4>Callback function</h4> - <p style="display: none; "> - The callback <em>parameter</em> should specify a function - that looks like this: - </p> <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 style="display: none; "> - <div> - </div> - </div> </dl> </div> </div> - <!-- MIN_VERSION --> - <p style="display: none; "> - This function was added in version <b><span></span></b>. - If you require this function, 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. - </p> </div> <!-- /description --> - </div><div class="apiItem"> <a name="method-removeAll"></a> <!-- method-anchor --> <h4>removeAll</h4> - - <div class="summary"><span style="display: none; ">void</span> + <div class="summary"> <!-- Note: intentionally longer 80 columns --> - <span>chrome.contextMenus.removeAll</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span> + <span>chrome.contextMenus.removeAll</span>(<span class="optional"><span>function</span> <var><span>callback</span></var></span>)</div> - <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> <p>Removes all context menu items added by this extension.</p> - <!-- PARAMETERS --> <h4>Parameters</h4> <dl> @@ -1700,129 +778,57 @@ You can find samples of this API on the <dt> <var>callback</var> <em> - <!-- TYPE --> <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>function</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Called when removal is complete.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> - <!-- RETURNS --> - <h4 style="display: none; ">Returns</h4> <dl> - <div style="display: none; "> - <div> - </div> - </div> </dl> - <!-- CALLBACK --> <div> <div> <h4>Callback function</h4> - <p style="display: none; "> - The callback <em>parameter</em> should specify a function - that looks like this: - </p> <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 style="display: none; "> - <div> - </div> - </div> </dl> </div> </div> - <!-- MIN_VERSION --> - <p style="display: none; "> - This function was added in version <b><span></span></b>. - If you require this function, 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. - </p> </div> <!-- /description --> - </div><div class="apiItem"> <a name="method-update"></a> <!-- method-anchor --> <h4>update</h4> - - <div class="summary"><span style="display: none; ">void</span> + <div class="summary"> <!-- Note: intentionally longer 80 columns --> - <span>chrome.contextMenus.update</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> + <span>chrome.contextMenus.update</span>(<span class="null"><span>integer</span> <var><span>id</span></var></span><span class="null"><span>, </span><span>object</span> <var><span>updateProperties</span></var></span><span class="optional"><span>, </span><span>function</span> <var><span>callback</span></var></span>)</div> - <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> <p>Updates a previously created context menu item.</p> - <!-- PARAMETERS --> <h4>Parameters</h4> <dl> @@ -1831,111 +837,42 @@ You can find samples of this API on the <dt> <var>id</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>integer</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The ID of the item to update.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>updateProperties</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>object</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The properties to update. Accepts the same values as the create function.</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> - <!-- OBJECT PROPERTIES --> <dd> <dl> @@ -1944,836 +881,308 @@ You can find samples of this API on the <dt> <var>type</var> <em> - <!-- TYPE --> <div style="display:inline"> ( <span class="optional">optional</span> <span class="enum">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>string</span> <span>["normal", "checkbox", "radio", "separator"]</span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>title</var> <em> - <!-- TYPE --> <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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>checked</var> <em> - <!-- TYPE --> <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>boolean</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>contexts</var> <em> - <!-- TYPE --> <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> array of <span><span> - <span style="display: none; "> - <a> Type</a> - </span> <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> <span>string</span> <span>["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"]</span> </span> </span></span> </span> - <span style="display: none; ">paramType</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>onclick</var> <em> - <!-- TYPE --> <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>function</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>parentId</var> <em> - <!-- TYPE --> <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>integer</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Note: You cannot change an item to be a child of one of its own descendants.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>documentUrlPatterns</var> <em> - <!-- TYPE --> <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> array of <span><span> - <span style="display: none; "> - <a> Type</a> - </span> <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> <span>string</span> - <span style="display: none; "></span> </span> </span></span> </span> - <span style="display: none; ">paramType</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>targetUrlPatterns</var> <em> - <!-- TYPE --> <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> array of <span><span> - <span style="display: none; "> - <a> Type</a> - </span> <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> <span>string</span> - <span style="display: none; "></span> </span> </span></span> </span> - <span style="display: none; ">paramType</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> <dd class="todo"> Undocumented. </dd> - <dd style="display: none; "> - Description of this parameter from the json schema. - </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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>callback</var> <em> - <!-- TYPE --> <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>function</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Called when the context menu has been updated.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> - <!-- RETURNS --> - <h4 style="display: none; ">Returns</h4> <dl> - <div style="display: none; "> - <div> - </div> - </div> </dl> - <!-- CALLBACK --> <div> <div> <h4>Callback function</h4> - <p style="display: none; "> - The callback <em>parameter</em> should specify a function - that looks like this: - </p> <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 style="display: none; "> - <div> - </div> - </div> </dl> </div> </div> - <!-- MIN_VERSION --> - <p style="display: none; "> - This function was added in version <b><span></span></b>. - If you require this function, 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. - </p> </div> <!-- /description --> - </div> <!-- /apiItem --> - </div> <!-- /apiGroup --> - <!-- EVENTS --> - <div id="eventsTemplate" class="apiGroup" style="display: none; "> - <a></a> - <h3>Events</h3> - <!-- iterates over all events --> - <div class="apiItem"> - <a></a> - <h4>event name</h4> - - <div class="summary"> - <!-- Note: intentionally longer 80 columns --> - <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_param2</span>); - </div> - - <div class="description"> - <p class="todo">Undocumented.</p> - <p> - A description from the json schema def of the event goes here. - </p> - - <!-- LISTENER PARAMETERS --> - <div> - <h4>Listener parameters</h4> - <dl> - <div> - <div> - </div> - </div> - </dl> - </div> - - <!-- EXTRA PARAMETERS --> - <div> - <h4>Extra parameters to addListener</h4> - <dl> - <div> - <div> - </div> - </div> - </dl> - </div> - - <!-- LISTENER RETURN VALUE --> - <h4>Listener returns</h4> - <dl> - <div> - <div> - </div> - </div> - </dl> - - </div> <!-- /description --> - </div> <!-- /apiItem --> - - </div> <!-- /apiGroup --> - + <!-- /apiGroup --> <!-- TYPES --> <div class="apiGroup"> <a name="types"></a> <h3 id="types">Types</h3> - <!-- iterates over all types --> <div class="apiItem"> <a name="type-OnClickData"></a> <h4>OnClickData</h4> - <div> <dt> - <var style="display: none; ">paramName</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>object</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Information sent when a context menu item is clicked.</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> - <!-- OBJECT PROPERTIES --> <dd> <dl> @@ -2782,638 +1191,223 @@ You can find samples of this API on the <dt> <var>menuItemId</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>integer</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The ID of the menu item that was clicked.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>parentMenuItemId</var> <em> - <!-- TYPE --> <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>integer</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The parent ID, if any, for the item clicked.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>mediaType</var> <em> - <!-- TYPE --> <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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>linkUrl</var> <em> - <!-- TYPE --> <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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>If the element is a link, the URL it points to.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>srcUrl</var> <em> - <!-- TYPE --> <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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>Will be present for elements with a 'src' URL.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>pageUrl</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The URL of the page where the menu item was clicked.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>frameUrl</var> <em> - <!-- TYPE --> <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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd> The URL of the frame of the element where the context menu was clicked, if it was in a frame.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>selectionText</var> <em> - <!-- TYPE --> <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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>The text for the context selection, if any.</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div><div> <div> <dt> <var>editable</var> <em> - <!-- TYPE --> <div style="display:inline"> ( - <span class="optional" style="display: none; ">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>string</span> - <span style="display: none; "></span> </span> </span> ) </div> - </em> </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> <dd>A flag indicating whether the element is editable (text input, textarea, etc.).</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> - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> </div> </dl> </dd> - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - </div> - </div> <!-- /apiItem --> - </div> <!-- /apiGroup --> - </div> <!-- /apiPage --> </div> <!-- /gc-pagecontent --> </div> <!-- /g-section --> @@ -3429,18 +1423,15 @@ You can find samples of this API on the <p> ©2011 Google </p> - <!-- begin analytics --> <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script> <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script> - <script type="text/javascript"> // chrome doc tracking try { var engdocs = _gat._getTracker("YT-10763712-2"); engdocs._trackPageview(); } catch(err) {} - // code.google.com site-wide tracking try { _uacct="UA-18071-1"; |