ui/base/clipboard/scoped_clipboard_writer.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // This file declares the ScopedClipboardWriter class, a wrapper around
   6 // the Clipboard class which simplifies writing data to the system clipboard.
   7 // Upon deletion the class atomically writes all data to the clipboard,
   8 // avoiding any potential race condition with other processes that are also
   9 // writing to the system clipboard.
  10
  11 #ifndef UI_BASE_CLIPBOARD_SCOPED_CLIPBOARD_WRITER_H_
  12 #define UI_BASE_CLIPBOARD_SCOPED_CLIPBOARD_WRITER_H_
  13
  14 #include <string>
  15
  16 #include "base/strings/string16.h"
  17 #include "third_party/skia/include/core/SkBitmap.h"
  18 #include "ui/base/clipboard/clipboard.h"
  19 #include "ui/base/ui_base_export.h"
  20
  21 class Pickle;
  22
  23 namespace ui {
  24
  25 // This class is a wrapper for |Clipboard| that handles packing data
  26 // into a Clipboard::ObjectMap.
  27 class UI_BASE_EXPORT ScopedClipboardWriter {
  28  public:
  29   // Create an instance that is a simple wrapper around the clipboard of the
  30   // given type.
  31   explicit ScopedClipboardWriter(ClipboardType type);
  32
  33   ~ScopedClipboardWriter();
  34
  35   // Converts |text| to UTF-8 and adds it to the clipboard.
  36   void WriteText(const base::string16& text);
  37
  38   // Converts the text of the URL to UTF-8 and adds it to the clipboard, then
  39   // notifies the Clipboard that we just wrote a URL.
  40   void WriteURL(const base::string16& text);
  41
  42   // Adds HTML to the clipboard.  The url parameter is optional, but especially
  43   // useful if the HTML fragment contains relative links.
  44   void WriteHTML(const base::string16& markup, const std::string& source_url);
  45
  46   // Adds RTF to the clipboard.
  47   void WriteRTF(const std::string& rtf_data);
  48
  49   // Adds a bookmark to the clipboard.
  50   void WriteBookmark(const base::string16& bookmark_title,
  51                      const std::string& url);
  52
  53   // Adds an html hyperlink (<a href>) to the clipboard. |anchor_text| and
  54   // |url| will be escaped as needed.
  55   void WriteHyperlink(const base::string16& anchor_text,
  56                       const std::string& url);
  57
  58   // Used by WebKit to determine whether WebKit wrote the clipboard last
  59   void WriteWebSmartPaste();
  60
  61   // Adds arbitrary pickled data to clipboard.
  62   void WritePickledData(const Pickle& pickle,
  63                         const Clipboard::FormatType& format);
  64
  65   void WriteImage(const SkBitmap& bitmap);
  66
  67   // Removes all objects that would be written to the clipboard.
  68   void Reset();
  69
  70  private:
  71   // Converts |text| to UTF-8 and adds it to the clipboard.  If it's a URL, we
  72   // also notify the clipboard of that fact.
  73   void WriteTextOrURL(const base::string16& text, bool is_url);
  74
  75   // We accumulate the data passed to the various targets in the |objects_|
  76   // vector, and pass it to Clipboard::WriteObjects() during object destruction.
  77   Clipboard::ObjectMap objects_;
  78   const ClipboardType type_;
  79
  80   SkBitmap bitmap_;
  81
  82   // We keep around the UTF-8 text of the URL in order to pass it to
  83   // Clipboard::DidWriteURL().
  84   std::string url_text_;
  85
  86   DISALLOW_COPY_AND_ASSIGN(ScopedClipboardWriter);
  87 };
  88
  89 }  // namespace ui
  90
  91 #endif  // UI_BASE_CLIPBOARD_SCOPED_CLIPBOARD_WRITER_H_
  92