diff options
author | brg@chromium.com <brg@chromium.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2010-03-17 20:41:58 +0000 |
---|---|---|
committer | brg@chromium.com <brg@chromium.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2010-03-17 20:41:58 +0000 |
commit | 4462559524df6726acc2400113508f3dc22b3648 (patch) | |
tree | 29986e90138219c2091482606685a0f6ddab6628 | |
parent | 6d37714b0e46f65b0418bc3d85f2d296bbbbdfa9 (diff) | |
download | chromium_src-4462559524df6726acc2400113508f3dc22b3648.zip chromium_src-4462559524df6726acc2400113508f3dc22b3648.tar.gz chromium_src-4462559524df6726acc2400113508f3dc22b3648.tar.bz2 |
Committing for dcheng@
Original review: http://codereview.chromium.org/882003
Review URL: http://codereview.chromium.org/1042004
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@41874 0039d316-1c4b-4281-b951-d872f2087c98
15 files changed, 1072 insertions, 1 deletions
diff --git a/chrome/browser/extensions/extension_clipboard_api.cc b/chrome/browser/extensions/extension_clipboard_api.cc new file mode 100644 index 0000000..dbfe664 --- /dev/null +++ b/chrome/browser/extensions/extension_clipboard_api.cc @@ -0,0 +1,52 @@ +// Copyright (c) 2010 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "chrome/browser/extensions/extension_clipboard_api.h" + +#include "base/string_util.h" +#include "base/values.h" +#include "chrome/browser/extensions/extension_tabs_module.h" +#include "chrome/browser/renderer_host/render_view_host.h" +#include "chrome/browser/tab_contents/tab_contents.h" +#include "chrome/common/extensions/extension_error_utils.h" + +namespace { +// Errors. +const char kNoTabError[] = "No tab with id: *."; +} + +bool ClipboardFunction::RunImpl() { + int tab_id; + EXTENSION_FUNCTION_VALIDATE(args_->GetAsInteger(&tab_id)); + + TabContents* contents = NULL; + if (!ExtensionTabUtil::GetTabById(tab_id, profile(), include_incognito(), + NULL, NULL, &contents, NULL)) { + error_ = ExtensionErrorUtils::FormatErrorMessage(kNoTabError, + IntToString(tab_id)); + return false; + } + + RenderViewHost* render_view_host = contents->render_view_host(); + if (!render_view_host) { + return false; + } + + return RunImpl(render_view_host); +} + +bool ExecuteCopyClipboardFunction::RunImpl(RenderViewHost* render_view_host) { + render_view_host->Copy(); + return true; +} + +bool ExecuteCutClipboardFunction::RunImpl(RenderViewHost* render_view_host) { + render_view_host->Cut(); + return true; +} + +bool ExecutePasteClipboardFunction::RunImpl(RenderViewHost* render_view_host) { + render_view_host->Paste(); + return true; +} diff --git a/chrome/browser/extensions/extension_clipboard_api.h b/chrome/browser/extensions/extension_clipboard_api.h new file mode 100644 index 0000000..4789221 --- /dev/null +++ b/chrome/browser/extensions/extension_clipboard_api.h @@ -0,0 +1,37 @@ +// Copyright (c) 2010 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_CLIPBOARD_API_H_ +#define CHROME_BROWSER_EXTENSIONS_EXTENSION_CLIPBOARD_API_H_ + +#include "chrome/browser/extensions/extension_function.h" + +class RenderViewHost; + +// Base class for clipboard function APIs. +class ClipboardFunction : public SyncExtensionFunction { + public: + virtual bool RunImpl(); + virtual bool RunImpl(RenderViewHost* render_view_host) = 0; +}; + +class ExecuteCopyClipboardFunction : public ClipboardFunction { + public: + virtual bool RunImpl(RenderViewHost* render_view_host); + DECLARE_EXTENSION_FUNCTION_NAME("experimental.clipboard.executeCopy"); +}; + +class ExecuteCutClipboardFunction : public ClipboardFunction { + public: + virtual bool RunImpl(RenderViewHost* render_view_host); + DECLARE_EXTENSION_FUNCTION_NAME("experimental.clipboard.executeCut"); +}; + +class ExecutePasteClipboardFunction : public ClipboardFunction { + public: + virtual bool RunImpl(RenderViewHost* render_view_host); + DECLARE_EXTENSION_FUNCTION_NAME("experimental.clipboard.executePaste"); +}; + +#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_CLIPBOARD_API_H_ diff --git a/chrome/browser/extensions/extension_clipboard_apitest.cc b/chrome/browser/extensions/extension_clipboard_apitest.cc new file mode 100644 index 0000000..8198c9a --- /dev/null +++ b/chrome/browser/extensions/extension_clipboard_apitest.cc @@ -0,0 +1,15 @@ +// Copyright (c) 2010 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "base/command_line.h" +#include "chrome/browser/extensions/extension_apitest.h" +#include "chrome/common/chrome_switches.h" + +IN_PROC_BROWSER_TEST_F(ExtensionApiTest, Clipboard) { + CommandLine::ForCurrentProcess()->AppendSwitch( + switches::kEnableExperimentalExtensionApis); + + StartHTTPServer(); + ASSERT_TRUE(RunExtensionTest("clipboard")) << message_; +} diff --git a/chrome/browser/extensions/extension_function_dispatcher.cc b/chrome/browser/extensions/extension_function_dispatcher.cc index 640725d..30350db 100644 --- a/chrome/browser/extensions/extension_function_dispatcher.cc +++ b/chrome/browser/extensions/extension_function_dispatcher.cc @@ -15,6 +15,7 @@ #include "chrome/browser/extensions/extension_bookmarks_module.h" #include "chrome/browser/extensions/extension_bookmarks_module_constants.h" #include "chrome/browser/extensions/extension_browser_actions_api.h" +#include "chrome/browser/extensions/extension_clipboard_api.h" #include "chrome/browser/extensions/extension_dom_ui.h" #include "chrome/browser/extensions/extension_function.h" #include "chrome/browser/extensions/extension_history_api.h" @@ -199,6 +200,11 @@ void FactoryRegistry::ResetFunctions() { // Accessibility. RegisterFunction<GetFocusedControlFunction>(); RegisterFunction<SetAccessibilityEnabledFunction>(); + + // Clipboard. + RegisterFunction<ExecuteCopyClipboardFunction>(); + RegisterFunction<ExecuteCutClipboardFunction>(); + RegisterFunction<ExecutePasteClipboardFunction>(); } void FactoryRegistry::GetAllNames(std::vector<std::string>* names) { diff --git a/chrome/chrome_browser.gypi b/chrome/chrome_browser.gypi index 8d06735..2cf75b5 100755 --- a/chrome/chrome_browser.gypi +++ b/chrome/chrome_browser.gypi @@ -905,6 +905,8 @@ 'browser/extensions/extension_bookmark_manager_api.h', 'browser/extensions/extension_browser_actions_api.cc', 'browser/extensions/extension_browser_actions_api.h', + 'browser/extensions/extension_clipboard_api.cc', + 'browser/extensions/extension_clipboard_api.h', 'browser/extensions/extension_creator.cc', 'browser/extensions/extension_creator.h', 'browser/extensions/extension_disabled_infobar_delegate.cc', diff --git a/chrome/chrome_tests.gypi b/chrome/chrome_tests.gypi index 5d9446d..00ebcee 100644 --- a/chrome/chrome_tests.gypi +++ b/chrome/chrome_tests.gypi @@ -1206,6 +1206,7 @@ 'browser/extensions/extension_browsertest.cc', 'browser/extensions/extension_browsertest.h', 'browser/extensions/extension_browsertests_misc.cc', + 'browser/extensions/extension_clipboard_apitest.cc', 'browser/extensions/extension_crash_recovery_browsertest.cc', 'browser/extensions/extension_geolocation_apitest.cc', 'browser/extensions/extension_history_apitest.cc', diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json index afdfc24..2175e96 100755 --- a/chrome/common/extensions/api/extension_api.json +++ b/chrome/common/extensions/api/extension_api.json @@ -2504,5 +2504,39 @@ } ], "events": [] + }, + { + "namespace": "experimental.clipboard", + "types": [], + "functions": [ + { + "name": "executeCopy", + "type": "function", + "description": "Triggers a copy operation in the specified tab.", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, + {"type": "function", "name": "callback", "optional": true, "parameters": []} + ] + }, + { + "name": "executeCut", + "type": "function", + "description": "Triggers a cut operation in the specified tab.", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, + {"type": "function", "name": "callback", "optional": true, "parameters": []} + ] + }, + { + "name": "executePaste", + "type": "function", + "description": "Triggers a paste operation in the specified tab.", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, + {"type": "function", "name": "callback", "optional": true, "parameters": []} + ] + } + ], + "events": [] } ] diff --git a/chrome/common/extensions/docs/experimental.clipboard.html b/chrome/common/extensions/docs/experimental.clipboard.html new file mode 100644 index 0000000..3ac7ada --- /dev/null +++ b/chrome/common/extensions/docs/experimental.clipboard.html @@ -0,0 +1,819 @@ +<!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="js/api_page_generator.js"></script> + <script type="text/javascript" src="js/bootstrap.js"></script> + <title>chrome.experimental.clipboard - Google Chrome Extensions - Google Code</title></head><body> <div id="gc-container" class="labs"> + <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> + <!-- 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 id="typeTemplate"> + <span> + <a> Type</a> + </span> + <span> + <span> + array of <span><span></span></span> + </span> + <span>paramType</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> <!-- /VALUE --> + + </div> <!-- /SUBTEMPLATES --> + + <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> + <!-- API HEADER --> + <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="http://www.google.com/jsapi"></script> + <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> + <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> + <script type="text/javascript" src="http://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> + </ul> + </div> <!-- end gc-topnav --> + + <div class="g-section g-tpl-170"> + <!-- SIDENAV --> + <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><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><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> + <li><a href="themes.html">Themes</a></li> + </ul> + </li> + <li>Browser Interaction + <ul> + <li><a href="bookmarks.html">Bookmarks</a></li> + <li><a href="events.html">Events</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="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="npapi.html">NPAPI Plugins</a></li> + </ul> + </li> + <li>Finishing + <ul> + <li><a href="autoupdate.html">Autoupdating</a></li> + <li><a href="packaging.html">Packaging</a></li> + <li><a href="external_extensions.html">External Extensions</a></li> + </ul> + </li> + </ul> + </li> + <li><h2><a href="tutorials.html">Tutorials</a></h2> + <ul> + <li><a href="tut_debugging.html">Debugging</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> + <!-- <li>Packages (.crx)</li> --> + </ul> + </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> + </ul> + </div> + + <div class="g-unit" id="gc-pagecontent"> + <div id="pageTitle"> + <h1 class="page_title">chrome.experimental.clipboard</h1> + </div> + <!-- TABLE OF CONTENTS --> + <div id="toc"> + <h2>Contents</h2> + <ol> + <li> + <a href="#H2-0">Notes</a> + <ol> + <li style="display: none; "> + <a>h3Name</a> + </li> + </ol> + </li> + <li> + <a href="#apiReference">API reference: chrome.experimental.clipboard</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="#methods">Methods</a> + <ol> + <li> + <a href="#method-executeCopy">executeCopy</a> + </li><li> + <a href="#method-executeCut">executeCut</a> + </li><li> + <a href="#method-executePaste">executePaste</a> + </li> + </ol> + </li> + <li style="display: none; "> + <a href="#events">Events</a> + <ol> + <li> + <a href="#event-anchor">eventName</a> + </li> + </ol> + </li> + <li style="display: none; "> + <a href="#types">Types</a> + <ol> + <li> + <a href="#id-anchor">id</a> + </li> + </ol> + </li> + </ol> + </li> + </ol> + </div> + <!-- /TABLE OF CONTENTS --> + + <!-- STATIC CONTENT PLACEHOLDER --> + <div id="static"><!-- BEGIN AUTHORED CONTENT --> +<p id="classSummary"> +For information on how to use experimental APIs, +see the <a href="experimental.html">chrome.experimental.* APIs</a> page. +</p> + +<a name="H2-0"></a><h2>Notes</h2> + +<p> +For all functions exposed by this API, the argument to the callback indicates +whether or not the event was successfully dispatched, not whether the event was +successfully processed and handled. Most callers won't care, since a failure +generally indicates the tab is going away. +</p> + +<!-- END AUTHORED CONTENT --> +</div> + + <!-- API PAGE --> + <div class="apiPage"> + <a name="apiReference"></a> + <h2>API reference: chrome.experimental.clipboard</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 --> + + <!-- METHODS --> + <div class="apiGroup" id="methods"> + <a name="methods"></a> + <h3>Methods</h3> + + <!-- iterates over all functions --> + <div class="apiItem"> + <a name="method-executeCopy"></a> <!-- method-anchor --> + <h4>executeCopy</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.clipboard.executeCopy</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> + <var><span>tabId</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>Triggers a copy operation in the specified tab.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>tabId</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>integer</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div><div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </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> + + </div> <!-- /description --> + + </div><div class="apiItem"> + <a name="method-executeCut"></a> <!-- method-anchor --> + <h4>executeCut</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.clipboard.executeCut</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> + <var><span>tabId</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>Triggers a cut operation in the specified tab.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>tabId</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>integer</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div><div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </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> + + </div> <!-- /description --> + + </div><div class="apiItem"> + <a name="method-executePaste"></a> <!-- method-anchor --> + <h4>executePaste</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.clipboard.executePaste</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> + <var><span>tabId</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>Triggers a paste operation in the specified tab.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>tabId</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>integer</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> + </div><div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </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> + + </div> <!-- /description --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- EVENTS --> + <div class="apiGroup" style="display: none; "> + <a name="events"></a> + <h3 id="events">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>); + </div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the event goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + </div> <!-- /decription --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- TYPES --> + <div class="apiGroup" style="display: none; "> + <a name="types.sort(sortByName)"></a> + <h3 id="types">Types</h3> + + <!-- iterates over all types --> + <div class="apiItem"> + <a></a> + <h4>type name</h4> + + <div> + </div> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + </div> <!-- /apiPage --> + </div> <!-- /gc-pagecontent --> + </div> <!-- /g-section --> + </div> <!-- /codesiteContent --> + <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> + ©2010 Google + </p> + +<!-- begin analytics --> +<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> +<script src="http://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> +<!-- end analytics --> + </div> + </div> <!-- /gc-footer --> + </div> <!-- /gc-container --> +</body></html> diff --git a/chrome/common/extensions/docs/experimental.html b/chrome/common/extensions/docs/experimental.html index e24fd23..79042ab 100644 --- a/chrome/common/extensions/docs/experimental.html +++ b/chrome/common/extensions/docs/experimental.html @@ -253,7 +253,7 @@ on the following experimental APIs: </p> <ul> - <li><a href="experimental.history.html" js="">experimental.history</a></li><li><a href="experimental.infoBar.html" js="">experimental.infoBar</a></li><li><a href="experimental.processes.html" js="">experimental.processes</a></li> + <li><a href="experimental.clipboard.html" js="">experimental.clipboard</a></li><li><a href="experimental.history.html" js="">experimental.history</a></li><li><a href="experimental.processes.html" js="">experimental.processes</a></li> </ul> <p class="caution"> diff --git a/chrome/common/extensions/docs/static/experimental.clipboard.html b/chrome/common/extensions/docs/static/experimental.clipboard.html new file mode 100644 index 0000000..b9e26af --- /dev/null +++ b/chrome/common/extensions/docs/static/experimental.clipboard.html @@ -0,0 +1,16 @@ +<!-- BEGIN AUTHORED CONTENT --> +<p id="classSummary"> +For information on how to use experimental APIs, +see the <a href="experimental.html">chrome.experimental.* APIs</a> page. +</p> + +<h2>Notes</h2> + +<p> +For all functions exposed by this API, the argument to the callback indicates +whether or not the event was successfully dispatched, not whether the event was +successfully processed and handled. Most callers won't care, since a failure +generally indicates the tab is going away. +</p> + +<!-- END AUTHORED CONTENT --> diff --git a/chrome/renderer/resources/renderer_extension_bindings.js b/chrome/renderer/resources/renderer_extension_bindings.js index ac487c5..d207267 100644 --- a/chrome/renderer/resources/renderer_extension_bindings.js +++ b/chrome/renderer/resources/renderer_extension_bindings.js @@ -246,6 +246,7 @@ var chrome = chrome || {}; "devtools", "experimental.accessibility", "experimental.bookmarkManager", + "experimental.clipboard", "experimental.extension", "experimental.idle", "experimental.history", diff --git a/chrome/test/data/extensions/api_test/clipboard/manifest.json b/chrome/test/data/extensions/api_test/clipboard/manifest.json new file mode 100644 index 0000000..3f79bb5 --- /dev/null +++ b/chrome/test/data/extensions/api_test/clipboard/manifest.json @@ -0,0 +1,13 @@ +{ + "name": "chrome.clipboard", + "version": "0.1", + "description": "end-to-end browser test for chrome.experimental.clipboard API", + "background_page": "test.html", + "permissions": ["experimental", "tabs"], + "content_scripts": [ + { + "matches": ["http://*/*"], + "js": ["test_helper.js"] + } + ] +} diff --git a/chrome/test/data/extensions/api_test/clipboard/test.html b/chrome/test/data/extensions/api_test/clipboard/test.html new file mode 100644 index 0000000..46f4d74 --- /dev/null +++ b/chrome/test/data/extensions/api_test/clipboard/test.html @@ -0,0 +1 @@ +<script src="test.js"></script> diff --git a/chrome/test/data/extensions/api_test/clipboard/test.js b/chrome/test/data/extensions/api_test/clipboard/test.js new file mode 100644 index 0000000..52f013d --- /dev/null +++ b/chrome/test/data/extensions/api_test/clipboard/test.js @@ -0,0 +1,64 @@ +// Clipboard API test for Chrome. +// browser_tests.exe --gtest_filter=ExtensionApiTest.Clipboard + +const TEST_URL = "http://localhost:1337/files/extensions/test_file.html"; + +function setupWindow(callback) { + chrome.tabs.getSelected(null, function(tab) { + chrome.tabs.update(tab.id, {"url": TEST_URL}, callback); + }); +} + +chrome.test.runTests([ + function executeCopy() { + var onRequestCompleted = chrome.test.listenForever( + chrome.extension.onRequest, + function(request, sender, sendResponse) { + if (request == "start test") { + chrome.experimental.clipboard.executeCopy( + sender.tab.id, + chrome.test.callbackPass()); + } else if (request == "copy event") { + onRequestCompleted(); + } else { + chrome.test.fail("Unexpected request: " + JSON.stringify(request)); + } + } + ); + setupWindow(); + }, + function executeCut() { + var onRequestCompleted = chrome.test.listenForever( + chrome.extension.onRequest, + function(request, sender, sendResponse) { + if (request == "start test") { + chrome.experimental.clipboard.executeCut( + sender.tab.id, + chrome.test.callbackPass()); + } else if (request == "cut event") { + onRequestCompleted(); + } else { + chrome.test.fail("Unexpected request: " + JSON.stringify(request)); + } + } + ); + setupWindow(); + }, + function executePaste() { + var onRequestCompleted = chrome.test.listenForever( + chrome.extension.onRequest, + function(request, sender, sendResponse) { + if (request == "start test") { + chrome.experimental.clipboard.executePaste( + sender.tab.id, + chrome.test.callbackPass()); + } else if (request == "paste event") { + onRequestCompleted(); + } else { + chrome.test.fail("Unexpected request: " + JSON.stringify(request)); + } + } + ); + setupWindow(); + } +]); diff --git a/chrome/test/data/extensions/api_test/clipboard/test_helper.js b/chrome/test/data/extensions/api_test/clipboard/test_helper.js new file mode 100644 index 0000000..c38f5f8 --- /dev/null +++ b/chrome/test/data/extensions/api_test/clipboard/test_helper.js @@ -0,0 +1,10 @@ +document.addEventListener("copy", function() { + chrome.extension.sendRequest("copy event"); +}, false); +document.addEventListener("cut", function() { + chrome.extension.sendRequest("cut event"); +}, false); +document.addEventListener("paste", function() { + chrome.extension.sendRequest("paste event"); +}, false); +chrome.extension.sendRequest("start test"); |