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 COMPUTER, 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 COMPUTER, 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(MAC) 39OBJC_CLASS NSAttributedString; 40OBJC_CLASS NSString; 41OBJC_CLASS NSURL; 42#endif 43 44namespace WebCore { 45 46class ArchiveResource; 47class DocumentFragment; 48class Editor; 49class Element; 50class Frame; 51class HTMLElement; 52class KeyboardEvent; 53class Node; 54class Range; 55class SharedBuffer; 56class SpellChecker; 57class StylePropertySet; 58class TextCheckerClient; 59class VisibleSelection; 60class VisiblePosition; 61 62struct GrammarDetail; 63 64class EditorClient { 65public: 66 virtual ~EditorClient() { } 67 virtual void pageDestroyed() = 0; 68 virtual void frameWillDetachPage(Frame*) = 0; 69 70 virtual bool shouldDeleteRange(Range*) = 0; 71 virtual bool smartInsertDeleteEnabled() = 0; 72 virtual bool isSelectTrailingWhitespaceEnabled() = 0; 73 virtual bool isContinuousSpellCheckingEnabled() = 0; 74 virtual void toggleContinuousSpellChecking() = 0; 75 virtual bool isGrammarCheckingEnabled() = 0; 76 virtual void toggleGrammarChecking() = 0; 77 virtual int spellCheckerDocumentTag() = 0; 78 79 virtual bool shouldBeginEditing(Range*) = 0; 80 virtual bool shouldEndEditing(Range*) = 0; 81 virtual bool shouldInsertNode(Node*, Range*, EditorInsertAction) = 0; 82 virtual bool shouldInsertText(const String&, Range*, EditorInsertAction) = 0; 83 virtual bool shouldChangeSelectedRange(Range* fromRange, Range* toRange, EAffinity, bool stillSelecting) = 0; 84 85 virtual bool shouldApplyStyle(StylePropertySet*, Range*) = 0; 86 virtual bool shouldMoveRangeAfterDelete(Range*, Range*) = 0; 87 88 virtual void didBeginEditing() = 0; 89 virtual void respondToChangedContents() = 0; 90 virtual void respondToChangedSelection(Frame*) = 0; 91 virtual void didEndEditing() = 0; 92 virtual void willWriteSelectionToPasteboard(Range*) = 0; 93 virtual void didWriteSelectionToPasteboard() = 0; 94 virtual void getClientPasteboardDataForRange(Range*, Vector<String>& pasteboardTypes, Vector<RefPtr<SharedBuffer> >& pasteboardData) = 0; 95 virtual void didSetSelectionTypesForPasteboard() = 0; 96 97 virtual void registerUndoStep(PassRefPtr<UndoStep>) = 0; 98 virtual void registerRedoStep(PassRefPtr<UndoStep>) = 0; 99 virtual void clearUndoRedoOperations() = 0; 100 101 virtual bool canCopyCut(Frame*, bool defaultValue) const = 0; 102 virtual bool canPaste(Frame*, bool defaultValue) const = 0; 103 virtual bool canUndo() const = 0; 104 virtual bool canRedo() const = 0; 105 106 virtual void undo() = 0; 107 virtual void redo() = 0; 108 109 virtual void handleKeyboardEvent(KeyboardEvent*) = 0; 110 virtual void handleInputMethodKeydown(KeyboardEvent*) = 0; 111 112 virtual void textFieldDidBeginEditing(Element*) = 0; 113 virtual void textFieldDidEndEditing(Element*) = 0; 114 virtual void textDidChangeInTextField(Element*) = 0; 115 virtual bool doTextFieldCommandFromEvent(Element*, KeyboardEvent*) = 0; 116 virtual void textWillBeDeletedInTextField(Element*) = 0; 117 virtual void textDidChangeInTextArea(Element*) = 0; 118 119#if PLATFORM(MAC) 120 virtual NSString* userVisibleString(NSURL*) = 0; 121 virtual DocumentFragment* documentFragmentFromAttributedString(NSAttributedString*, Vector< RefPtr<ArchiveResource> >&) = 0; 122 virtual void setInsertionPasteboard(const String& pasteboardName) = 0; 123 virtual NSURL* canonicalizeURL(NSURL*) = 0; 124 virtual NSURL* canonicalizeURLString(NSString*) = 0; 125#endif 126 127#if USE(APPKIT) 128 virtual void uppercaseWord() = 0; 129 virtual void lowercaseWord() = 0; 130 virtual void capitalizeWord() = 0; 131#endif 132 133#if USE(AUTOMATIC_TEXT_REPLACEMENT) 134 virtual void showSubstitutionsPanel(bool show) = 0; 135 virtual bool substitutionsPanelIsShowing() = 0; 136 virtual void toggleSmartInsertDelete() = 0; 137 virtual bool isAutomaticQuoteSubstitutionEnabled() = 0; 138 virtual void toggleAutomaticQuoteSubstitution() = 0; 139 virtual bool isAutomaticLinkDetectionEnabled() = 0; 140 virtual void toggleAutomaticLinkDetection() = 0; 141 virtual bool isAutomaticDashSubstitutionEnabled() = 0; 142 virtual void toggleAutomaticDashSubstitution() = 0; 143 virtual bool isAutomaticTextReplacementEnabled() = 0; 144 virtual void toggleAutomaticTextReplacement() = 0; 145 virtual bool isAutomaticSpellingCorrectionEnabled() = 0; 146 virtual void toggleAutomaticSpellingCorrection() = 0; 147#endif 148 149#if ENABLE(DELETION_UI) 150 virtual bool shouldShowDeleteInterface(HTMLElement*) = 0; 151#endif 152 153#if PLATFORM(GTK) 154 virtual bool shouldShowUnicodeMenu() = 0; 155#endif 156 157 virtual TextCheckerClient* textChecker() = 0; 158 159 virtual void updateSpellingUIWithGrammarString(const String&, const GrammarDetail& detail) = 0; 160 virtual void updateSpellingUIWithMisspelledWord(const String&) = 0; 161 virtual void showSpellingUI(bool show) = 0; 162 virtual bool spellingUIIsShowing() = 0; 163 virtual void willSetInputMethodState() = 0; 164 virtual void setInputMethodState(bool enabled) = 0; 165 166 // Support for global selections, used on platforms like the X Window System that treat 167 // selection as a type of clipboard. 168 virtual bool supportsGlobalSelection() { return false; } 169}; 170 171} 172 173#endif // EditorClient_h 174