c96071c77e24fe5a12eaf2ea16d78818be7a3dc3
[WebKit-https.git] / Source / WebKit / mac / WebCoreSupport / WebEditorClient.h
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
3  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #import <WebCore/EditorClient.h>
31 #import <WebCore/TextCheckerClient.h>
32 #import <wtf/Forward.h>
33 #import <wtf/RetainPtr.h>
34 #import <wtf/Vector.h>
35
36 @class WebView;
37 @class WebEditorUndoTarget;
38
39 class WebEditorClient : public WebCore::EditorClient, public WebCore::TextCheckerClient {
40 public:
41     WebEditorClient(WebView *);
42     virtual ~WebEditorClient();
43     virtual void pageDestroyed() OVERRIDE;
44
45     virtual bool isGrammarCheckingEnabled() OVERRIDE;
46     virtual void toggleGrammarChecking() OVERRIDE;
47     virtual bool isContinuousSpellCheckingEnabled() OVERRIDE;
48     virtual void toggleContinuousSpellChecking() OVERRIDE;
49     virtual int spellCheckerDocumentTag() OVERRIDE;
50
51     virtual bool smartInsertDeleteEnabled() OVERRIDE;
52     virtual bool isSelectTrailingWhitespaceEnabled() OVERRIDE;
53
54     virtual bool shouldDeleteRange(WebCore::Range*) OVERRIDE;
55
56     virtual bool shouldBeginEditing(WebCore::Range*) OVERRIDE;
57     virtual bool shouldEndEditing(WebCore::Range*) OVERRIDE;
58     virtual bool shouldInsertNode(WebCore::Node*, WebCore::Range*, WebCore::EditorInsertAction) OVERRIDE;
59     virtual bool shouldInsertText(const WTF::String&, WebCore::Range*, WebCore::EditorInsertAction) OVERRIDE;
60     virtual bool shouldChangeSelectedRange(WebCore::Range* fromRange, WebCore::Range* toRange, WebCore::EAffinity, bool stillSelecting) OVERRIDE;
61
62     virtual bool shouldApplyStyle(WebCore::StyleProperties*, WebCore::Range*) OVERRIDE;
63     
64     virtual bool shouldMoveRangeAfterDelete(WebCore::Range*, WebCore::Range* rangeToBeReplaced) OVERRIDE;
65
66     virtual void didBeginEditing() OVERRIDE;
67     virtual void didEndEditing() OVERRIDE;
68     virtual void willWriteSelectionToPasteboard(WebCore::Range*) OVERRIDE;
69     virtual void didWriteSelectionToPasteboard() OVERRIDE;
70     virtual void getClientPasteboardDataForRange(WebCore::Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<WebCore::SharedBuffer>>& pasteboardData) OVERRIDE;
71
72     virtual NSString* userVisibleString(NSURL *) OVERRIDE;
73     virtual WebCore::DocumentFragment* documentFragmentFromAttributedString(NSAttributedString *, Vector< RefPtr<WebCore::ArchiveResource>>&) OVERRIDE;
74     virtual void setInsertionPasteboard(const String&) OVERRIDE;
75     virtual NSURL* canonicalizeURL(NSURL*) OVERRIDE;
76     virtual NSURL* canonicalizeURLString(NSString*) OVERRIDE;
77     
78 #if USE(APPKIT)
79     virtual void uppercaseWord() OVERRIDE;
80     virtual void lowercaseWord() OVERRIDE;
81     virtual void capitalizeWord() OVERRIDE;
82 #endif
83
84 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
85     virtual void showSubstitutionsPanel(bool show) OVERRIDE;
86     virtual bool substitutionsPanelIsShowing() OVERRIDE;
87     virtual void toggleSmartInsertDelete() OVERRIDE;
88     virtual bool isAutomaticQuoteSubstitutionEnabled() OVERRIDE;
89     virtual void toggleAutomaticQuoteSubstitution() OVERRIDE;
90     virtual bool isAutomaticLinkDetectionEnabled() OVERRIDE;
91     virtual void toggleAutomaticLinkDetection() OVERRIDE;
92     virtual bool isAutomaticDashSubstitutionEnabled() OVERRIDE;
93     virtual void toggleAutomaticDashSubstitution() OVERRIDE;
94     virtual bool isAutomaticTextReplacementEnabled() OVERRIDE;
95     virtual void toggleAutomaticTextReplacement() OVERRIDE;
96     virtual bool isAutomaticSpellingCorrectionEnabled() OVERRIDE;
97     virtual void toggleAutomaticSpellingCorrection() OVERRIDE;
98 #endif
99
100 #if ENABLE(DELETION_UI)
101     virtual bool shouldShowDeleteInterface(WebCore::HTMLElement*) OVERRIDE;
102 #endif
103
104     TextCheckerClient* textChecker() OVERRIDE { return this; }
105
106     virtual void respondToChangedContents() OVERRIDE;
107     virtual void respondToChangedSelection(WebCore::Frame*) OVERRIDE;
108
109     virtual void registerUndoStep(PassRefPtr<WebCore::UndoStep>) OVERRIDE;
110     virtual void registerRedoStep(PassRefPtr<WebCore::UndoStep>) OVERRIDE;
111     virtual void clearUndoRedoOperations() OVERRIDE;
112
113     virtual bool canCopyCut(WebCore::Frame*, bool defaultValue) const OVERRIDE;
114     virtual bool canPaste(WebCore::Frame*, bool defaultValue) const OVERRIDE;
115     virtual bool canUndo() const OVERRIDE;
116     virtual bool canRedo() const OVERRIDE;
117     
118     virtual void undo() OVERRIDE;
119     virtual void redo() OVERRIDE;
120     
121     virtual void handleKeyboardEvent(WebCore::KeyboardEvent*) OVERRIDE;
122     virtual void handleInputMethodKeydown(WebCore::KeyboardEvent*) OVERRIDE;
123
124     virtual void textFieldDidBeginEditing(WebCore::Element*) OVERRIDE;
125     virtual void textFieldDidEndEditing(WebCore::Element*) OVERRIDE;
126     virtual void textDidChangeInTextField(WebCore::Element*) OVERRIDE;
127     virtual bool doTextFieldCommandFromEvent(WebCore::Element*, WebCore::KeyboardEvent*) OVERRIDE;
128     virtual void textWillBeDeletedInTextField(WebCore::Element*) OVERRIDE;
129     virtual void textDidChangeInTextArea(WebCore::Element*) OVERRIDE;
130     
131     virtual bool shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const OVERRIDE;
132     virtual void ignoreWordInSpellDocument(const WTF::String&) OVERRIDE;
133     virtual void learnWord(const WTF::String&) OVERRIDE;
134     virtual void checkSpellingOfString(const UChar*, int length, int* misspellingLocation, int* misspellingLength) OVERRIDE;
135     virtual WTF::String getAutoCorrectSuggestionForMisspelledWord(const WTF::String&) OVERRIDE;
136     virtual void checkGrammarOfString(const UChar*, int length, WTF::Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength) OVERRIDE;
137     virtual void checkTextOfParagraph(const UChar* text, int length, WebCore::TextCheckingTypeMask checkingTypes, WTF::Vector<WebCore::TextCheckingResult>& results) OVERRIDE;
138     virtual void updateSpellingUIWithGrammarString(const WTF::String&, const WebCore::GrammarDetail&) OVERRIDE;
139     virtual void updateSpellingUIWithMisspelledWord(const WTF::String&) OVERRIDE;
140     virtual void showSpellingUI(bool show) OVERRIDE;
141     virtual bool spellingUIIsShowing() OVERRIDE;
142     virtual void getGuessesForWord(const WTF::String& word, const WTF::String& context, WTF::Vector<WTF::String>& guesses) OVERRIDE;
143     virtual void willSetInputMethodState() OVERRIDE;
144     virtual void setInputMethodState(bool enabled) OVERRIDE;
145     virtual void requestCheckingOfString(PassRefPtr<WebCore::TextCheckingRequest>) OVERRIDE;
146
147     void didCheckSucceed(int sequence, NSArray* results);
148
149 private:
150     void registerUndoOrRedoStep(PassRefPtr<WebCore::UndoStep>, bool isRedo);
151     WebEditorClient();
152
153     WebView *m_webView;
154     RetainPtr<WebEditorUndoTarget> m_undoTarget;
155     bool m_haveUndoRedoOperations;
156     RefPtr<WebCore::TextCheckingRequest> m_textCheckingRequest;
157 };