Using -[WebItemProviderPasteboard setItemProviders:] to swap out item providers befor...
[WebKit-https.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 #include <wtf/RefCounted.h>
31 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 class Color;
36 class SelectionData;
37 class SharedBuffer;
38 class URL;
39 struct PasteboardImage;
40 struct PasteboardURL;
41 struct PasteboardWebContent;
42
43 class PasteboardStrategy {
44 public:
45 #if PLATFORM(IOS)
46     virtual void writeToPasteboard(const PasteboardURL&, const String& pasteboardName) = 0;
47     virtual void writeToPasteboard(const PasteboardWebContent&, const String& pasteboardName) = 0;
48     virtual void writeToPasteboard(const PasteboardImage&, const String& pasteboardName) = 0;
49     virtual void writeToPasteboard(const String& pasteboardType, const String&, const String& pasteboardName) = 0;
50     virtual int getPasteboardItemsCount(const String& pasteboardName) = 0;
51     virtual String readStringFromPasteboard(int index, const String& pasteboardType, const String& pasteboardName) = 0;
52     virtual RefPtr<SharedBuffer> readBufferFromPasteboard(int index, const String& pasteboardType, const String& pasteboardName) = 0;
53     virtual URL readURLFromPasteboard(int index, const String& pasteboardType, const String& pasteboardName, String& title) = 0;
54     virtual void getFilenamesForDataInteraction(Vector<String>& filenames, const String& pasteboardName) = 0;
55     virtual void updateSupportedTypeIdentifiers(const Vector<String>& identifiers, const String& pasteboardName) = 0;
56     virtual void getTypesByFidelityForItemAtIndex(Vector<String>& types, uint64_t index, const String& pasteboardName) = 0;
57 #endif // PLATFORM(IOS)
58 #if PLATFORM(COCOA)
59     virtual void getTypes(Vector<String>& types, const String& pasteboardName) = 0;
60     virtual RefPtr<SharedBuffer> bufferForType(const String& pasteboardType, const String& pasteboardName) = 0;
61     virtual void getPathnamesForType(Vector<String>& pathnames, const String& pasteboardType, const String& pasteboardName) = 0;
62     virtual String stringForType(const String& pasteboardType, const String& pasteboardName) = 0;
63     virtual long changeCount(const String& pasteboardName) = 0;
64     virtual String uniqueName() = 0;
65     virtual Color color(const String& pasteboardName) = 0;
66     virtual URL url(const String& pasteboardName) = 0;
67     virtual int getNumberOfFiles(const String& pasteboardName) = 0;
68
69     virtual long addTypes(const Vector<String>& pasteboardTypes, const String& pasteboardName) = 0;
70     virtual long setTypes(const Vector<String>& pasteboardTypes, const String& pasteboardName) = 0;
71     virtual long copy(const String& fromPasteboard, const String& toPasteboard) = 0;
72     virtual long setBufferForType(SharedBuffer*, const String& pasteboardType, const String& pasteboardName) = 0;
73     virtual long setPathnamesForType(const Vector<String>&, const String& pasteboardType, const String& pasteboardName) = 0;
74     virtual long setStringForType(const String&, const String& pasteboardType, const String& pasteboardName) = 0;
75 #endif
76
77 #if PLATFORM(GTK)
78     virtual void writeToClipboard(const String& pasteboardName, const SelectionData&) = 0;
79     virtual Ref<SelectionData> readFromClipboard(const String& pasteboardName) = 0;
80 #endif // PLATFORM(GTK)
81
82 #if PLATFORM(WPE)
83     virtual void getTypes(Vector<String>& types) = 0;
84     virtual String readStringFromPasteboard(int index, const String& pasteboardType) = 0;
85     virtual void writeToPasteboard(const PasteboardWebContent&) = 0;
86     virtual void writeToPasteboard(const String& pasteboardType, const String&) = 0;
87 #endif
88
89 protected:
90     virtual ~PasteboardStrategy()
91     {
92     }
93 };
94
95 }
96
97 #endif // !PasteboardStrategy_h