chrome/common/extensions/docs/contextMenus.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/contextMenus.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: fix Created 8 years, 6 months ago

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

Jump to:

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

« chrome/common/extensions/docs/build/build.py ('K') | « chrome/common/extensions/docs/content_scripts.html ('k') | chrome/common/extensions/docs/cookies.html » ('j') | chrome/common/extensions/docs/js/api_page_generator.js » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/contextMenus.html

diff --git a/chrome/common/extensions/docs/contextMenus.html b/chrome/common/extensions/docs/contextMenus.html

deleted file mode 100644

index efa5eef616c5088e9b9dd473ce97a27e29e57fc9..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/contextMenus.html

+++ /dev/null

@@ -1,1653 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <meta name="description" content="Documentation for the chrome.contextMenus module, which is part of the Google Chrome extension APIs."><title>Context Menus - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- 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" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <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>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </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>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li class="leftNavSelected">Context Menus</li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

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

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">Context Menus</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#manifest">Manifest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#examples">Examples</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.contextMenus</a>

- <ol>

- <li>

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

- <ol>

- <li>

- <a href="#method-create">create</a>

- </li><li>

- <a href="#method-remove">remove</a>

- </li><li>

- <a href="#method-removeAll">removeAll</a>

- </li><li>

- <a href="#method-update">update</a>

- </li>

- </ol>

- </li>

- <li>

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

- <ol>

- <li>

- <a href="#event-onClicked">onClicked</a>

- </li>

- </ol>

- </li>

- <li>

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

- <ol>

- <li>

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

- <ol>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Context Menus</div>

-

-<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

-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),

-even those with file:// or chrome:// URLs.

-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,

-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.

-Also, you should specify a 16x16-pixel icon

-for display next to your menu item.

-For example:

-</p>

-<pre>{

- "name": "My extension",

- ...

- "permissions": [

- <b>"contextMenus"</b>

- ],

- "icons": {

- <b>"16": "icon-bitty.png",</b>

- "48": "icon-small.png",

- "128": "icon-large.png"

- },

- ...

-}</pre>

-<h2 id="examples">Examples</h2>

-<p>

-You can find samples of this API on the

-<a href="samples.html#contextMenus">sample page</a>.

-

-</p></div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.contextMenus</h2>

-

-

-

- <div id="methodsTemplate" class="apiGroup">

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

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-create"></a>

- <h4>create</h4>

- <div class="summary"><span>integer or string</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>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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>createProperties</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>type</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["normal", "checkbox", "radio", "separator"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The type of menu item. Defaults to 'normal' if not specified.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>id</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>title</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <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>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>checked</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <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>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>contexts</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- <span>["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"]</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>List of contexts this menu item will appear in. Defaults to ['page'] if not specified.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>onclick</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A function that will be called back when the menu item is clicked. Event pages cannot use this; instead, they should register a listener for chrome.contextMenus.onClicked.</dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>info</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="contextMenus.html#type-OnClickData">OnClickData</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Information about the item clicked and the context where the click happened.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>tab</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a>tabs.Tab</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The details of the tab where the click took place.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>parentId</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>integer or string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of a parent menu item; this makes the item a child of a previously added item.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>documentUrlPatterns</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <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>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>targetUrlPatterns</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <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>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>enabled</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Whether this context menu item is enabled or disabled. Defaults to true.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <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>

-

-

-

-

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer or string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the newly created item.</dd>

-

-

-

-

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

- </dl>

- </div>

-

- </div>

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

- <a name="method-remove"></a>

- <h4>remove</h4>

- <div class="summary">

-

- <span>chrome.contextMenus.remove</span>(<span class="null"><span>integer or string</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>Removes a context menu item.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>menuItemId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer or string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the context menu item to remove.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Called when the context menu has been removed.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

- </dl>

- </div>

-

- </div>

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

- <a name="method-removeAll"></a>

- <h4>removeAll</h4>

- <div class="summary">

-

- <span>chrome.contextMenus.removeAll</span>(<span class="optional"><span>function</span>

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

- <div class="description">

- <p>Removes all context menu items added by this extension.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Called when removal is complete.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

- </dl>

- </div>

-

- </div>

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

- <a name="method-update"></a>

- <h4>update</h4>

- <div class="summary">

-

- <span>chrome.contextMenus.update</span>(<span class="null"><span>integer or string</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>Updates a previously created context menu item.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>id</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer or string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the item to update.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>updateProperties</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The properties to update. Accepts the same values as the create function.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>type</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["normal", "checkbox", "radio", "separator"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>title</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>checked</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>contexts</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- <span>["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"]</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>onclick</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>parentId</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>integer or string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Note: You cannot change an item to be a child of one of its own descendants.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>documentUrlPatterns</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>targetUrlPatterns</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>string</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>enabled</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Called when the context menu has been updated.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

-

- <div id="eventsTemplate" class="apiGroup">

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

- <h3>Events</h3>

-

- <div class="apiItem">

- <a name="event-onClicked"></a>

- <h4>onClicked</h4>

- <div class="summary">

-

- <span class="subdued">chrome.contextMenus.</span><span>onClicked</span><span class="subdued">.addListener</span>(function(<span>OnClickData info, tabs.Tab tab</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when a context menu item is clicked.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>info</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="contextMenus.html#type-OnClickData">OnClickData</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Information about the item clicked and the context where the click happened.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>tab</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a>tabs.Tab</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The details of the tab where the click took place.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

-

- <div class="apiGroup">

- <a name="types"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

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

- <h4>OnClickData</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Information sent when a context menu item is clicked.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>menuItemId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer or string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the menu item that was clicked.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>parentMenuItemId</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>integer or string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The parent ID, if any, for the item clicked.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>mediaType</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>linkUrl</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>If the element is a link, the URL it points to.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>srcUrl</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Will be present for elements with a 'src' URL.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>pageUrl</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The URL of the page where the menu item was clicked.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>frameUrl</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd> The URL of the frame of the element where the context menu was clicked, if it was in a frame.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>selectionText</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The text for the context selection, if any.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>editable</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A flag indicating whether the element is editable (text input, textarea, etc.).</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>wasChecked</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A flag indicating the state of a checkbox or radio item before it was clicked.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>checked</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A flag indicating the state of a checkbox or radio item after it is clicked.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<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";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>