Index: chrome/common/extensions/docs/extensions/experimental.keybinding.html |
diff --git a/chrome/common/extensions/docs/extensions/experimental.keybinding.html b/chrome/common/extensions/docs/extensions/experimental.keybinding.html |
index 3bae14864c98cf4c1893cff240a7cc96d2628c4f..e3b99e3b5ebdef50f71c25e07f9375dc2f8596da 100644 |
--- a/chrome/common/extensions/docs/extensions/experimental.keybinding.html |
+++ b/chrome/common/extensions/docs/extensions/experimental.keybinding.html |
@@ -17,7 +17,7 @@ |
<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.experimental.keybinding module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.keybinding - Google Chrome Extensions - Google Code</title></head> |
+ <title>Experimental.keybinding - Google Chrome Extensions - Google Code</title></head> |
<body doc-family="extensions"> <link href="../css/ApiRefStyles.css" rel="stylesheet" type="text/css"> |
<link href="../css/shared.css" rel="stylesheet" type="text/css"> |
<div id="devModeWarning" class="displayModeWarning"> |
@@ -186,178 +186,15 @@ |
</script> |
<div class="g-unit" id="gc-pagecontent"> |
<div id="pageTitle"> |
- <h1 class="page_title">chrome.experimental.keybinding</h1> |
+ <h1 class="page_title">Experimental.keybinding</h1> |
</div> |
<!-- TABLE OF CONTENTS --> |
- <div id="toc"> |
- <h2>Contents</h2> |
- <ol> |
- <li> |
- <a href="#manifest">Manifest</a> |
- <ol> |
- </ol> |
- </li><li> |
- <a href="#usage">Usage</a> |
- <ol> |
- </ol> |
- </li> |
- <li> |
- <a href="#apiReference">API reference: chrome.experimental.keybinding</a> |
- <ol> |
- <li> |
- <a href="#global-events">Events</a> |
- <ol> |
- <li> |
- <a href="#event-onCommand">onCommand</a> |
- </li> |
- </ol> |
- </li> |
- </ol> |
- </li> |
- </ol> |
- </div> |
<!-- /TABLE OF CONTENTS --> |
<!-- Standard content lead-in for experimental API pages --> |
- <p id="classSummary"> |
- 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"><!-- BEGIN AUTHORED CONTENT --> |
-<p> |
-The keybinding API allows you to add keyboard shortcuts that trigger actions in |
-your extension. An action can be opening the browser action or page action popup |
-or sending a command to the extension. |
-</p> |
-<h2 id="manifest">Manifest</h2> |
-<p> |
-In addition to the "experimental" permission you must declare the "keybinding" |
-permission in your extension's manifest to use this API and set manifest_version |
-to (at least) 2. |
-</p> |
-<pre>{ |
- "name": "My extension", |
- ... |
-<b> "permissions": [ |
- "experimental", |
- "keybinding", |
- ]</b>, |
- ... |
-}</pre> |
-<h2 id="usage">Usage</h2> |
-<p>The keybinding API allows you to define specific commands, and bind them to a |
-default key combination. Each command your extension accepts must be listed in |
-the manifest as an attribute of the 'commands' manifest key. Note: Combinations |
-that involve Ctrl+Alt are not permitted in order to avoid conflicts with the |
-AltGr key.</p> |
-<pre>{ |
- "name": "My extension", |
- ... |
-<b> "commands": { |
- "toggle-feature-foo": { |
- "suggested_key": { |
- "default": "Ctrl+Shift+Y", |
- "mac": "Command+Shift+Y" |
- }, |
- "description": "Toggle feature foo" |
- }, |
- "_execute_browser_action": { |
- "suggested_key": { |
- "windows": "Ctrl+Shift+Y", |
- "mac": "Command+Shift+Y", |
- "chromeos": "Ctrl+Shift+U", |
- "linux": "Ctrl+Shift+J" |
- } |
- }, |
- "_execute_page_action": { |
- "suggested_key": { |
- "default": "Ctrl+E" |
- "windows": "Alt+P", |
- "mac": "Option+P", |
- } |
- } |
- }</b>, |
- ... |
-}</pre> |
-<p>In your background page, you can bind a handler to each of the commands |
-defined in the manifest (except for '_execute_browser_action' and |
-'_execute_page_action') via onCommand.addListener. For example:</p> |
-<pre>chrome.experimental.keybinding.onCommand.addListener(function(command) { |
- console.log('Command:', command); |
-}); |
-</pre> |
-<p>The '_execute_browser_action' and '_execute_page_action' commands are |
-reserved for the action of opening your extension's popups. They won't normally |
-generate events that you can handle. If you need to take action based on your |
-popup opening, consider listening for an 'onDomReady' event inside your popup's |
-code. |
-</p> |
-<!-- END AUTHORED CONTENT --> |
-</div> |
+ <div id="static"></div> |
<!-- API PAGE --> |
- <div class="apiPage"> |
- <a name="apiReference"></a> |
- <h2>API reference: chrome.experimental.keybinding</h2> |
- <!-- PROPERTIES --> |
- <!-- /apiGroup --> |
- <!-- METHODS --> |
- <!-- /apiGroup --> |
- <!-- EVENTS --> |
- <div id="eventsTemplate" class="apiGroup"> |
- <a name="global-events"></a> |
- <h3>Events</h3> |
- <!-- iterates over all events --> |
- <div class="apiItem"> |
- <a name="event-onCommand"></a> |
- <h4>onCommand</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span class="subdued">chrome.experimental.keybinding.</span><span>onCommand</span><span class="subdued">.addListener</span>(function(<span>string command</span>) <span class="subdued">{...}</span><span></span>); |
- </div> |
- <div class="description"> |
- <p>Fired when a registered command is activated using a keyboard shortcut.</p> |
- <!-- LISTENER PARAMETERS --> |
- <div> |
- <h4>Listener parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>command</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>string</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- <!-- EXTRA PARAMETERS --> |
- <!-- LISTENER RETURN VALUE --> |
- <dl> |
- </dl> |
- </div> <!-- /description --> |
- <!-- /description --> |
- </div> <!-- /apiItem --> |
- </div> <!-- /apiGroup --> |
- <!-- TYPES --> |
- <!-- /apiGroup --> |
- </div> <!-- /apiPage --> |
+ <!-- /apiPage --> |
</div> <!-- /gc-pagecontent --> |
</div> <!-- /g-section --> |
</div> <!-- /codesiteContent --> |