Unreviewed, rolling out r121572.
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebCoreSupport / WebEditorClient.h
1 /*
2  * Copyright (C) 2010 Apple 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebEditorClient_h
27 #define WebEditorClient_h
28
29 #include <WebCore/EditorClient.h>
30 #include <WebCore/TextCheckerClient.h>
31
32 namespace WebKit {
33
34 class WebPage;
35
36 class WebEditorClient : public WebCore::EditorClient, public WebCore::TextCheckerClient {
37 public:
38     WebEditorClient(WebPage* page)
39         : m_page(page)
40     {
41     }
42
43 private:
44     virtual void pageDestroyed() OVERRIDE;
45     virtual void frameWillDetachPage(WebCore::Frame*) OVERRIDE { }
46
47     virtual bool shouldDeleteRange(WebCore::Range*) OVERRIDE;
48     virtual bool shouldShowDeleteInterface(WebCore::HTMLElement*) OVERRIDE;
49     virtual bool smartInsertDeleteEnabled() OVERRIDE;
50     virtual bool isSelectTrailingWhitespaceEnabled() OVERRIDE;
51     virtual bool isContinuousSpellCheckingEnabled() OVERRIDE;
52     virtual void toggleContinuousSpellChecking() OVERRIDE;
53     virtual bool isGrammarCheckingEnabled() OVERRIDE;
54     virtual void toggleGrammarChecking() OVERRIDE;
55     virtual int spellCheckerDocumentTag() OVERRIDE;
56     
57     virtual bool shouldBeginEditing(WebCore::Range*) OVERRIDE;
58     virtual bool shouldEndEditing(WebCore::Range*) OVERRIDE;
59     virtual bool shouldInsertNode(WebCore::Node*, WebCore::Range*, WebCore::EditorInsertAction) OVERRIDE;
60     virtual bool shouldInsertText(const String&, WebCore::Range*, WebCore::EditorInsertAction) OVERRIDE;
61     virtual bool shouldChangeSelectedRange(WebCore::Range* fromRange, WebCore::Range* toRange, WebCore::EAffinity, bool stillSelecting) OVERRIDE;
62     
63     virtual bool shouldApplyStyle(WebCore::StylePropertySet*, WebCore::Range*) OVERRIDE;
64     virtual bool shouldMoveRangeAfterDelete(WebCore::Range*, WebCore::Range*) OVERRIDE;
65
66     virtual void didBeginEditing() OVERRIDE;
67     virtual void respondToChangedContents() OVERRIDE;
68     virtual void respondToChangedSelection(WebCore::Frame*) OVERRIDE;
69     virtual void didEndEditing() OVERRIDE;
70     virtual void didWriteSelectionToPasteboard() OVERRIDE;
71     virtual void didSetSelectionTypesForPasteboard() OVERRIDE;
72     
73     virtual void registerUndoStep(PassRefPtr<WebCore::UndoStep>) OVERRIDE;
74     virtual void registerRedoStep(PassRefPtr<WebCore::UndoStep>) OVERRIDE;
75     virtual void clearUndoRedoOperations() OVERRIDE;
76
77     virtual bool canCopyCut(WebCore::Frame*, bool defaultValue) const OVERRIDE;
78     virtual bool canPaste(WebCore::Frame*, bool defaultValue) const OVERRIDE;
79     virtual bool canUndo() const OVERRIDE;
80     virtual bool canRedo() const OVERRIDE;
81     
82     virtual void undo() OVERRIDE;
83     virtual void redo() OVERRIDE;
84
85     virtual void handleKeyboardEvent(WebCore::KeyboardEvent*) OVERRIDE;
86     virtual void handleInputMethodKeydown(WebCore::KeyboardEvent*) OVERRIDE;
87     
88     virtual void textFieldDidBeginEditing(WebCore::Element*) OVERRIDE;
89     virtual void textFieldDidEndEditing(WebCore::Element*) OVERRIDE;
90     virtual void textDidChangeInTextField(WebCore::Element*) OVERRIDE;
91     virtual bool doTextFieldCommandFromEvent(WebCore::Element*, WebCore::KeyboardEvent*) OVERRIDE;
92     virtual void textWillBeDeletedInTextField(WebCore::Element*) OVERRIDE;
93     virtual void textDidChangeInTextArea(WebCore::Element*) OVERRIDE;
94
95 #if PLATFORM(MAC)
96     virtual NSString *userVisibleString(NSURL *) OVERRIDE;
97     virtual WebCore::DocumentFragment* documentFragmentFromAttributedString(NSAttributedString *, Vector< RefPtr<WebCore::ArchiveResource> >&) OVERRIDE;
98     virtual void setInsertionPasteboard(const String& pasteboardName) OVERRIDE;
99     virtual NSURL* canonicalizeURL(NSURL*) OVERRIDE;
100     virtual NSURL* canonicalizeURLString(NSString*) OVERRIDE;
101 #endif
102
103 #if USE(APPKIT)
104     virtual void uppercaseWord() OVERRIDE;
105     virtual void lowercaseWord() OVERRIDE;
106     virtual void capitalizeWord() OVERRIDE;
107 #endif
108 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
109     virtual void showSubstitutionsPanel(bool show) OVERRIDE;
110     virtual bool substitutionsPanelIsShowing() OVERRIDE;
111     virtual void toggleSmartInsertDelete() OVERRIDE;
112     virtual bool isAutomaticQuoteSubstitutionEnabled() OVERRIDE;
113     virtual void toggleAutomaticQuoteSubstitution() OVERRIDE;
114     virtual bool isAutomaticLinkDetectionEnabled() OVERRIDE;
115     virtual void toggleAutomaticLinkDetection() OVERRIDE;
116     virtual bool isAutomaticDashSubstitutionEnabled() OVERRIDE;
117     virtual void toggleAutomaticDashSubstitution() OVERRIDE;
118     virtual bool isAutomaticTextReplacementEnabled() OVERRIDE;
119     virtual void toggleAutomaticTextReplacement() OVERRIDE;
120     virtual bool isAutomaticSpellingCorrectionEnabled() OVERRIDE;
121     virtual void toggleAutomaticSpellingCorrection() OVERRIDE;
122 #endif
123
124 #if PLATFORM(GTK)
125     bool executePendingEditorCommands(WebCore::Frame*, Vector<WTF::String>, bool) OVERRIDE;
126     void getEditorCommandsForKeyEvent(const WebCore::KeyboardEvent*, Vector<WTF::String>&) OVERRIDE;
127     void setSelectionPrimaryClipboardIfNeeded(WebCore::Frame*) OVERRIDE;
128 #endif
129
130     TextCheckerClient* textChecker()  OVERRIDE { return this; }
131
132     virtual bool shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const OVERRIDE;
133     virtual void ignoreWordInSpellDocument(const String&) OVERRIDE;
134     virtual void learnWord(const String&) OVERRIDE;
135     virtual void checkSpellingOfString(const UChar*, int length, int* misspellingLocation, int* misspellingLength) OVERRIDE;
136     virtual String getAutoCorrectSuggestionForMisspelledWord(const String& misspelledWord) OVERRIDE;
137     virtual void checkGrammarOfString(const UChar*, int length, Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength) OVERRIDE;
138 #if PLATFORM(MAC) && !defined(BUILDING_ON_LEOPARD)
139     virtual void checkTextOfParagraph(const UChar* text, int length, WebCore::TextCheckingTypeMask checkingTypes, Vector<WebCore::TextCheckingResult>& results) OVERRIDE;
140 #endif
141     virtual void updateSpellingUIWithGrammarString(const String&, const WebCore::GrammarDetail&) OVERRIDE;
142     virtual void updateSpellingUIWithMisspelledWord(const String&) OVERRIDE;
143     virtual void showSpellingUI(bool show) OVERRIDE;
144     virtual bool spellingUIIsShowing() OVERRIDE;
145     virtual void getGuessesForWord(const String& word, const String& context, Vector<String>& guesses) OVERRIDE;
146     virtual void willSetInputMethodState() OVERRIDE;
147     virtual void setInputMethodState(bool enabled) OVERRIDE;
148     virtual void requestCheckingOfString(WTF::PassRefPtr<WebCore::TextCheckingRequest>) OVERRIDE;
149 #if PLATFORM(GTK)
150     virtual bool shouldShowUnicodeMenu() OVERRIDE;
151 #endif
152     WebPage* m_page;
153 };
154
155 } // namespace WebKit
156
157 #endif // WebEditorClient_h