279474edda9f2639d9940119de410fcf23ae3667
[WebKit-https.git] / Source / WebKit / gtk / WebCoreSupport / EditorClientGtk.h
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2006 Zack Rusin <zack@kde.org>
4  * Copyright (C) 2006 Apple Computer, Inc.
5  * Copyright (C) 2010 Martin Robinson <mrobinson@webkit.org>
6  *
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26  * 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 EditorClientGtk_h
32 #define EditorClientGtk_h
33
34 #include "EditorClient.h"
35 #include "TextCheckerClient.h"
36
37 #include <wtf/Deque.h>
38 #include <wtf/Forward.h>
39 #include <wtf/gobject/GOwnPtr.h>
40 #include <wtf/gobject/GRefPtr.h>
41
42 typedef struct _WebKitWebView WebKitWebView;
43
44 namespace WebCore {
45 class Frame;
46 class KeyboardEvent;
47 }
48
49 namespace WebKit {
50
51 class EditorClient : public WebCore::EditorClient,  public WebCore::TextCheckerClient {
52     protected:
53         bool m_isInRedo;
54
55         WTF::Deque<WTF::RefPtr<WebCore::EditCommand> > undoStack;
56         WTF::Deque<WTF::RefPtr<WebCore::EditCommand> > redoStack;
57
58     public:
59         EditorClient(WebKitWebView*);
60         ~EditorClient();
61         WebKitWebView* webView() { return m_webView; }
62         bool treatContextCommitAsKeyEvent() { return m_treatContextCommitAsKeyEvent; }
63         bool preventNextCompositionCommit() { return m_preventNextCompositionCommit; }
64         void clearPendingComposition() { m_pendingComposition.set(0); }
65         bool hasPendingComposition() { return m_pendingComposition; }
66         void addPendingEditorCommand(const char* command) { m_pendingEditorCommands.append(command); }
67         void updatePendingComposition(const char*);
68         void generateEditorCommands(const WebCore::KeyboardEvent*);
69         bool executePendingEditorCommands(WebCore::Frame*, bool);
70
71         // from EditorClient
72         virtual void pageDestroyed();
73
74         virtual bool shouldDeleteRange(WebCore::Range*);
75         virtual bool shouldShowDeleteInterface(WebCore::HTMLElement*);
76         virtual bool smartInsertDeleteEnabled();
77         virtual bool isSelectTrailingWhitespaceEnabled();
78         virtual bool isContinuousSpellCheckingEnabled();
79         virtual void toggleContinuousSpellChecking();
80         virtual bool isGrammarCheckingEnabled();
81         virtual void toggleGrammarChecking();
82         virtual int spellCheckerDocumentTag();
83
84         virtual bool isEditable();
85
86         virtual bool shouldBeginEditing(WebCore::Range*);
87         virtual bool shouldEndEditing(WebCore::Range*);
88         virtual bool shouldInsertNode(WebCore::Node*, WebCore::Range*, WebCore::EditorInsertAction);
89         virtual bool shouldInsertText(const WTF::String&, WebCore::Range*, WebCore::EditorInsertAction);
90         virtual bool shouldChangeSelectedRange(WebCore::Range* fromRange, WebCore::Range* toRange, WebCore::EAffinity, bool stillSelecting);
91
92         virtual bool shouldApplyStyle(WebCore::CSSStyleDeclaration*, WebCore::Range*);
93
94         virtual bool shouldMoveRangeAfterDelete(WebCore::Range*, WebCore::Range*);
95
96         virtual void didBeginEditing();
97         virtual void respondToChangedContents();
98         virtual void respondToChangedSelection();
99         virtual void didEndEditing();
100         virtual void didWriteSelectionToPasteboard();
101         virtual void didSetSelectionTypesForPasteboard();
102
103         virtual void registerCommandForUndo(WTF::PassRefPtr<WebCore::EditCommand>);
104         virtual void registerCommandForRedo(WTF::PassRefPtr<WebCore::EditCommand>);
105         virtual void clearUndoRedoOperations();
106
107         virtual bool canCopyCut(bool defaultValue) const;
108         virtual bool canPaste(bool defaultValue) const;
109         virtual bool canUndo() const;
110         virtual bool canRedo() const;
111
112         virtual void undo();
113         virtual void redo();
114
115         virtual void handleKeyboardEvent(WebCore::KeyboardEvent*);
116         virtual void handleInputMethodKeydown(WebCore::KeyboardEvent*);
117         virtual void handleInputMethodMousePress();
118
119         virtual void textFieldDidBeginEditing(WebCore::Element*);
120         virtual void textFieldDidEndEditing(WebCore::Element*);
121         virtual void textDidChangeInTextField(WebCore::Element*);
122         virtual bool doTextFieldCommandFromEvent(WebCore::Element*, WebCore::KeyboardEvent*);
123         virtual void textWillBeDeletedInTextField(WebCore::Element*);
124         virtual void textDidChangeInTextArea(WebCore::Element*);
125
126         virtual WebCore::TextCheckerClient* textChecker() { return this; }
127
128         virtual void ignoreWordInSpellDocument(const WTF::String&);
129         virtual void learnWord(const WTF::String&);
130         virtual void checkSpellingOfString(const UChar*, int length, int* misspellingLocation, int* misspellingLength);
131         virtual WTF::String getAutoCorrectSuggestionForMisspelledWord(const WTF::String&);
132         virtual void checkGrammarOfString(const UChar*, int length, WTF::Vector<WebCore::GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength);
133         virtual void updateSpellingUIWithGrammarString(const WTF::String&, const WebCore::GrammarDetail&);
134         virtual void updateSpellingUIWithMisspelledWord(const WTF::String&);
135         virtual void showSpellingUI(bool show);
136         virtual bool spellingUIIsShowing();
137         virtual void getGuessesForWord(const WTF::String& word, const WTF::String& context, WTF::Vector<WTF::String>& guesses);
138         virtual void willSetInputMethodState();
139         virtual void setInputMethodState(bool enabled);
140         virtual void requestCheckingOfString(WebCore::SpellChecker*, int, const WTF::String&) {}
141
142     private:
143         WebKitWebView* m_webView;
144         bool m_preventNextCompositionCommit;
145         bool m_treatContextCommitAsKeyEvent;
146         GOwnPtr<gchar> m_pendingComposition;
147         Vector<const char*> m_pendingEditorCommands;
148         GRefPtr<GtkWidget> m_nativeWidget;
149     };
150 }
151
152 #endif
153
154 // vim: ts=4 sw=4 et