Home | History | Annotate | Download | only in editing
      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 "VisibleSelection.h"
     32 
     33 namespace WebCore {
     34 
     35 class CompositeEditCommand;
     36 
     37 class EditCommand : public RefCounted<EditCommand> {
     38 public:
     39     virtual ~EditCommand();
     40 
     41     void setParent(CompositeEditCommand*);
     42 
     43     void apply();
     44     void unapply();
     45     void reapply();
     46 
     47     virtual EditAction editingAction() const;
     48 
     49     const VisibleSelection& startingSelection() const { return m_startingSelection; }
     50     const VisibleSelection& endingSelection() const { return m_endingSelection; }
     51 
     52     Element* startingRootEditableElement() const { return m_startingRootEditableElement.get(); }
     53     Element* endingRootEditableElement() const { return m_endingRootEditableElement.get(); }
     54 
     55     virtual bool isInsertTextCommand() const;
     56     virtual bool isTypingCommand() const;
     57 
     58     virtual bool preservesTypingStyle() const;
     59 
     60     bool isTopLevelCommand() const { return !m_parent; }
     61 
     62     virtual bool shouldRetainAutocorrectionIndicator() const;
     63     virtual void setShouldRetainAutocorrectionIndicator(bool);
     64 
     65 protected:
     66     EditCommand(Document*);
     67 
     68     Document* document() const { return m_document.get(); }
     69 
     70     void setStartingSelection(const VisibleSelection&);
     71     void setEndingSelection(const VisibleSelection&);
     72 
     73     void updateLayout() const;
     74 
     75 private:
     76     virtual void doApply() = 0;
     77     virtual void doUnapply() = 0;
     78     virtual void doReapply(); // calls doApply()
     79 
     80     RefPtr<Document> m_document;
     81     VisibleSelection m_startingSelection;
     82     VisibleSelection m_endingSelection;
     83     RefPtr<Element> m_startingRootEditableElement;
     84     RefPtr<Element> m_endingRootEditableElement;
     85     CompositeEditCommand* m_parent;
     86 
     87     friend void applyCommand(PassRefPtr<EditCommand>);
     88 };
     89 
     90 class SimpleEditCommand : public EditCommand {
     91 protected:
     92     SimpleEditCommand(Document* document) : EditCommand(document) { }
     93 };
     94 
     95 void applyCommand(PassRefPtr<EditCommand>);
     96 
     97 } // namespace WebCore
     98 
     99 #endif // EditCommand_h
    100