WebCore/editing/EditCommand.h

   1 /*
   2  * Copyright (C) 2005, 2006, 2008 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef EditCommand_h
  27 #define EditCommand_h
  28
  29 #include "EditAction.h"
  30 #include "Element.h"
  31 #include "Selection.h"
  32
  33 namespace WebCore {
  34
  35 class CompositeEditCommand;
  36 class CSSMutableStyleDeclaration;
  37
  38 class EditCommand : public RefCounted<EditCommand> {
  39 public:
  40     virtual ~EditCommand();
  41
  42     void setParent(CompositeEditCommand*);
  43
  44     void apply();
  45     void unapply();
  46     void reapply();
  47
  48     virtual EditAction editingAction() const;
  49
  50     const Selection& startingSelection() const { return m_startingSelection; }
  51     const Selection& endingSelection() const { return m_endingSelection; }
  52
  53     Element* startingRootEditableElement() const { return m_startingRootEditableElement.get(); }
  54     Element* endingRootEditableElement() const { return m_endingRootEditableElement.get(); }
  55
  56     virtual bool isInsertTextCommand() const;
  57     virtual bool isTypingCommand() const;
  58
  59     virtual bool preservesTypingStyle() const;
  60
  61 protected:
  62     EditCommand(Document*);
  63
  64     Document* document() const { return m_document.get(); }
  65
  66     void setStartingSelection(const Selection&);
  67     void setEndingSelection(const Selection&);
  68
  69     PassRefPtr<CSSMutableStyleDeclaration> styleAtPosition(const Position&);
  70     void updateLayout() const;
  71
  72 private:
  73     virtual void doApply() = 0;
  74     virtual void doUnapply() = 0;
  75     virtual void doReapply(); // calls doApply()
  76
  77     RefPtr<Document> m_document;
  78     Selection m_startingSelection;
  79     Selection m_endingSelection;
  80     RefPtr<Element> m_startingRootEditableElement;
  81     RefPtr<Element> m_endingRootEditableElement;
  82     CompositeEditCommand* m_parent;
  83
  84     friend void applyCommand(PassRefPtr<EditCommand>);
  85 };
  86
  87 class SimpleEditCommand : public EditCommand {
  88 protected:
  89     SimpleEditCommand(Document* document) : EditCommand(document) { }
  90 };
  91
  92 void applyCommand(PassRefPtr<EditCommand>);
  93
  94 } // namespace WebCore
  95
  96 #endif // EditCommand_h