Use "= default" to denote default constructor or destructor
[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 "TextAffinity.h"
31 #include "TextChecking.h"
32 #include "UndoStep.h"
33 #include <wtf/Forward.h>
34 #include <wtf/Vector.h>
35
36 namespace WebCore {
37
38 class DocumentFragment;
39 class Element;
40 class Frame;
41 class KeyboardEvent;
42 class Node;
43 class Range;
44 class SharedBuffer;
45 class StyleProperties;
46 class TextCheckerClient;
47 class VisibleSelection;
48
49 struct GapRects;
50 struct GrammarDetail;
51
52 class EditorClient {
53 public:
54     virtual ~EditorClient() = default;
55
56     virtual bool shouldDeleteRange(Range*) = 0;
57     virtual bool smartInsertDeleteEnabled() = 0; 
58     virtual bool isSelectTrailingWhitespaceEnabled() const = 0;
59     virtual bool isContinuousSpellCheckingEnabled() = 0;
60     virtual void toggleContinuousSpellChecking() = 0;
61     virtual bool isGrammarCheckingEnabled() = 0;
62     virtual void toggleGrammarChecking() = 0;
63     virtual int spellCheckerDocumentTag() = 0;
64
65     virtual bool shouldBeginEditing(Range*) = 0;
66     virtual bool shouldEndEditing(Range*) = 0;
67     virtual bool shouldInsertNode(Node*, Range*, EditorInsertAction) = 0;
68     virtual bool shouldInsertText(const String&, Range*, EditorInsertAction) = 0;
69     virtual bool shouldChangeSelectedRange(Range* fromRange, Range* toRange, EAffinity, bool stillSelecting) = 0;
70     
71     virtual bool shouldApplyStyle(StyleProperties*, Range*) = 0;
72     virtual void didApplyStyle() = 0;
73     virtual bool shouldMoveRangeAfterDelete(Range*, Range*) = 0;
74
75     virtual void didBeginEditing() = 0;
76     virtual void respondToChangedContents() = 0;
77     virtual void respondToChangedSelection(Frame*) = 0;
78     virtual void didEndUserTriggeredSelectionChanges() = 0;
79     virtual void updateEditorStateAfterLayoutIfEditabilityChanged() = 0;
80     virtual void didEndEditing() = 0;
81     virtual void willWriteSelectionToPasteboard(Range*) = 0;
82     virtual void didWriteSelectionToPasteboard() = 0;
83     virtual void getClientPasteboardDataForRange(Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<SharedBuffer>>& pasteboardData) = 0;
84     virtual void requestCandidatesForSelection(const VisibleSelection&) { }
85     virtual void handleAcceptedCandidateWithSoftSpaces(TextCheckingResult) { }
86
87     // Notify an input method that a composition was voluntarily discarded by WebCore, so that it could clean up too.
88     // This function is not called when a composition is closed per a request from an input method.
89     virtual void discardedComposition(Frame*) = 0;
90     virtual void canceledComposition() = 0;
91     virtual void didUpdateComposition() = 0;
92
93     virtual void registerUndoStep(UndoStep&) = 0;
94     virtual void registerRedoStep(UndoStep&) = 0;
95     virtual void clearUndoRedoOperations() = 0;
96
97     virtual bool canCopyCut(Frame*, bool defaultValue) const = 0;
98     virtual bool canPaste(Frame*, bool defaultValue) const = 0;
99     virtual bool canUndo() const = 0;
100     virtual bool canRedo() const = 0;
101     
102     virtual void undo() = 0;
103     virtual void redo() = 0;
104
105     virtual void handleKeyboardEvent(KeyboardEvent*) = 0;
106     virtual void handleInputMethodKeydown(KeyboardEvent*) = 0;
107     
108     virtual void textFieldDidBeginEditing(Element*) = 0;
109     virtual void textFieldDidEndEditing(Element*) = 0;
110     virtual void textDidChangeInTextField(Element*) = 0;
111     virtual bool doTextFieldCommandFromEvent(Element*, KeyboardEvent*) = 0;
112     virtual void textWillBeDeletedInTextField(Element*) = 0;
113     virtual void textDidChangeInTextArea(Element*) = 0;
114     virtual void overflowScrollPositionChanged() = 0;
115
116 #if PLATFORM(IOS)
117     virtual void startDelayingAndCoalescingContentChangeNotifications() = 0;
118     virtual void stopDelayingAndCoalescingContentChangeNotifications() = 0;
119     virtual bool hasRichlyEditableSelection() = 0;
120     virtual int getPasteboardItemsCount() = 0;
121     virtual RefPtr<DocumentFragment> documentFragmentFromDelegate(int index) = 0;
122     virtual bool performsTwoStepPaste(DocumentFragment*) = 0;
123 #endif
124
125 #if PLATFORM(COCOA)
126     virtual void setInsertionPasteboard(const String& pasteboardName) = 0;
127 #endif
128
129 #if USE(APPKIT)
130     virtual void uppercaseWord() = 0;
131     virtual void lowercaseWord() = 0;
132     virtual void capitalizeWord() = 0;
133 #endif
134
135 #if USE(AUTOMATIC_TEXT_REPLACEMENT)
136     virtual void showSubstitutionsPanel(bool show) = 0;
137     virtual bool substitutionsPanelIsShowing() = 0;
138     virtual void toggleSmartInsertDelete() = 0;
139     virtual bool isAutomaticQuoteSubstitutionEnabled() = 0;
140     virtual void toggleAutomaticQuoteSubstitution() = 0;
141     virtual bool isAutomaticLinkDetectionEnabled() = 0;
142     virtual void toggleAutomaticLinkDetection() = 0;
143     virtual bool isAutomaticDashSubstitutionEnabled() = 0;
144     virtual void toggleAutomaticDashSubstitution() = 0;
145     virtual bool isAutomaticTextReplacementEnabled() = 0;
146     virtual void toggleAutomaticTextReplacement() = 0;
147     virtual bool isAutomaticSpellingCorrectionEnabled() = 0;
148     virtual void toggleAutomaticSpellingCorrection() = 0;
149 #endif
150     
151 #if PLATFORM(GTK)
152     virtual bool shouldShowUnicodeMenu() = 0;
153 #endif
154
155     virtual TextCheckerClient* textChecker() = 0;
156
157     virtual void updateSpellingUIWithGrammarString(const String&, const GrammarDetail& detail) = 0;
158     virtual void updateSpellingUIWithMisspelledWord(const String&) = 0;
159     virtual void showSpellingUI(bool show) = 0;
160     virtual bool spellingUIIsShowing() = 0;
161     virtual void willSetInputMethodState() = 0;
162     virtual void setInputMethodState(bool enabled) = 0;
163
164     // Support for global selections, used on platforms like the X Window System that treat
165     // selection as a type of clipboard.
166     virtual bool supportsGlobalSelection() { return false; }
167
168     virtual bool performTwoStepDrop(DocumentFragment&, Range& destination, bool isMove) = 0;
169 };
170
171 }