third_party/WebKit/Source/core/clipboard/Pasteboard.h

   1 /*
   2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef Pasteboard_h
  27 #define Pasteboard_h
  28
  29 #include "core/CoreExport.h"
  30 #include "platform/heap/Handle.h"
  31 #include "public/platform/WebClipboard.h"
  32 #include "wtf/Forward.h"
  33 #include "wtf/Noncopyable.h"
  34 #include "wtf/text/WTFString.h"
  35
  36 namespace blink {
  37
  38 class DataObject;
  39 class Image;
  40 class KURL;
  41
  42 class CORE_EXPORT Pasteboard {
  43     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED(Pasteboard);
  44 public:
  45     enum SmartReplaceOption {
  46         CanSmartReplace,
  47         CannotSmartReplace
  48     };
  49
  50     static Pasteboard* generalPasteboard();
  51     void writePlainText(const String&, SmartReplaceOption);
  52     void writeImage(Image*, const KURL&, const String& title);
  53     void writeDataObject(DataObject*);
  54     bool canSmartReplace();
  55     bool isHTMLAvailable();
  56     String plainText();
  57
  58     // If no data is read, an empty string will be returned and all out parameters will be cleared.
  59     // If applicable, the page URL will be assigned to the KURL parameter.
  60     // fragmentStart and fragmentEnd are indexes into the returned markup that indicate
  61     // the start and end of the returned markup. If there is no additional context,
  62     // fragmentStart will be zero and fragmentEnd will be the same as the length of the markup.
  63     String readHTML(KURL&, unsigned& fragmentStart, unsigned& fragmentEnd);
  64
  65     void writeHTML(const String& markup, const KURL& documentURL, const String& plainText, bool canSmartCopyOrDelete);
  66
  67     bool isSelectionMode() const;
  68     void setSelectionMode(bool);
  69
  70     WebClipboard::Buffer buffer() const { return m_buffer; }
  71
  72 private:
  73     Pasteboard();
  74
  75     WebClipboard::Buffer m_buffer;
  76 };
  77
  78 } // namespace blink
  79
  80 #endif // Pasteboard_h