WinCairo build fails to link.
[WebKit-https.git] / Source / WebKit / chromium / src / EditorClientImpl.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef EditorClientImpl_h
32 #define EditorClientImpl_h
33
34 #include "EditorClient.h"
35 #include "TextCheckerClient.h"
36 #include "Timer.h"
37 #include <wtf/Deque.h>
38 #include <wtf/HashSet.h>
39
40 namespace WebCore {
41 class Frame;
42 class HTMLInputElement;
43 }
44
45 namespace WebKit {
46 class WebViewImpl;
47 class WebTextCheckingCompletionImpl;
48
49 class EditorClientImpl : public WebCore::EditorClient, public WebCore::TextCheckerClient {
50 public:
51     EditorClientImpl(WebViewImpl* webView);
52
53     virtual ~EditorClientImpl();
54     virtual void pageDestroyed();
55     virtual void frameWillDetachPage(WebCore::Frame*) OVERRIDE;
56
57     virtual bool smartInsertDeleteEnabled();
58     virtual bool isSelectTrailingWhitespaceEnabled();
59     virtual bool isContinuousSpellCheckingEnabled();
60     virtual void toggleContinuousSpellChecking();
61     virtual bool isGrammarCheckingEnabled();
62     virtual void toggleGrammarChecking();
63     virtual int spellCheckerDocumentTag();
64     virtual bool shouldBeginEditing(WebCore::Range*);
65     virtual bool shouldEndEditing(WebCore::Range*);
66     virtual bool shouldInsertNode(WebCore::Node*, WebCore::Range*, WebCore::EditorInsertAction);
67     virtual bool shouldInsertText(const WTF::String&, WebCore::Range*, WebCore::EditorInsertAction);
68     virtual bool shouldDeleteRange(WebCore::Range*);
69     virtual bool shouldChangeSelectedRange(WebCore::Range* fromRange, WebCore::Range* toRange,
70         WebCore::EAffinity, bool stillSelecting);
71     virtual bool shouldApplyStyle(WebCore::StylePropertySet*, WebCore::Range*);
72     virtual bool shouldMoveRangeAfterDelete(WebCore::Range*, WebCore::Range*);
73     virtual void didBeginEditing();
74     virtual void respondToChangedContents();
75     virtual void respondToChangedSelection(WebCore::Frame*);
76     virtual void didEndEditing();
77     virtual void willWriteSelectionToPasteboard(WebCore::Range*);
78     virtual void didWriteSelectionToPasteboard();
79     virtual void getClientPasteboardDataForRange(WebCore::Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<WebCore::SharedBuffer> >& pasteboardData);
80     virtual void didSetSelectionTypesForPasteboard();
81     virtual void registerUndoStep(PassRefPtr<WebCore::UndoStep>);
82     virtual void registerRedoStep(PassRefPtr<WebCore::UndoStep>);
83     virtual void clearUndoRedoOperations();
84     virtual bool canCopyCut(WebCore::Frame*, bool defaultValue) const;
85     virtual bool canPaste(WebCore::Frame*, bool defaultValue) const;
86     virtual bool canUndo() const;
87     virtual bool canRedo() const;
88     virtual void undo();
89     virtual void redo();
90     virtual const char* interpretKeyEvent(const WebCore::KeyboardEvent*);
91     virtual bool handleEditingKeyboardEvent(WebCore::KeyboardEvent*);
92     virtual void handleKeyboardEvent(WebCore::KeyboardEvent*);
93     virtual void handleInputMethodKeydown(WebCore::KeyboardEvent*);
94     virtual void textFieldDidBeginEditing(WebCore::Element*);
95     virtual void textFieldDidEndEditing(WebCore::Element*);
96     virtual void textDidChangeInTextField(WebCore::Element*);
97     virtual bool doTextFieldCommandFromEvent(WebCore::Element*, WebCore::KeyboardEvent*);
98     virtual void textWillBeDeletedInTextField(WebCore::Element*);
99     virtual void textDidChangeInTextArea(WebCore::Element*);
100     virtual bool shouldEraseMarkersAfterChangeSelection(WebCore::TextCheckingType) const;
101     virtual void ignoreWordInSpellDocument(const WTF::String&);
102     virtual void learnWord(const WTF::String&);
103     virtual void checkSpellingOfString(const UChar*, int length, int* misspellingLocation, int* misspellingLength);
104     virtual void checkGrammarOfString(const UChar*, int length, WTF::Vector<WebCore::GrammarDetail>&,
105         int* badGrammarLocation, int* badGrammarLength);
106     virtual void checkTextOfParagraph(const UChar*, int length, WebCore::TextCheckingTypeMask checkingTypes,
107         WTF::Vector<WebCore::TextCheckingResult>& results);
108     virtual WTF::String getAutoCorrectSuggestionForMisspelledWord(const WTF::String&);
109     virtual void updateSpellingUIWithGrammarString(const WTF::String&, const WebCore::GrammarDetail&);
110     virtual void updateSpellingUIWithMisspelledWord(const WTF::String&);
111     virtual void showSpellingUI(bool show);
112     virtual bool spellingUIIsShowing();
113     virtual void getGuessesForWord(const WTF::String& word, const WTF::String& context, WTF::Vector<WTF::String>& guesses);
114     virtual void willSetInputMethodState();
115     virtual void setInputMethodState(bool enabled);
116     virtual void requestCheckingOfString(WTF::PassRefPtr<WebCore::TextCheckingRequest>);
117     virtual bool supportsGlobalSelection() OVERRIDE;
118
119     virtual WebCore::TextCheckerClient* textChecker() { return this; }
120
121 private:
122     void modifySelection(WebCore::Frame*, WebCore::KeyboardEvent*);
123
124     // Returns whether or not the focused control needs spell-checking.
125     // Currently, this function just retrieves the focused node and determines
126     // whether or not it is a <textarea> element or an element whose
127     // contenteditable attribute is true.
128     // FIXME: Bug 740540: This code just implements the default behavior
129     // proposed in this issue. We should also retrieve "spellcheck" attributes
130     // for text fields and create a flag to over-write the default behavior.
131     bool shouldSpellcheckByDefault();
132
133     WebViewImpl* m_webView;
134     bool m_inRedo;
135
136     typedef Deque<RefPtr<WebCore::UndoStep> > UndoManagerStack;
137     UndoManagerStack m_undoStack;
138     UndoManagerStack m_redoStack;
139
140     // This flag is set to false if spell check for this editor is manually
141     // turned off. The default setting is SpellCheckAutomatic.
142     enum {
143         SpellCheckAutomatic,
144         SpellCheckForcedOn,
145         SpellCheckForcedOff
146     };
147     int m_spellCheckThisFieldStatus;
148 };
149
150 } // namespace WebKit
151
152 #endif