code.vuplus.com Git - vuplus_webkit/blob - 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 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 "SpellingCorrectionController.h"
  31 #include "EditorInsertAction.h"
  32 #include "FloatRect.h"
  33 #include "TextAffinity.h"
  34 #include <wtf/Forward.h>
  35 #include <wtf/Vector.h>
  36
  37 #if PLATFORM(MAC)
  38 #ifdef __OBJC__
  39 @class NSAttributedString;
  40 @class NSPasteboard;
  41 @class NSString;
  42 @class NSURL;
  43 #else
  44 class NSAttributedString;
  45 class NSPasteboard;
  46 class NSString;
  47 class NSURL;
  48 #endif
  49 #endif
  50
  51 namespace WebCore {
  52
  53 class ArchiveResource;
  54 class CSSStyleDeclaration;
  55 class DocumentFragment;
  56 class EditCommand;
  57 class Editor;
  58 class Element;
  59 class Frame;
  60 class HTMLElement;
  61 class KeyboardEvent;
  62 class Node;
  63 class Range;
  64 class SpellChecker;
  65 class TextCheckerClient;
  66 class VisibleSelection;
  67 class VisiblePosition;
  68
  69 struct GrammarDetail;
  70
  71 class EditorClient {
  72 public:
  73     virtual ~EditorClient() {  }
  74     virtual void pageDestroyed() = 0;
  75
  76     virtual bool shouldDeleteRange(Range*) = 0;
  77     virtual bool shouldShowDeleteInterface(HTMLElement*) = 0;
  78     virtual bool smartInsertDeleteEnabled() = 0;
  79     virtual bool isSelectTrailingWhitespaceEnabled() = 0;
  80     virtual bool isContinuousSpellCheckingEnabled() = 0;
  81     virtual void toggleContinuousSpellChecking() = 0;
  82     virtual bool isGrammarCheckingEnabled() = 0;
  83     virtual void toggleGrammarChecking() = 0;
  84     virtual int spellCheckerDocumentTag() = 0;
  85
  86     virtual bool shouldBeginEditing(Range*) = 0;
  87     virtual bool shouldEndEditing(Range*) = 0;
  88     virtual bool shouldInsertNode(Node*, Range*, EditorInsertAction) = 0;
  89     virtual bool shouldInsertText(const String&, Range*, EditorInsertAction) = 0;
  90     virtual bool shouldChangeSelectedRange(Range* fromRange, Range* toRange, EAffinity, bool stillSelecting) = 0;
  91
  92     virtual bool shouldApplyStyle(CSSStyleDeclaration*, Range*) = 0;
  93     virtual bool shouldMoveRangeAfterDelete(Range*, Range*) = 0;
  94
  95     virtual void didBeginEditing() = 0;
  96     virtual void respondToChangedContents() = 0;
  97     virtual void respondToChangedSelection() = 0;
  98     virtual void didEndEditing() = 0;
  99     virtual void didWriteSelectionToPasteboard() = 0;
 100     virtual void didSetSelectionTypesForPasteboard() = 0;
 101
 102     virtual void registerCommandForUndo(PassRefPtr<EditCommand>) = 0;
 103     virtual void registerCommandForRedo(PassRefPtr<EditCommand>) = 0;
 104     virtual void clearUndoRedoOperations() = 0;
 105
 106     virtual bool canCopyCut(Frame*, bool defaultValue) const = 0;
 107     virtual bool canPaste(Frame*, bool defaultValue) const = 0;
 108     virtual bool canUndo() const = 0;
 109     virtual bool canRedo() const = 0;
 110
 111     virtual void undo() = 0;
 112     virtual void redo() = 0;
 113
 114     virtual void handleKeyboardEvent(KeyboardEvent*) = 0;
 115     virtual void handleInputMethodKeydown(KeyboardEvent*) = 0;
 116
 117     virtual void textFieldDidBeginEditing(Element*) = 0;
 118     virtual void textFieldDidEndEditing(Element*) = 0;
 119     virtual void textDidChangeInTextField(Element*) = 0;
 120     virtual bool doTextFieldCommandFromEvent(Element*, KeyboardEvent*) = 0;
 121     virtual void textWillBeDeletedInTextField(Element*) = 0;
 122     virtual void textDidChangeInTextArea(Element*) = 0;
 123
 124 #if PLATFORM(MAC)
 125     virtual NSString* userVisibleString(NSURL*) = 0;
 126     virtual DocumentFragment* documentFragmentFromAttributedString(NSAttributedString*, Vector< RefPtr<ArchiveResource> >&) = 0;
 127     virtual void setInsertionPasteboard(NSPasteboard*) = 0;
 128     virtual NSURL* canonicalizeURL(NSURL*) = 0;
 129     virtual NSURL* canonicalizeURLString(NSString*) = 0;
 130 #endif
 131
 132 #if PLATFORM(MAC) && !defined(BUILDING_ON_LEOPARD)
 133     virtual void uppercaseWord() = 0;
 134     virtual void lowercaseWord() = 0;
 135     virtual void capitalizeWord() = 0;
 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     virtual TextCheckerClient* textChecker() = 0;
 152
 153     enum AutocorrectionResponseType {
 154         AutocorrectionEdited,
 155         AutocorrectionReverted
 156     };
 157
 158 #if USE(AUTOCORRECTION_PANEL)
 159     virtual void showCorrectionPanel(CorrectionPanelInfo::PanelType, const FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacmentString, const Vector<String>& alternativeReplacementStrings) = 0;
 160     virtual void dismissCorrectionPanel(ReasonForDismissingCorrectionPanel) = 0;
 161     virtual String dismissCorrectionPanelSoon(ReasonForDismissingCorrectionPanel) = 0;
 162     virtual void recordAutocorrectionResponse(AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
 163 #endif
 164
 165     virtual void updateSpellingUIWithGrammarString(const String&, const GrammarDetail& detail) = 0;
 166     virtual void updateSpellingUIWithMisspelledWord(const String&) = 0;
 167     virtual void showSpellingUI(bool show) = 0;
 168     virtual bool spellingUIIsShowing() = 0;
 169     virtual void willSetInputMethodState() = 0;
 170     virtual void setInputMethodState(bool enabled) = 0;
 171 };
 172
 173 }
 174
 175 #endif // EditorClient_h