1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License Version
6 : * 1.1 (the "License"); you may not use this file except in compliance with
7 : * the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
9 : *
10 : * Software distributed under the License is distributed on an "AS IS" basis,
11 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 : * for the specific language governing rights and limitations under the
13 : * License.
14 : *
15 : * The Original Code is mozilla.org code.
16 : *
17 : * The Initial Developer of the Original Code is
18 : * Netscape Communications Corporation.
19 : * Portions created by the Initial Developer are Copyright (C) 1998-1999
20 : * the Initial Developer. All Rights Reserved.
21 : *
22 : * Contributor(s):
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 :
38 : #ifndef AggregatePlaceholderTxn_h__
39 : #define AggregatePlaceholderTxn_h__
40 :
41 : #include "EditAggregateTxn.h"
42 : #include "nsEditorUtils.h"
43 : #include "nsIAbsorbingTransaction.h"
44 : #include "nsIDOMNode.h"
45 : #include "nsCOMPtr.h"
46 : #include "nsWeakPtr.h"
47 : #include "nsWeakReference.h"
48 : #include "nsAutoPtr.h"
49 :
50 : class nsHTMLEditor;
51 : class IMETextTxn;
52 :
53 : /**
54 : * An aggregate transaction that knows how to absorb all subsequent
55 : * transactions with the same name. This transaction does not "Do" anything.
56 : * But it absorbs other transactions via merge, and can undo/redo the
57 : * transactions it has absorbed.
58 : */
59 :
60 : class PlaceholderTxn : public EditAggregateTxn,
61 : public nsIAbsorbingTransaction,
62 : public nsSupportsWeakReference
63 0 : {
64 : public:
65 : NS_DECL_ISUPPORTS_INHERITED
66 :
67 : PlaceholderTxn();
68 :
69 1464 : NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(PlaceholderTxn, EditAggregateTxn)
70 : // ------------ EditAggregateTxn -----------------------
71 :
72 : NS_DECL_EDITTXN
73 :
74 : NS_IMETHOD RedoTransaction();
75 : NS_IMETHOD Merge(nsITransaction *aTransaction, bool *aDidMerge);
76 :
77 : // ------------ nsIAbsorbingTransaction -----------------------
78 :
79 : NS_IMETHOD Init(nsIAtom *aName, nsSelectionState *aSelState, nsIEditor *aEditor);
80 :
81 : NS_IMETHOD GetTxnName(nsIAtom **aName);
82 :
83 : NS_IMETHOD StartSelectionEquals(nsSelectionState *aSelState, bool *aResult);
84 :
85 : NS_IMETHOD EndPlaceHolderBatch();
86 :
87 : NS_IMETHOD ForwardEndBatchTo(nsIAbsorbingTransaction *aForwardingAddress);
88 :
89 : NS_IMETHOD Commit();
90 :
91 : NS_IMETHOD RememberEndingSelection();
92 :
93 : protected:
94 :
95 : /** the presentation shell, which we'll need to get the selection */
96 : bool mAbsorb; // do we auto absorb any and all transaction?
97 : nsWeakPtr mForwarding;
98 : IMETextTxn *mIMETextTxn; // first IME txn in this placeholder - used for IME merging
99 : // non-owning for now - can't nsCOMPtr it due to broken transaction interfaces
100 : bool mCommitted; // do we stop auto absorbing any matching placeholder txns?
101 : // these next two members store the state of the selection in a safe way.
102 : // selection at the start of the txn is stored, as is the selection at the end.
103 : // This is so that UndoTransaction() and RedoTransaction() can restore the
104 : // selection properly.
105 : nsAutoPtr<nsSelectionState> mStartSel; // use a pointer because this is constructed before we exist
106 : nsSelectionState mEndSel;
107 : nsIEditor* mEditor; /** the editor for this transaction */
108 : };
109 :
110 :
111 : #endif
|