• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2005, 2006, 2007, 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 TypingCommand_h
27 #define TypingCommand_h
28 
29 #include "CompositeEditCommand.h"
30 
31 namespace WebCore {
32 
33 class TypingCommand : public CompositeEditCommand {
34 public:
35     enum ETypingCommand {
36         DeleteSelection,
37         DeleteKey,
38         ForwardDeleteKey,
39         InsertText,
40         InsertLineBreak,
41         InsertParagraphSeparator,
42         InsertParagraphSeparatorInQuotedContent
43     };
44 
45     static void deleteSelection(Document*, bool smartDelete = false);
46     static void deleteKeyPressed(Document*, bool smartDelete = false, TextGranularity = CharacterGranularity, bool killRing = false);
47     static void forwardDeleteKeyPressed(Document*, bool smartDelete = false, TextGranularity = CharacterGranularity, bool killRing = false);
48     static void insertText(Document*, const String&, bool selectInsertedText = false, bool insertedTextIsComposition = false);
49     static void insertText(Document*, const String&, const VisibleSelection&, bool selectInsertedText = false, bool insertedTextIsComposition = false);
50     static void insertLineBreak(Document*);
51     static void insertParagraphSeparator(Document*);
52     static void insertParagraphSeparatorInQuotedContent(Document*);
53     static bool isOpenForMoreTypingCommand(const EditCommand*);
54     static void closeTyping(EditCommand*);
55 
isOpenForMoreTyping()56     bool isOpenForMoreTyping() const { return m_openForMoreTyping; }
closeTyping()57     void closeTyping() { m_openForMoreTyping = false; }
58 
59     void insertText(const String &text, bool selectInsertedText);
60     void insertTextRunWithoutNewlines(const String &text, bool selectInsertedText);
61     void insertLineBreak();
62     void insertParagraphSeparatorInQuotedContent();
63     void insertParagraphSeparator();
64     void deleteKeyPressed(TextGranularity, bool killRing);
65     void forwardDeleteKeyPressed(TextGranularity, bool killRing);
66     void deleteSelection(bool smartDelete);
67 
68 private:
69     static PassRefPtr<TypingCommand> create(Document* document, ETypingCommand command, const String& text = "", bool selectInsertedText = false, TextGranularity granularity = CharacterGranularity, bool killRing = false)
70     {
71         return adoptRef(new TypingCommand(document, command, text, selectInsertedText, granularity, killRing));
72     }
73 
74     TypingCommand(Document*, ETypingCommand, const String& text, bool selectInsertedText, TextGranularity, bool killRing);
75 
smartDelete()76     bool smartDelete() const { return m_smartDelete; }
setSmartDelete(bool smartDelete)77     void setSmartDelete(bool smartDelete) { m_smartDelete = smartDelete; }
78 
79     virtual void doApply();
80     virtual EditAction editingAction() const;
81     virtual bool isTypingCommand() const;
preservesTypingStyle()82     virtual bool preservesTypingStyle() const { return m_preservesTypingStyle; }
83 
84     void updatePreservesTypingStyle(ETypingCommand);
85     void markMisspellingsAfterTyping();
86     void typingAddedToOpenCommand(ETypingCommand);
87     bool makeEditableRootEmpty();
88 
89     ETypingCommand m_commandType;
90     String m_textToInsert;
91     bool m_openForMoreTyping;
92     bool m_selectInsertedText;
93     bool m_smartDelete;
94     TextGranularity m_granularity;
95     bool m_killRing;
96     bool m_preservesTypingStyle;
97 
98     // Undoing a series of backward deletes will restore a selection around all of the
99     // characters that were deleted, but only if the typing command being undone
100     // was opened with a backward delete.
101     bool m_openedByBackwardDelete;
102 };
103 
104 } // namespace WebCore
105 
106 #endif // TypingCommand_h
107