EditorClient.h 7.24 KB
Newer Older
aliceli1's avatar
aliceli1 committed
1
/*
darin's avatar
darin committed
2
 * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
3
 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
aliceli1's avatar
aliceli1 committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */

27 28
#ifndef EditorClient_h
#define EditorClient_h
aliceli1's avatar
aliceli1 committed
29

bdakin's avatar
bdakin committed
30
#include "EditorInsertAction.h"
31
#include "FloatRect.h"
mjs's avatar
mjs committed
32
#include "TextAffinity.h"
33
#include "TextChecking.h"
34
#include "UndoStep.h"
ggaren's avatar
ggaren committed
35
#include <wtf/Forward.h>
36
#include <wtf/Vector.h>
darin's avatar
darin committed
37

aliceli1's avatar
aliceli1 committed
38
#if PLATFORM(MAC)
39 40 41
OBJC_CLASS NSAttributedString;
OBJC_CLASS NSString;
OBJC_CLASS NSURL;
42
#endif
bdakin's avatar
bdakin committed
43

44 45 46 47 48
#if PLATFORM(IOS)
OBJC_CLASS NSArray;
OBJC_CLASS NSDictionary;
#endif

aliceli1's avatar
aliceli1 committed
49 50
namespace WebCore {

51 52
class ArchiveResource;
class DocumentFragment;
53
class Editor;
mjs's avatar
mjs committed
54
class Element;
aliceli1's avatar
aliceli1 committed
55
class Frame;
thatcher's avatar
thatcher committed
56
class HTMLElement;
adele's avatar
adele committed
57
class KeyboardEvent;
aliceli1's avatar
aliceli1 committed
58
class Node;
andersca's avatar
andersca committed
59
class Range;
60
class SharedBuffer;
61
class StyleProperties;
62
class TextCheckerClient;
63
class VisibleSelection;
64 65
class VisiblePosition;

66 67
struct GrammarDetail;

ggaren's avatar
ggaren committed
68
class EditorClient {
aliceli1's avatar
aliceli1 committed
69
public:
ggaren's avatar
ggaren committed
70 71
    virtual ~EditorClient() {  }
    virtual void pageDestroyed() = 0;
72

ggaren's avatar
ggaren committed
73
    virtual bool shouldDeleteRange(Range*) = 0;
bdakin's avatar
bdakin committed
74
    virtual bool smartInsertDeleteEnabled() = 0; 
75
    virtual bool isSelectTrailingWhitespaceEnabled() = 0;
sullivan's avatar
sullivan committed
76
    virtual bool isContinuousSpellCheckingEnabled() = 0;
bdakin's avatar
bdakin committed
77
    virtual void toggleContinuousSpellChecking() = 0;
sullivan's avatar
sullivan committed
78
    virtual bool isGrammarCheckingEnabled() = 0;
bdakin's avatar
bdakin committed
79
    virtual void toggleGrammarChecking() = 0;
sullivan's avatar
sullivan committed
80
    virtual int spellCheckerDocumentTag() = 0;
thatcher's avatar
thatcher committed
81

andersca's avatar
andersca committed
82 83
    virtual bool shouldBeginEditing(Range*) = 0;
    virtual bool shouldEndEditing(Range*) = 0;
aliceli1's avatar
aliceli1 committed
84
    virtual bool shouldInsertNode(Node*, Range*, EditorInsertAction) = 0;
andersca@apple.com's avatar
andersca@apple.com committed
85
    virtual bool shouldInsertText(const String&, Range*, EditorInsertAction) = 0;
mjs's avatar
mjs committed
86 87
    virtual bool shouldChangeSelectedRange(Range* fromRange, Range* toRange, EAffinity, bool stillSelecting) = 0;
    
88
    virtual bool shouldApplyStyle(StyleProperties*, Range*) = 0;
justing's avatar
justing committed
89
    virtual bool shouldMoveRangeAfterDelete(Range*, Range*) = 0;
darin's avatar
darin committed
90

andersca's avatar
andersca committed
91
    virtual void didBeginEditing() = 0;
andersca's avatar
andersca committed
92
    virtual void respondToChangedContents() = 0;
93
    virtual void respondToChangedSelection(Frame*) = 0;
andersca's avatar
andersca committed
94
    virtual void didEndEditing() = 0;
95
    virtual void willWriteSelectionToPasteboard(Range*) = 0;
aliceli1's avatar
aliceli1 committed
96
    virtual void didWriteSelectionToPasteboard() = 0;
97
    virtual void getClientPasteboardDataForRange(Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<SharedBuffer>>& pasteboardData) = 0;
andersca's avatar
andersca committed
98
    
99 100
    virtual void registerUndoStep(PassRefPtr<UndoStep>) = 0;
    virtual void registerRedoStep(PassRefPtr<UndoStep>) = 0;
andersca's avatar
andersca committed
101 102
    virtual void clearUndoRedoOperations() = 0;

103 104
    virtual bool canCopyCut(Frame*, bool defaultValue) const = 0;
    virtual bool canPaste(Frame*, bool defaultValue) const = 0;
andersca's avatar
andersca committed
105 106 107 108 109
    virtual bool canUndo() const = 0;
    virtual bool canRedo() const = 0;
    
    virtual void undo() = 0;
    virtual void redo() = 0;
aliceli1's avatar
aliceli1 committed
110

ap@webkit.org's avatar
ap@webkit.org committed
111 112
    virtual void handleKeyboardEvent(KeyboardEvent*) = 0;
    virtual void handleInputMethodKeydown(KeyboardEvent*) = 0;
mjs's avatar
mjs committed
113 114 115 116 117 118 119
    
    virtual void textFieldDidBeginEditing(Element*) = 0;
    virtual void textFieldDidEndEditing(Element*) = 0;
    virtual void textDidChangeInTextField(Element*) = 0;
    virtual bool doTextFieldCommandFromEvent(Element*, KeyboardEvent*) = 0;
    virtual void textWillBeDeletedInTextField(Element*) = 0;
    virtual void textDidChangeInTextArea(Element*) = 0;
adele's avatar
adele committed
120

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
#if PLATFORM(IOS)
    virtual void suppressSelectionNotifications() = 0;
    virtual void restoreSelectionNotifications() = 0;
    virtual void startDelayingAndCoalescingContentChangeNotifications() = 0;
    virtual void stopDelayingAndCoalescingContentChangeNotifications() = 0;
    virtual void writeDataToPasteboard(NSDictionary*) = 0;
    virtual NSArray* supportedPasteboardTypesForCurrentSelection() = 0;
    virtual NSArray* readDataFromPasteboard(NSString* type, int index) = 0;
    virtual bool hasRichlyEditableSelection() = 0;
    virtual int getPasteboardItemsCount() = 0;
    virtual DocumentFragment* documentFragmentFromDelegate(int index) = 0;
    virtual bool performsTwoStepPaste(DocumentFragment*) = 0;
    virtual int pasteboardChangeCount() = 0;
#endif

aliceli1's avatar
aliceli1 committed
136
#if PLATFORM(MAC)
darin's avatar
darin committed
137
    virtual NSString* userVisibleString(NSURL*) = 0;
138
    virtual DocumentFragment* documentFragmentFromAttributedString(NSAttributedString*, Vector< RefPtr<ArchiveResource>>&) = 0;
139
    virtual void setInsertionPasteboard(const String& pasteboardName) = 0;
140 141
    virtual NSURL* canonicalizeURL(NSURL*) = 0;
    virtual NSURL* canonicalizeURLString(NSString*) = 0;
142 143
#endif

144
#if USE(APPKIT)
adele@apple.com's avatar
adele@apple.com committed
145 146 147
    virtual void uppercaseWord() = 0;
    virtual void lowercaseWord() = 0;
    virtual void capitalizeWord() = 0;
148
#endif
149

150
#if USE(AUTOMATIC_TEXT_REPLACEMENT)
adele@apple.com's avatar
adele@apple.com committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164
    virtual void showSubstitutionsPanel(bool show) = 0;
    virtual bool substitutionsPanelIsShowing() = 0;
    virtual void toggleSmartInsertDelete() = 0;
    virtual bool isAutomaticQuoteSubstitutionEnabled() = 0;
    virtual void toggleAutomaticQuoteSubstitution() = 0;
    virtual bool isAutomaticLinkDetectionEnabled() = 0;
    virtual void toggleAutomaticLinkDetection() = 0;
    virtual bool isAutomaticDashSubstitutionEnabled() = 0;
    virtual void toggleAutomaticDashSubstitution() = 0;
    virtual bool isAutomaticTextReplacementEnabled() = 0;
    virtual void toggleAutomaticTextReplacement() = 0;
    virtual bool isAutomaticSpellingCorrectionEnabled() = 0;
    virtual void toggleAutomaticSpellingCorrection() = 0;
#endif
165 166 167 168
    
#if ENABLE(DELETION_UI)
    virtual bool shouldShowDeleteInterface(HTMLElement*) = 0;
#endif
adele@apple.com's avatar
adele@apple.com committed
169

170 171 172 173
#if PLATFORM(GTK)
    virtual bool shouldShowUnicodeMenu() = 0;
#endif

174
    virtual TextCheckerClient* textChecker() = 0;
175

176
    virtual void updateSpellingUIWithGrammarString(const String&, const GrammarDetail& detail) = 0;
177 178 179
    virtual void updateSpellingUIWithMisspelledWord(const String&) = 0;
    virtual void showSpellingUI(bool show) = 0;
    virtual bool spellingUIIsShowing() = 0;
180
    virtual void willSetInputMethodState() = 0;
oliver's avatar
gtk:  
oliver committed
181
    virtual void setInputMethodState(bool enabled) = 0;
182 183 184 185

    // Support for global selections, used on platforms like the X Window System that treat
    // selection as a type of clipboard.
    virtual bool supportsGlobalSelection() { return false; }
aliceli1's avatar
aliceli1 committed
186 187 188 189
};

}

190
#endif // EditorClient_h