08b6865c9b3707fdae1170d87afef8545f8583e7
[WebKit-https.git] / Source / WebCore / platform / 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 <wtf/Forward.h>
30 #include <wtf/HashSet.h>
31 #include <wtf/Noncopyable.h>
32 #include <wtf/text/WTFString.h>
33 #if PLATFORM(MAC)
34 #include <wtf/RetainPtr.h>
35 #endif
36 #if PLATFORM(GTK)
37 #include <PasteboardHelper.h>
38 #endif
39 #include <wtf/Vector.h>
40
41 // FIXME: This class is too high-level to be in the platform directory, since it
42 // uses the DOM and makes calls to Editor. It should either be divested of its
43 // knowledge of the frame and editor or moved into the editing directory.
44
45 #if PLATFORM(MAC)
46 OBJC_CLASS NSAttributedString;
47 OBJC_CLASS NSFileWrapper;
48 OBJC_CLASS NSArray;
49 #endif
50
51 #if PLATFORM(WIN)
52 #include <windows.h>
53 typedef struct HWND__* HWND;
54 #endif
55
56 namespace WebCore {
57
58 #if PLATFORM(MAC)
59 extern const char* WebArchivePboardType;
60 extern const char* WebSmartPastePboardType;
61 extern const char* WebURLNamePboardType;
62 extern const char* WebURLPboardType;
63 extern const char* WebURLsWithTitlesPboardType;
64 #endif
65
66 class ArchiveResource;
67 class Clipboard;
68 class DocumentFragment;
69 class Frame;
70 class HitTestResult;
71 class KURL;
72 class Node;
73 class Range;
74 class SharedBuffer;
75
76 enum ShouldSerializeSelectedTextForClipboard { DefaultSelectedTextType, IncludeImageAltTextForClipboard };
77     
78 class Pasteboard {
79     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
80 public:
81     enum SmartReplaceOption {
82         CanSmartReplace,
83         CannotSmartReplace
84     };
85
86 #if PLATFORM(MAC)
87     // This is required to support OS X services.
88     void writeSelectionForTypes(const Vector<String>& pasteboardTypes, bool canSmartCopyOrDelete, Frame*, ShouldSerializeSelectedTextForClipboard);
89     explicit Pasteboard(const String& pasteboardName);
90     static String getStringSelection(Frame*, ShouldSerializeSelectedTextForClipboard);
91     static PassRefPtr<SharedBuffer> getDataSelection(Frame*, const String& pasteboardType);
92 #endif
93     
94     static Pasteboard* generalPasteboard();
95     void writeSelection(Range*, bool canSmartCopyOrDelete, Frame*, ShouldSerializeSelectedTextForClipboard = DefaultSelectedTextType);
96     void writePlainText(const String&, SmartReplaceOption);
97     void writeURL(const KURL&, const String&, Frame* = 0);
98     void writeImage(Node*, const KURL&, const String& title);
99     void writeClipboard(Clipboard*);
100     void clear();
101     bool canSmartReplace();
102     PassRefPtr<DocumentFragment> documentFragment(Frame*, PassRefPtr<Range>, bool allowPlainText, bool& chosePlainText);
103     String plainText(Frame* = 0);
104     
105 #if PLATFORM(QT) || PLATFORM(CHROMIUM) || PLATFORM(GTK)
106     bool isSelectionMode() const;
107     void setSelectionMode(bool);
108 #else
109     bool isSelectionMode() const { return false; }
110     void setSelectionMode(bool) { }
111 #endif
112
113 #if PLATFORM(GTK)
114     ~Pasteboard();
115 #endif
116
117 private:
118     Pasteboard();
119
120 #if PLATFORM(MAC)
121     String m_pasteboardName;
122 #endif
123
124 #if PLATFORM(WIN)
125     HWND m_owner;
126 #endif
127
128 #if PLATFORM(QT) || PLATFORM(CHROMIUM)
129     bool m_selectionMode;
130 #endif
131
132 };
133
134 } // namespace WebCore
135
136 #endif // Pasteboard_h