Add support for using the current text selection as the find string on iOS
[WebKit-https.git] / Source / WebCore / page / EditorClient.h
1 /*
2  * Copyright (C) 2006-2016 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 #pragma once
28
29 #include "EditorInsertAction.h"
30 #include "SerializedAttachmentData.h"
31 #include "TextAffinity.h"
32 #include "TextChecking.h"
33 #include "UndoStep.h"
34 #include <wtf/Forward.h>
35 #include <wtf/Vector.h>
36
37 namespace WebCore {
38
39 class DocumentFragment;
40 class Element;
41 class Frame;
42 class KeyboardEvent;
43 class Node;
44 class Range;
45 class SharedBuffer;
46 class StyleProperties;
47 class TextCheckerClient;
48 class VisibleSelection;
49
50 struct GapRects;
51 struct GrammarDetail;
52
53 class EditorClient {
54 public:
55     virtual ~EditorClient() = default;
56
57     virtual bool shouldDeleteRange(Range*) = 0;
58     virtual bool smartInsertDeleteEnabled() = 0; 
59     virtual bool isSelectTrailingWhitespaceEnabled() const = 0;
60     virtual bool isContinuousSpellCheckingEnabled() = 0;
61     virtual void toggleContinuousSpellChecking() = 0;
62     virtual bool isGrammarCheckingEnabled() = 0;
63     virtual void toggleGrammarChecking() = 0;
64     virtual int spellCheckerDocumentTag() = 0;
65
66     virtual bool shouldBeginEditing(Range*) = 0;
67     virtual bool shouldEndEditing(Range*) = 0;
68     virtual bool shouldInsertNode(Node*, Range*, EditorInsertAction) = 0;
69     virtual bool shouldInsertText(const String&, Range*, EditorInsertAction) = 0;
70     virtual bool shouldChangeSelectedRange(Range* fromRange, Range* toRange, EAffinity, bool stillSelecting) = 0;
71     
72     virtual bool shouldApplyStyle(StyleProperties*, Range*) = 0;
73     virtual void didApplyStyle() = 0;
74     virtual bool shouldMoveRangeAfterDelete(Range*, Range*) = 0;
75
76 #if ENABLE(ATTACHMENT_ELEMENT)
77     virtual void registerAttachmentIdentifier(const String& /* identifier */, const String& /* contentType */, const String& /* preferredFileName */, Ref<SharedBuffer>&&) { }
78     virtual void registerAttachmentIdentifier(const String& /* identifier */, const String& /* contentType */, const String& /* filePath */) { }
79     virtual void registerAttachments(Vector<SerializedAttachmentData>&&) { }
80     virtual void registerAttachmentIdentifier(const String& /* identifier */) { }
81     virtual void cloneAttachmentData(const String& /* fromIdentifier */, const String& /* toIdentifier */) { }
82     virtual void didInsertAttachmentWithIdentifier(const String& /* identifier */, const String& /* source */, bool /* hasEnclosingImage */) { }
83     virtual void didRemoveAttachmentWithIdentifier(const String&) { }
84     virtual bool supportsClientSideAttachmentData() const { return false; }
85     virtual Vector<SerializedAttachmentData> serializedAttachmentDataForIdentifiers(const Vector<String>&) { return { }; }
86 #endif
87
88     virtual void didBeginEditing() = 0;
89     virtual void respondToChangedContents() = 0;
90     virtual void respondToChangedSelection(Frame*) = 0;
91     virtual void didEndUserTriggeredSelectionChanges() = 0;
92     virtual void updateEditorStateAfterLayoutIfEditabilityChanged() = 0;
93     virtual void didEndEditing() = 0;
94     virtual void willWriteSelectionToPasteboard(Range*) = 0;
95     virtual void didWriteSelectionToPasteboard() = 0;
96     virtual void getClientPasteboardDataForRange(Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<SharedBuffer>>& pasteboardData) = 0;
97     virtual String replacementURLForResource(Ref<SharedBuffer>&& resourceData, const String& mimeType) = 0;
98     virtual void requestCandidatesForSelection(const VisibleSelection&) { }
99     virtual void handleAcceptedCandidateWithSoftSpaces(TextCheckingResult) { }
100
101     // Notify an input method that a composition was voluntarily discarded by WebCore, so that it could clean up too.
102     // This function is not called when a composition is closed per a request from an input method.
103     virtual void discardedComposition(Frame*) = 0;
104     virtual void canceledComposition() = 0;
105     virtual void didUpdateComposition() = 0;
106
107     virtual void registerUndoStep(UndoStep&) = 0;
108     virtual void registerRedoStep(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_FAMILY)
131     virtual void startDelayingAndCoalescingContentChangeNotifications() = 0;
132     virtual void stopDelayingAndCoalescingContentChangeNotifications() = 0;
133     virtual bool hasRichlyEditableSelection() = 0;
134     virtual int getPasteboardItemsCount() = 0;
135     virtual RefPtr<DocumentFragment> documentFragmentFromDelegate(int index) = 0;
136     virtual bool performsTwoStepPaste(DocumentFragment*) = 0;
137     virtual void updateStringForFind(const String&) = 0;
138 #endif
139
140 #if PLATFORM(COCOA)
141     virtual void setInsertionPasteboard(const String& pasteboardName) = 0;
142 #endif
143
144 #if USE(APPKIT)
145     virtual void uppercaseWord() = 0;
146     virtual void lowercaseWord() = 0;
147     virtual void capitalizeWord() = 0;
148 #endif
149
150 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
151     virtual void showSubstitutionsPanel(bool show) = 0;
152     virtual bool substitutionsPanelIsShowing() = 0;
153     virtual void toggleSmartInsertDelete() = 0;
154     virtual bool isAutomaticQuoteSubstitutionEnabled() = 0;
155     virtual void toggleAutomaticQuoteSubstitution() = 0;
156     virtual bool isAutomaticLinkDetectionEnabled() = 0;
157     virtual void toggleAutomaticLinkDetection() = 0;
158     virtual bool isAutomaticDashSubstitutionEnabled() = 0;
159     virtual void toggleAutomaticDashSubstitution() = 0;
160     virtual bool isAutomaticTextReplacementEnabled() = 0;
161     virtual void toggleAutomaticTextReplacement() = 0;
162     virtual bool isAutomaticSpellingCorrectionEnabled() = 0;
163     virtual void toggleAutomaticSpellingCorrection() = 0;
164 #endif
165     
166 #if PLATFORM(GTK)
167     virtual bool shouldShowUnicodeMenu() = 0;
168 #endif
169
170     virtual TextCheckerClient* textChecker() = 0;
171
172     virtual void updateSpellingUIWithGrammarString(const String&, const GrammarDetail& detail) = 0;
173     virtual void updateSpellingUIWithMisspelledWord(const String&) = 0;
174     virtual void showSpellingUI(bool show) = 0;
175     virtual bool spellingUIIsShowing() = 0;
176     virtual void willSetInputMethodState() = 0;
177     virtual void setInputMethodState(bool enabled) = 0;
178
179     // Support for global selections, used on platforms like the X Window System that treat
180     // selection as a type of clipboard.
181     virtual bool supportsGlobalSelection() { return false; }
182
183     virtual bool performTwoStepDrop(DocumentFragment&, Range& destination, bool isMove) = 0;
184 };
185
186 }