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
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 nsTransactionManager_h__
39 : #define nsTransactionManager_h__
40 :
41 : #include "nsWeakReference.h"
42 : #include "nsITransactionManager.h"
43 : #include "nsCOMArray.h"
44 : #include "nsITransactionListener.h"
45 : #include "nsCycleCollectionParticipant.h"
46 :
47 : class nsITransaction;
48 : class nsITransactionListener;
49 : class nsTransactionItem;
50 : class nsTransactionStack;
51 :
52 : /** implementation of a transaction manager object.
53 : *
54 : */
55 : class nsTransactionManager : public nsITransactionManager
56 : , public nsSupportsWeakReference
57 : {
58 : private:
59 :
60 : PRInt32 mMaxTransactionCount;
61 : nsTransactionStack mDoStack;
62 : nsTransactionStack mUndoStack;
63 : nsTransactionStack mRedoStack;
64 : nsCOMArray<nsITransactionListener> mListeners;
65 :
66 : public:
67 :
68 : /** The default constructor.
69 : */
70 : nsTransactionManager(PRInt32 aMaxTransactionCount=-1);
71 :
72 : /** The default destructor.
73 : */
74 : virtual ~nsTransactionManager();
75 :
76 : /* Macro for AddRef(), Release(), and QueryInterface() */
77 2 : NS_DECL_CYCLE_COLLECTING_ISUPPORTS
78 1732 : NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsTransactionManager,
79 : nsITransactionManager)
80 :
81 : /* nsITransactionManager method implementations. */
82 : NS_DECL_NSITRANSACTIONMANAGER
83 :
84 : /* nsTransactionManager specific methods. */
85 : virtual nsresult ClearUndoStack(void);
86 : virtual nsresult ClearRedoStack(void);
87 :
88 : virtual nsresult WillDoNotify(nsITransaction *aTransaction, bool *aInterrupt);
89 : virtual nsresult DidDoNotify(nsITransaction *aTransaction, nsresult aExecuteResult);
90 : virtual nsresult WillUndoNotify(nsITransaction *aTransaction, bool *aInterrupt);
91 : virtual nsresult DidUndoNotify(nsITransaction *aTransaction, nsresult aUndoResult);
92 : virtual nsresult WillRedoNotify(nsITransaction *aTransaction, bool *aInterrupt);
93 : virtual nsresult DidRedoNotify(nsITransaction *aTransaction, nsresult aRedoResult);
94 : virtual nsresult WillBeginBatchNotify(bool *aInterrupt);
95 : virtual nsresult DidBeginBatchNotify(nsresult aResult);
96 : virtual nsresult WillEndBatchNotify(bool *aInterrupt);
97 : virtual nsresult DidEndBatchNotify(nsresult aResult);
98 : virtual nsresult WillMergeNotify(nsITransaction *aTop,
99 : nsITransaction *aTransaction,
100 : bool *aInterrupt);
101 : virtual nsresult DidMergeNotify(nsITransaction *aTop,
102 : nsITransaction *aTransaction,
103 : bool aDidMerge,
104 : nsresult aMergeResult);
105 :
106 : private:
107 :
108 : /* nsTransactionManager specific private methods. */
109 : virtual nsresult BeginTransaction(nsITransaction *aTransaction);
110 : virtual nsresult EndTransaction(void);
111 : };
112 :
113 : #endif // nsTransactionManager_h__
|