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#include "wtf/Vector.h"
34
35// FIXME: This class is too high-level to be in the platform directory, since it
36// uses the DOM and makes calls to Editor. It should either be divested of its
37// knowledge of the frame and editor or moved into the editing directory.
38
39namespace WebCore {
40
41class ArchiveResource;
42class Clipboard;
43class DocumentFragment;
44class Frame;
45class HitTestResult;
46class KURL;
47class Node;
48class Range;
49class SharedBuffer;
50
51enum ShouldSerializeSelectedTextForClipboard { DefaultSelectedTextType, IncludeImageAltTextForClipboard };
52
53class Pasteboard {
54    WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
55public:
56    enum SmartReplaceOption {
57        CanSmartReplace,
58        CannotSmartReplace
59    };
60
61    static Pasteboard* generalPasteboard();
62    void writeSelection(Range*, bool canSmartCopyOrDelete, Frame*, ShouldSerializeSelectedTextForClipboard = DefaultSelectedTextType);
63    void writePlainText(const String&, SmartReplaceOption);
64    void writeURL(const KURL&, const String&, Frame* = 0);
65    void writeImage(Node*, const KURL&, const String& title);
66    void writeClipboard(Clipboard*);
67    void clear();
68    bool canSmartReplace();
69    PassRefPtr<DocumentFragment> documentFragment(Frame*, PassRefPtr<Range>, bool allowPlainText, bool& chosePlainText);
70    String plainText(Frame* = 0);
71
72    bool isSelectionMode() const;
73    void setSelectionMode(bool);
74
75private:
76    Pasteboard();
77
78    bool m_selectionMode;
79};
80
81} // namespace WebCore
82
83#endif // Pasteboard_h
84