1/*
2 * Copyright (C) 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 WebClipboard_h
32#define WebClipboard_h
33
34#include "WebCommon.h"
35#include "WebData.h"
36#include "WebString.h"
37#include "WebVector.h"
38
39namespace WebKit {
40
41class WebDragData;
42class WebImage;
43class WebURL;
44
45class WebClipboard {
46public:
47    enum Format {
48        FormatPlainText,
49        FormatHTML,
50        FormatBookmark,
51        FormatSmartPaste
52    };
53
54    enum Buffer {
55        BufferStandard,
56        // Used on platforms like the X Window System that treat selection
57        // as a type of clipboard.
58        BufferSelection,
59        // Read-only buffer corresponding to the current drag operation, if any.
60        BufferDrag,
61    };
62
63    virtual bool isFormatAvailable(Format, Buffer) { return false; }
64
65    virtual WebString readPlainText(Buffer) { return WebString(); }
66    virtual WebString readHTML(Buffer, WebURL*) { return WebString(); }
67    virtual WebData readImage(Buffer) { return WebData(); }
68
69    virtual void writePlainText(const WebString&) { }
70    virtual void writeHTML(
71        const WebString& htmlText, const WebURL&,
72        const WebString& plainText, bool writeSmartPaste) { }
73    virtual void writeURL(
74        const WebURL&, const WebString& title) { }
75    virtual void writeImage(
76        const WebImage&, const WebURL&, const WebString& title) { }
77    virtual void writeData(
78        const WebString& type,
79        const WebString& data,
80        const WebString& metadata) { }
81
82    // The following functions are used for reading platform data for copy and
83    // paste, drag and drop, and selection copy (on X).
84    virtual WebVector<WebString> readAvailableTypes(
85        Buffer, bool* containsFilenames) { return WebVector<WebString>(); }
86    // Returns true if the requested type was successfully read from the buffer.
87    virtual bool readData(
88        Buffer, const WebString& type, WebString* data,
89        WebString* metadata) { return false; }
90    virtual WebVector<WebString> readFilenames(
91        Buffer) { return WebVector<WebString>(); }
92
93protected:
94    ~WebClipboard() {}
95};
96
97} // namespace WebKit
98
99#endif
100