WebCore:
[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 "Frame.h"
30 #include <wtf/Forward.h>
31 #include <wtf/OwnPtr.h>
32 #include <wtf/RefPtr.h>
33
34 namespace WebCore {
35
36 class DeleteButtonController;
37 class Editor;
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     EditorClient* client() const;
53
54     void cut();
55     void copy();
56     void paste();
57     void performDelete();
58
59     bool shouldShowDeleteInterface(HTMLElement*);
60
61     void respondToChangedSelection(const Selection& oldSelection);
62     void respondToChangedContents();
63     
64     Frame::TriState selectionUnorderedListState() const;
65     Frame::TriState selectionOrderedListState() const;
66     
67     void removeFormattingAndStyle();
68
69     Frame* frame() const { return m_frame; }
70     DeleteButtonController* deleteButtonController() const { return m_deleteButtonController.get(); }
71     EditCommand* lastEditCommand() { return m_lastEditCommand.get(); }
72
73     // FIXME: Once the Editor implements all editing commands, it should track 
74     // the lastEditCommand on its own, and we should remove this function.
75     void setLastEditCommand(PassRefPtr<EditCommand> lastEditCommand);
76
77     void deleteSelectionWithSmartDelete(bool smartDelete);
78
79 private:
80     Frame* m_frame;
81     RefPtr<EditorClient> m_client;
82     OwnPtr<DeleteButtonController> m_deleteButtonController;
83     RefPtr<EditCommand> m_lastEditCommand;
84
85     bool canCopy();
86     bool canCut();
87     bool canDelete();
88     bool canDeleteRange(Range*);
89     bool canPaste();
90     bool canSmartCopyOrDelete();
91     bool isSelectionRichlyEditable();
92     Range* selectedRange();
93     bool shouldDeleteRange(Range*);
94     bool tryDHTMLCopy();
95     bool tryDHTMLCut();
96     bool tryDHTMLPaste();
97     void deleteSelection();
98     void pasteAsPlainTextWithPasteboard(Pasteboard);
99     void pasteWithPasteboard(Pasteboard, bool allowPlainText);
100     void writeSelectionToPasteboard(Pasteboard);
101 };
102
103 } // namespace WebCore
104
105 #endif // Editor_h