LayoutTests:
[WebKit-https.git] / WebCore / editing / TypingCommand.h
1 /*
2  * Copyright (C) 2005 Apple Computer, 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 typing_command_h__
27 #define typing_command_h__
28
29 #include "CompositeEditCommand.h"
30
31 namespace WebCore {
32
33 class TypingCommand : public CompositeEditCommand
34 {
35 public:
36     enum ETypingCommand { 
37         DeleteKey, 
38         ForwardDeleteKey, 
39         InsertText, 
40         InsertLineBreak, 
41         InsertParagraphSeparator,
42         InsertParagraphSeparatorInQuotedContent,
43     };
44
45     TypingCommand(Document *document, ETypingCommand, const String &text = "", bool selectInsertedText = false, TextGranularity granularity = CharacterGranularity);
46
47     static void deleteKeyPressed(Document *, bool smartDelete = false, TextGranularity granularity = CharacterGranularity);
48     static void forwardDeleteKeyPressed(Document *, bool smartDelete = false, TextGranularity granularity = CharacterGranularity);
49     static void insertText(Document *, const String &, bool selectInsertedText = false);
50     static void insertLineBreak(Document *);
51     static void insertParagraphSeparator(Document *);
52     static void insertParagraphSeparatorInQuotedContent(Document *);
53     static bool isOpenForMoreTypingCommand(const EditCommandPtr &);
54     static void closeTyping(const EditCommandPtr &);
55     
56     virtual void doApply();
57     virtual EditAction editingAction() const;
58
59     bool openForMoreTyping() const { return m_openForMoreTyping; }
60     void closeTyping() { m_openForMoreTyping = false; }
61
62     void insertText(const String &text, bool selectInsertedText);
63     void insertTextRunWithoutNewlines(const String &text, bool selectInsertedText);
64     void insertLineBreak();
65     void insertParagraphSeparatorInQuotedContent();
66     void insertParagraphSeparator();
67     void deleteKeyPressed(TextGranularity);
68     void forwardDeleteKeyPressed(TextGranularity);
69
70     bool smartDelete() { return m_smartDelete; }
71     void setSmartDelete(bool smartDelete) { m_smartDelete = smartDelete; }
72
73 private:
74     virtual bool isTypingCommand() const;
75     virtual bool preservesTypingStyle() const;
76
77     void markMisspellingsAfterTyping();
78     void typingAddedToOpenCommand();
79     
80     ETypingCommand m_commandType;
81     String m_textToInsert;
82     bool m_openForMoreTyping;
83     bool m_applyEditing;
84     bool m_selectInsertedText;
85     bool m_smartDelete;
86     TextGranularity m_granularity;
87 };
88
89 } // namespace WebCore
90
91 #endif // __typing_command_h__