Back to index

lightning-sunbird  0.9+nobinonly
nsTransactionManager.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsTransactionManager_h__
00039 #define nsTransactionManager_h__
00040 
00041 #include "prmon.h"
00042 #include "nsWeakReference.h"
00043 #include "nsITransactionManager.h"
00044 
00045 class nsITransaction;
00046 class nsITransactionListener;
00047 class nsTransactionItem;
00048 class nsTransactionStack;
00049 class nsTransactionRedoStack;
00050 class nsVoidArray;
00051 
00055 class nsTransactionManager : public nsITransactionManager
00056                            , public nsSupportsWeakReference
00057 {
00058 private:
00059 
00060   PRInt32                mMaxTransactionCount;
00061   nsTransactionStack     mDoStack;
00062   nsTransactionStack     mUndoStack;
00063   nsTransactionRedoStack mRedoStack;
00064   nsVoidArray            *mListeners;
00065 
00066   PRMonitor              *mMonitor;
00067 
00068 public:
00069 
00072   nsTransactionManager(PRInt32 aMaxTransactionCount=-1);
00073 
00076   virtual ~nsTransactionManager();
00077 
00078   /* Macro for AddRef(), Release(), and QueryInterface() */
00079   NS_DECL_ISUPPORTS
00080 
00081   /* nsITransactionManager method implementations. */
00082   NS_DECL_NSITRANSACTIONMANAGER
00083 
00084   /* nsTransactionManager specific methods. */
00085   virtual nsresult ClearUndoStack(void);
00086   virtual nsresult ClearRedoStack(void);
00087 
00088   virtual nsresult WillDoNotify(nsITransaction *aTransaction, PRBool *aInterrupt);
00089   virtual nsresult DidDoNotify(nsITransaction *aTransaction, nsresult aExecuteResult);
00090   virtual nsresult WillUndoNotify(nsITransaction *aTransaction, PRBool *aInterrupt);
00091   virtual nsresult DidUndoNotify(nsITransaction *aTransaction, nsresult aUndoResult);
00092   virtual nsresult WillRedoNotify(nsITransaction *aTransaction, PRBool *aInterrupt);
00093   virtual nsresult DidRedoNotify(nsITransaction *aTransaction, nsresult aRedoResult);
00094   virtual nsresult WillBeginBatchNotify(PRBool *aInterrupt);
00095   virtual nsresult DidBeginBatchNotify(nsresult aResult);
00096   virtual nsresult WillEndBatchNotify(PRBool *aInterrupt);
00097   virtual nsresult DidEndBatchNotify(nsresult aResult);
00098   virtual nsresult WillMergeNotify(nsITransaction *aTop,
00099                                    nsITransaction *aTransaction,
00100                                    PRBool *aInterrupt);
00101   virtual nsresult DidMergeNotify(nsITransaction *aTop,
00102                                   nsITransaction *aTransaction,
00103                                   PRBool aDidMerge,
00104                                   nsresult aMergeResult);
00105 
00106 private:
00107 
00108   /* nsTransactionManager specific private methods. */
00109   virtual nsresult BeginTransaction(nsITransaction *aTransaction);
00110   virtual nsresult EndTransaction(void);
00111   virtual nsresult Lock(void);
00112   virtual nsresult Unlock(void);
00113 };
00114 
00115 #endif // nsTransactionManager_h__