Source/WebCore/platform/chromium/ChromiumDataObject.h

   1 /*
   2  * Copyright (c) 2008, 2009, Google 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 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
  31 #ifndef ChromiumDataObject_h
  32 #define ChromiumDataObject_h
  33
  34 #include "ChromiumDataObjectItem.h"
  35 #include "PlatformString.h"
  36 #include "Supplementable.h"
  37 #include <wtf/HashSet.h>
  38 #include <wtf/RefPtr.h>
  39 #include <wtf/Vector.h>
  40 #include <wtf/text/StringHash.h>
  41
  42 namespace WebCore {
  43
  44 class KURL;
  45 class SharedBuffer;
  46
  47 typedef int ExceptionCode;
  48
  49 // A data object for holding data that would be in a clipboard or moved
  50 // during a drag-n-drop operation.  This is the data that WebCore is aware
  51 // of and is not specific to a platform.
  52 class ChromiumDataObject : public RefCounted<ChromiumDataObject>, public Supplementable<ChromiumDataObject> {
  53 public:
  54     static PassRefPtr<ChromiumDataObject> createFromPasteboard();
  55     static PassRefPtr<ChromiumDataObject> create();
  56
  57     PassRefPtr<ChromiumDataObject> copy() const;
  58
  59     // DataTransferItemList support.
  60     size_t length() const;
  61     PassRefPtr<ChromiumDataObjectItem> item(unsigned long index);
  62     // FIXME: Implement V8DataTransferItemList::indexedPropertyDeleter to get this called.
  63     void deleteItem(unsigned long index);
  64     void clearAll();
  65     void add(const String& data, const String& type, ExceptionCode&);
  66     void add(PassRefPtr<File>, ScriptExecutionContext*);
  67
  68     // WebCore helpers.
  69     void clearData(const String& type);
  70     void clearAllExceptFiles();
  71
  72     HashSet<String> types() const;
  73     String getData(const String& type) const;
  74     bool setData(const String& type, const String& data);
  75
  76     void urlAndTitle(String& url, String* title = 0) const;
  77     void setURLAndTitle(const String& url, const String& title);
  78     void htmlAndBaseURL(String& html, KURL& baseURL) const;
  79     void setHTMLAndBaseURL(const String& html, const KURL& baseURL);
  80
  81     // Used for dragging in files from the desktop.
  82     bool containsFilenames() const;
  83     Vector<String> filenames() const;
  84     void addFilename(const String& filename, const String& displayName);
  85
  86     // Used to handle files (images) being dragged out.
  87     void addSharedBuffer(const String& name, PassRefPtr<SharedBuffer>);
  88
  89     int modifierKeyState() const { return m_modifierKeyState; }
  90     void setModifierKeyState(int modifierKeyState) { m_modifierKeyState = modifierKeyState; }
  91
  92 private:
  93     ChromiumDataObject();
  94     explicit ChromiumDataObject(const ChromiumDataObject&);
  95
  96     PassRefPtr<ChromiumDataObjectItem> findStringItem(const String& type) const;
  97     bool internalAddStringItem(PassRefPtr<ChromiumDataObjectItem>);
  98     void internalAddFileItem(PassRefPtr<ChromiumDataObjectItem>);
  99
 100     Vector<RefPtr<ChromiumDataObjectItem> > m_itemList;
 101
 102     // State of Shift/Ctrl/Alt/Meta keys.
 103     int m_modifierKeyState;
 104 };
 105
 106 } // namespace WebCore
 107
 108 #endif