* WebKitPrefix.h:
[WebKit-https.git] / WebCore / editing / Editor.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 EDITOR_H
27 #define EDITOR_H
28
29 #include <wtf/Forward.h>
30 #include <wtf/OwnPtr.h>
31 #include <wtf/RefPtr.h>
32
33 namespace WebCore {
34
35 class DeleteButtonController;
36 class EditorClient;
37 class Frame;
38 class HTMLElement;
39 class Range;
40 class Selection;
41
42 // make platform-specific and implement - this is temporary placeholder
43 typedef int Pasteboard;
44
45 class Editor {
46 public:
47     Editor(Frame*, PassRefPtr<EditorClient>);
48     ~Editor();
49
50     void cut();
51     void copy();
52     void paste();
53     void performDelete();
54
55     bool shouldShowDeleteInterface(HTMLElement*);
56
57     void respondToChangedSelection(const Selection& oldSelection);
58     void respondToChangedContents();
59
60     Frame* frame() const { return m_frame; }
61     DeleteButtonController* deleteButtonController() const { return m_deleteButtonController.get(); }
62
63 private:
64     Frame* m_frame;
65     RefPtr<EditorClient> m_client;
66     OwnPtr<DeleteButtonController> m_deleteButtonController;
67
68     bool canCopy();
69     bool canCut();
70     bool canDelete();
71     bool canDeleteRange(Range*);
72     bool canPaste();
73     bool canSmartCopyOrDelete();
74     bool isSelectionRichlyEditable();
75     Range* selectedRange();
76     bool shouldDeleteRange(Range*);
77     bool tryDHTMLCopy();
78     bool tryDHTMLCut();
79     bool tryDHTMLPaste();
80     void deleteSelection();
81     void deleteSelectionWithSmartDelete(bool enabled);
82     void pasteAsPlainTextWithPasteboard(Pasteboard);
83     void pasteWithPasteboard(Pasteboard, bool allowPlainText);
84     void writeSelectionToPasteboard(Pasteboard);
85
86 };
87
88 } // namespace WebCore
89
90 #endif // EDITOR_H