#pragma once
#include "EditorInsertAction.h"
#include "SerializedAttachmentData.h"
#include "TextAffinity.h"
#include "TextChecking.h"
#include "UndoStep.h"
#include <wtf/Forward.h>
#include <wtf/Vector.h>
namespace WebCore {
enum class DOMPasteAccessResponse : uint8_t;
class DocumentFragment;
class Element;
class Frame;
class KeyboardEvent;
class Node;
class SharedBuffer;
class StyleProperties;
class TextCheckerClient;
class VisibleSelection;
struct GapRects;
struct GrammarDetail;
struct SimpleRange;
class EditorClient {
public:
virtual ~EditorClient() = default;
virtual bool shouldDeleteRange(const Optional<SimpleRange>&) = 0;
virtual bool smartInsertDeleteEnabled() = 0;
virtual bool isSelectTrailingWhitespaceEnabled() const = 0;
virtual bool isContinuousSpellCheckingEnabled() = 0;
virtual void toggleContinuousSpellChecking() = 0;
virtual bool isGrammarCheckingEnabled() = 0;
virtual void toggleGrammarChecking() = 0;
virtual int spellCheckerDocumentTag() = 0;
virtual bool shouldBeginEditing(const SimpleRange&) = 0;
virtual bool shouldEndEditing(const SimpleRange&) = 0;
virtual bool shouldInsertNode(Node&, const Optional<SimpleRange>&, EditorInsertAction) = 0;
virtual bool shouldInsertText(const String&, const Optional<SimpleRange>&, EditorInsertAction) = 0;
virtual bool shouldChangeSelectedRange(const Optional<SimpleRange>& fromRange, const Optional<SimpleRange>& toRange, Affinity, bool stillSelecting) = 0;
virtual bool shouldRevealCurrentSelectionAfterInsertion() const { return true; };
virtual bool shouldSuppressPasswordEcho() const { return false; };
virtual bool shouldApplyStyle(const StyleProperties&, const Optional<SimpleRange>&) = 0;
virtual void didApplyStyle() = 0;
virtual bool shouldMoveRangeAfterDelete(const SimpleRange&, const SimpleRange&) = 0;
#if ENABLE(ATTACHMENT_ELEMENT)
virtual void registerAttachmentIdentifier(const String& , const String& , const String& , Ref<SharedBuffer>&&) { }
virtual void registerAttachmentIdentifier(const String& , const String& , const String& ) { }
virtual void registerAttachments(Vector<SerializedAttachmentData>&&) { }
virtual void registerAttachmentIdentifier(const String& ) { }
virtual void cloneAttachmentData(const String& , const String& ) { }
virtual void didInsertAttachmentWithIdentifier(const String& , const String& , bool ) { }
virtual void didRemoveAttachmentWithIdentifier(const String&) { }
virtual bool supportsClientSideAttachmentData() const { return false; }
virtual Vector<SerializedAttachmentData> serializedAttachmentDataForIdentifiers(const Vector<String>&) { return { }; }
#endif
virtual void didBeginEditing() = 0;
virtual void respondToChangedContents() = 0;
virtual void respondToChangedSelection(Frame*) = 0;
virtual void didEndUserTriggeredSelectionChanges() = 0;
virtual void updateEditorStateAfterLayoutIfEditabilityChanged() = 0;
virtual void didEndEditing() = 0;
virtual void willWriteSelectionToPasteboard(const Optional<SimpleRange>&) = 0;
virtual void didWriteSelectionToPasteboard() = 0;
virtual void getClientPasteboardData(const Optional<SimpleRange>&, Vector<String>& pasteboardTypes, Vector<RefPtr<SharedBuffer>>& pasteboardData) = 0;
virtual void requestCandidatesForSelection(const VisibleSelection&) { }
virtual void handleAcceptedCandidateWithSoftSpaces(TextCheckingResult) { }
virtual DOMPasteAccessResponse requestDOMPasteAccess(const String& originIdentifier) = 0;
virtual void discardedComposition(Frame*) = 0;
virtual void canceledComposition() = 0;
virtual void didUpdateComposition() = 0;
virtual void registerUndoStep(UndoStep&) = 0;
virtual void registerRedoStep(UndoStep&) = 0;
virtual void clearUndoRedoOperations() = 0;
virtual bool canCopyCut(Frame*, bool defaultValue) const = 0;
virtual bool canPaste(Frame*, bool defaultValue) const = 0;
virtual bool canUndo() const = 0;
virtual bool canRedo() const = 0;
virtual void undo() = 0;
virtual void redo() = 0;
virtual void handleKeyboardEvent(KeyboardEvent&) = 0;
virtual void handleInputMethodKeydown(KeyboardEvent&) = 0;
virtual void didDispatchInputMethodKeydown(KeyboardEvent&) { }
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;
virtual void overflowScrollPositionChanged() = 0;
virtual void subFrameScrollPositionChanged() = 0;
#if PLATFORM(IOS_FAMILY)
virtual void startDelayingAndCoalescingContentChangeNotifications() = 0;
virtual void stopDelayingAndCoalescingContentChangeNotifications() = 0;
virtual bool hasRichlyEditableSelection() = 0;
virtual int getPasteboardItemsCount() = 0;
virtual RefPtr<DocumentFragment> documentFragmentFromDelegate(int index) = 0;
virtual bool performsTwoStepPaste(DocumentFragment*) = 0;
virtual void updateStringForFind(const String&) = 0;
#endif
#if PLATFORM(COCOA)
virtual void setInsertionPasteboard(const String& pasteboardName) = 0;
#endif
#if USE(APPKIT)
virtual void uppercaseWord() = 0;
virtual void lowercaseWord() = 0;
virtual void capitalizeWord() = 0;
#endif
#if USE(AUTOMATIC_TEXT_REPLACEMENT)
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
#if PLATFORM(GTK)
virtual bool shouldShowUnicodeMenu() = 0;
#endif
virtual TextCheckerClient* textChecker() = 0;
virtual void updateSpellingUIWithGrammarString(const String&, const GrammarDetail& detail) = 0;
virtual void updateSpellingUIWithMisspelledWord(const String&) = 0;
virtual void showSpellingUI(bool show) = 0;
virtual bool spellingUIIsShowing() = 0;
virtual void willSetInputMethodState() = 0;
virtual void setInputMethodState(Element*) = 0;
virtual bool supportsGlobalSelection() { return false; }
virtual bool performTwoStepDrop(DocumentFragment&, const SimpleRange& destination, bool isMove) = 0;
virtual bool canShowFontPanel() const = 0;
virtual bool shouldAllowSingleClickToChangeSelection(Node&, const VisibleSelection&) const { return true; }
};
}