Source/WebCore/platform/chromium/ClipboardChromium.h

   1 // Copyright (c) 2008, Google Inc.
   2 // 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 are
   6 // met:
   7 //
   8 //     * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //     * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //     * Neither the name of Google Inc. nor the names of its
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 #ifndef ClipboardChromium_h
  31 #define ClipboardChromium_h
  32
  33 #include "CachedImage.h"
  34 #include "ChromiumDataObject.h"
  35 #include "Clipboard.h"
  36
  37 namespace WebCore {
  38
  39     class CachedImage;
  40     class ChromiumDataObject;
  41     class Frame;
  42     class IntPoint;
  43
  44     class ClipboardChromium : public Clipboard, public CachedImageClient {
  45         WTF_MAKE_FAST_ALLOCATED;
  46     public:
  47         ~ClipboardChromium() {}
  48
  49         static PassRefPtr<ClipboardChromium> create(
  50             ClipboardType, PassRefPtr<ChromiumDataObject>, ClipboardAccessPolicy, Frame*);
  51
  52         // Returns the file name (not including the extension). This removes any
  53         // invalid file system characters as well as making sure the
  54         // path + extension is not bigger than allowed by the file system.
  55         // This may change the file extension in dataObject.
  56         static String validateFileName(const String& title, ChromiumDataObject* dataObject);
  57
  58         virtual void clearData(const String& type);
  59         void clearAllData();
  60         String getData(const String& type, bool& success) const;
  61         bool setData(const String& type, const String& data);
  62         bool platformClipboardChanged() const;
  63
  64         // extensions beyond IE's API
  65         virtual HashSet<String> types() const;
  66         virtual PassRefPtr<FileList> files() const;
  67
  68         void setDragImage(CachedImage*, const IntPoint&);
  69         void setDragImageElement(Node*, const IntPoint&);
  70
  71         PassRefPtr<ChromiumDataObject> dataObject()
  72         {
  73             return m_dataObject;
  74         }
  75
  76         virtual DragImageRef createDragImage(IntPoint& dragLoc) const;
  77         virtual void declareAndWriteDragImage(Element*, const KURL&, const String& title, Frame*);
  78         virtual void writeURL(const KURL&, const String&, Frame*);
  79         virtual void writeRange(Range*, Frame*);
  80         virtual void writePlainText(const String&);
  81
  82         virtual bool hasData();
  83
  84 #if ENABLE(DATA_TRANSFER_ITEMS)
  85         virtual PassRefPtr<DataTransferItemList> items();
  86 #endif
  87
  88     private:
  89         ClipboardChromium(ClipboardType, PassRefPtr<ChromiumDataObject>, ClipboardAccessPolicy, Frame*);
  90
  91         void resetFromClipboard();
  92         void setDragImage(CachedImage*, Node*, const IntPoint&);
  93         RefPtr<ChromiumDataObject> m_dataObject;
  94         Frame* m_frame;
  95
  96         uint64_t m_originalSequenceNumber;
  97     };
  98
  99 } // namespace WebCore
 100
 101 #endif // ClipboardChromium_h