3c53a53807835497013d594403e676d75d6987be
[WebKit-https.git] / Source / WebCore / page / EditorClient.h
1 /*
2  * Copyright (C) 2006, 2007 Apple 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  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef EditorClient_h
28 #define EditorClient_h
29
30 #include "EditorInsertAction.h"
31 #include "FloatRect.h"
32 #include "TextAffinity.h"
33 #include "TextChecking.h"
34 #include "UndoStep.h"
35 #include <wtf/Forward.h>
36 #include <wtf/Vector.h>
37
38 #if PLATFORM(COCOA)
39 OBJC_CLASS NSAttributedString;
40 OBJC_CLASS NSString;
41 OBJC_CLASS NSURL;
42 #endif
43
44 #if PLATFORM(IOS)
45 OBJC_CLASS NSArray;
46 OBJC_CLASS NSDictionary;
47 #endif
48
49 namespace WebCore {
50
51 class ArchiveResource;
52 class DocumentFragment;
53 class Editor;
54 class Element;
55 class Frame;
56 class HTMLElement;
57 class KeyboardEvent;
58 class LayoutRect;
59 class Node;
60 class Range;
61 class SharedBuffer;
62 class StyleProperties;
63 class TextCheckerClient;
64 class VisibleSelection;
65 class VisiblePosition;
66
67 struct GapRects;
68 struct GrammarDetail;
69
70 class EditorClient {
71 public:
72     virtual ~EditorClient() {  }
73     virtual void pageDestroyed() = 0;
74
75     virtual bool shouldDeleteRange(Range*) = 0;
76     virtual bool smartInsertDeleteEnabled() = 0; 
77     virtual bool isSelectTrailingWhitespaceEnabled() = 0;
78     virtual bool isContinuousSpellCheckingEnabled() = 0;
79     virtual void toggleContinuousSpellChecking() = 0;
80     virtual bool isGrammarCheckingEnabled() = 0;
81     virtual void toggleGrammarChecking() = 0;
82     virtual int spellCheckerDocumentTag() = 0;
83
84     virtual bool shouldBeginEditing(Range*) = 0;
85     virtual bool shouldEndEditing(Range*) = 0;
86     virtual bool shouldInsertNode(Node*, Range*, EditorInsertAction) = 0;
87     virtual bool shouldInsertText(const String&, Range*, EditorInsertAction) = 0;
88     virtual bool shouldChangeSelectedRange(Range* fromRange, Range* toRange, EAffinity, bool stillSelecting) = 0;
89     
90     virtual bool shouldApplyStyle(StyleProperties*, Range*) = 0;
91     virtual void didApplyStyle() = 0;
92     virtual bool shouldMoveRangeAfterDelete(Range*, Range*) = 0;
93
94     virtual void didBeginEditing() = 0;
95     virtual void respondToChangedContents() = 0;
96     virtual void respondToChangedSelection(Frame*) = 0;
97     virtual void didChangeSelectionAndUpdateLayout() = 0;
98     virtual void didEndEditing() = 0;
99     virtual void willWriteSelectionToPasteboard(Range*) = 0;
100     virtual void didWriteSelectionToPasteboard() = 0;
101     virtual void getClientPasteboardDataForRange(Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<SharedBuffer>>& pasteboardData) = 0;
102
103     // Notify an input method that a composition was voluntarily discarded by WebCore, so that it could clean up too.
104     // This function is not called when a composition is closed per a request from an input method.
105     virtual void discardedComposition(Frame*) = 0;
106
107     virtual void registerUndoStep(PassRefPtr<UndoStep>) = 0;
108     virtual void registerRedoStep(PassRefPtr<UndoStep>) = 0;
109     virtual void clearUndoRedoOperations() = 0;
110
111     virtual bool canCopyCut(Frame*, bool defaultValue) const = 0;
112     virtual bool canPaste(Frame*, bool defaultValue) const = 0;
113     virtual bool canUndo() const = 0;
114     virtual bool canRedo() const = 0;
115     
116     virtual void undo() = 0;
117     virtual void redo() = 0;
118
119     virtual void handleKeyboardEvent(KeyboardEvent*) = 0;
120     virtual void handleInputMethodKeydown(KeyboardEvent*) = 0;
121     
122     virtual void textFieldDidBeginEditing(Element*) = 0;
123     virtual void textFieldDidEndEditing(Element*) = 0;
124     virtual void textDidChangeInTextField(Element*) = 0;
125     virtual bool doTextFieldCommandFromEvent(Element*, KeyboardEvent*) = 0;
126     virtual void textWillBeDeletedInTextField(Element*) = 0;
127     virtual void textDidChangeInTextArea(Element*) = 0;
128     virtual void overflowScrollPositionChanged() = 0;
129
130 #if PLATFORM(IOS)
131     virtual void startDelayingAndCoalescingContentChangeNotifications() = 0;
132     virtual void stopDelayingAndCoalescingContentChangeNotifications() = 0;
133     virtual void writeDataToPasteboard(NSDictionary*) = 0;
134     virtual NSArray* supportedPasteboardTypesForCurrentSelection() = 0;
135     virtual NSArray* readDataFromPasteboard(NSString* type, int index) = 0;
136     virtual bool hasRichlyEditableSelection() = 0;
137     virtual int getPasteboardItemsCount() = 0;
138     virtual DocumentFragment* documentFragmentFromDelegate(int index) = 0;
139     virtual bool performsTwoStepPaste(DocumentFragment*) = 0;
140     virtual int pasteboardChangeCount() = 0;
141 #endif
142
143 #if PLATFORM(COCOA)
144     virtual NSString* userVisibleString(NSURL*) = 0;
145     virtual DocumentFragment* documentFragmentFromAttributedString(NSAttributedString*, Vector< RefPtr<ArchiveResource>>&) = 0;
146     virtual void setInsertionPasteboard(const String& pasteboardName) = 0;
147     virtual NSURL* canonicalizeURL(NSURL*) = 0;
148     virtual NSURL* canonicalizeURLString(NSString*) = 0;
149 #endif
150
151 #if USE(APPKIT)
152     virtual void uppercaseWord() = 0;
153     virtual void lowercaseWord() = 0;
154     virtual void capitalizeWord() = 0;
155 #endif
156
157 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
158     virtual void showSubstitutionsPanel(bool show) = 0;
159     virtual bool substitutionsPanelIsShowing() = 0;
160     virtual void toggleSmartInsertDelete() = 0;
161     virtual bool isAutomaticQuoteSubstitutionEnabled() = 0;
162     virtual void toggleAutomaticQuoteSubstitution() = 0;
163     virtual bool isAutomaticLinkDetectionEnabled() = 0;
164     virtual void toggleAutomaticLinkDetection() = 0;
165     virtual bool isAutomaticDashSubstitutionEnabled() = 0;
166     virtual void toggleAutomaticDashSubstitution() = 0;
167     virtual bool isAutomaticTextReplacementEnabled() = 0;
168     virtual void toggleAutomaticTextReplacement() = 0;
169     virtual bool isAutomaticSpellingCorrectionEnabled() = 0;
170     virtual void toggleAutomaticSpellingCorrection() = 0;
171 #endif
172     
173 #if PLATFORM(GTK)
174     virtual bool shouldShowUnicodeMenu() = 0;
175 #endif
176
177     virtual TextCheckerClient* textChecker() = 0;
178
179     virtual void updateSpellingUIWithGrammarString(const String&, const GrammarDetail& detail) = 0;
180     virtual void updateSpellingUIWithMisspelledWord(const String&) = 0;
181     virtual void showSpellingUI(bool show) = 0;
182     virtual bool spellingUIIsShowing() = 0;
183     virtual void willSetInputMethodState() = 0;
184     virtual void setInputMethodState(bool enabled) = 0;
185
186     // Support for global selections, used on platforms like the X Window System that treat
187     // selection as a type of clipboard.
188     virtual bool supportsGlobalSelection() { return false; }
189 };
190
191 }
192
193 #endif // EditorClient_h