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