[Clipboard API] Refactor Pasteboard item reading functions to work on both iOS and...
[WebKit.git] / Source / WebCore / platform / PasteboardStrategy.h
1 /*
2  * Copyright (C) 2012 Apple 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 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 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 PasteboardStrategy_h
27 #define PasteboardStrategy_h
28
29 #include <wtf/Forward.h>
30
31 namespace WebCore {
32
33 class Color;
34 class SelectionData;
35 class SharedBuffer;
36 struct PasteboardImage;
37 struct PasteboardItemInfo;
38 struct PasteboardURL;
39 struct PasteboardWebContent;
40 struct PasteboardCustomData;
41
42 class PasteboardStrategy {
43 public:
44 #if PLATFORM(IOS_FAMILY)
45     virtual void writeToPasteboard(const PasteboardURL&, const String& pasteboardName) = 0;
46     virtual void writeToPasteboard(const PasteboardWebContent&, const String& pasteboardName) = 0;
47     virtual void writeToPasteboard(const PasteboardImage&, const String& pasteboardName) = 0;
48     virtual void writeToPasteboard(const String& pasteboardType, const String&, const String& pasteboardName) = 0;
49     virtual void updateSupportedTypeIdentifiers(const Vector<String>& identifiers, const String& pasteboardName) = 0;
50 #endif // PLATFORM(IOS_FAMILY)
51 #if PLATFORM(COCOA)
52     virtual void getTypes(Vector<String>& types, const String& pasteboardName) = 0;
53     virtual RefPtr<SharedBuffer> bufferForType(const String& pasteboardType, const String& pasteboardName) = 0;
54     virtual void getPathnamesForType(Vector<String>& pathnames, const String& pasteboardType, const String& pasteboardName) = 0;
55     virtual String stringForType(const String& pasteboardType, const String& pasteboardName) = 0;
56     virtual Vector<String> allStringsForType(const String& pasteboardType, const String& pasteboardName) = 0;
57     virtual long changeCount(const String& pasteboardName) = 0;
58     virtual String uniqueName() = 0;
59     virtual Color color(const String& pasteboardName) = 0;
60     virtual URL url(const String& pasteboardName) = 0;
61     virtual int getNumberOfFiles(const String& pasteboardName) = 0;
62
63     virtual long addTypes(const Vector<String>& pasteboardTypes, const String& pasteboardName) = 0;
64     virtual long setTypes(const Vector<String>& pasteboardTypes, const String& pasteboardName) = 0;
65     virtual long setBufferForType(SharedBuffer*, const String& pasteboardType, const String& pasteboardName) = 0;
66     virtual long setURL(const PasteboardURL&, const String& pasteboardName) = 0;
67     virtual long setColor(const Color&, const String& pasteboardName) = 0;
68     virtual long setStringForType(const String&, const String& pasteboardType, const String& pasteboardName) = 0;
69 #endif
70     virtual String readStringFromPasteboard(size_t index, const String& pasteboardType, const String& pasteboardName) = 0;
71     virtual RefPtr<SharedBuffer> readBufferFromPasteboard(size_t index, const String& pasteboardType, const String& pasteboardName) = 0;
72     virtual URL readURLFromPasteboard(size_t index, const String& pasteboardName, String& title) = 0;
73     virtual PasteboardItemInfo informationForItemAtIndex(size_t index, const String& pasteboardName) = 0;
74     virtual Vector<PasteboardItemInfo> allPasteboardItemInfo(const String& pasteboardName) = 0;
75     virtual int getPasteboardItemsCount(const String& pasteboardName) = 0;
76
77     virtual Vector<String> typesSafeForDOMToReadAndWrite(const String& pasteboardName, const String& origin) = 0;
78     virtual long writeCustomData(const PasteboardCustomData&, const String& pasteboardName) = 0;
79
80 #if PLATFORM(GTK)
81     virtual void writeToClipboard(const String& pasteboardName, const SelectionData&) = 0;
82     virtual Ref<SelectionData> readFromClipboard(const String& pasteboardName) = 0;
83 #endif // PLATFORM(GTK)
84
85 #if USE(LIBWPE)
86     virtual void getTypes(Vector<String>& types) = 0;
87     virtual void writeToPasteboard(const PasteboardWebContent&) = 0;
88     virtual void writeToPasteboard(const String& pasteboardType, const String&) = 0;
89 #endif
90
91 protected:
92     virtual ~PasteboardStrategy()
93     {
94     }
95 };
96
97 }
98
99 #endif // !PasteboardStrategy_h