Back to index

lightning-sunbird  0.9+nobinonly
PlaceholderTxn.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-1999
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 AggregatePlaceholderTxn_h__
00039 #define AggregatePlaceholderTxn_h__
00040 
00041 #include "EditAggregateTxn.h"
00042 #include "nsEditorUtils.h"
00043 #include "nsIAbsorbingTransaction.h"
00044 #include "nsIDOMNode.h"
00045 #include "nsCOMPtr.h"
00046 #include "nsWeakPtr.h"
00047 #include "nsWeakReference.h"
00048 
00049 #define PLACEHOLDER_TXN_CID \
00050 {/* {0CE9FB00-D9D1-11d2-86DE-000064657374} */ \
00051 0x0CE9FB00, 0xD9D1, 0x11d2, \
00052 {0x86, 0xde, 0x0, 0x0, 0x64, 0x65, 0x73, 0x74} }
00053 
00054 class nsHTMLEditor;
00055 class IMETextTxn;
00056 
00064 class PlaceholderTxn : public EditAggregateTxn, 
00065                        public nsIAbsorbingTransaction, 
00066                        public nsSupportsWeakReference
00067 {
00068 public:
00069 
00070   static const nsIID& GetCID() { static const nsIID iid = PLACEHOLDER_TXN_CID; return iid; }
00071 
00072   NS_DECL_ISUPPORTS_INHERITED  
00073   
00074 private:
00075   PlaceholderTxn();
00076 
00077 public:
00078 
00079   virtual ~PlaceholderTxn();
00080 
00081 // ------------ EditAggregateTxn -----------------------
00082 
00083   NS_IMETHOD DoTransaction(void);
00084 
00085   NS_IMETHOD UndoTransaction(void);
00086   
00087   NS_IMETHOD RedoTransaction(void);
00088 
00089   NS_IMETHOD Merge(nsITransaction *aTransaction, PRBool *aDidMerge);
00090 
00091   NS_IMETHOD GetTxnDescription(nsAString& aTxnDescription);
00092 
00093 // ------------ nsIAbsorbingTransaction -----------------------
00094 
00095   NS_IMETHOD Init(nsIAtom *aName, nsSelectionState *aSelState, nsIEditor *aEditor);
00096   
00097   NS_IMETHOD GetTxnName(nsIAtom **aName);
00098   
00099   NS_IMETHOD StartSelectionEquals(nsSelectionState *aSelState, PRBool *aResult);
00100 
00101   NS_IMETHOD EndPlaceHolderBatch();
00102 
00103   NS_IMETHOD ForwardEndBatchTo(nsIAbsorbingTransaction *aForwardingAddress);
00104 
00105   NS_IMETHOD Commit();
00106 
00107   NS_IMETHOD RememberEndingSelection();
00108   
00109   friend class TransactionFactory;
00110 
00111 protected:
00112 
00114   PRBool      mAbsorb;          // do we auto absorb any and all transaction?
00115   nsWeakPtr   mForwarding;
00116   IMETextTxn *mIMETextTxn;      // first IME txn in this placeholder - used for IME merging
00117                                 // non-owning for now - cant nsCOMPtr it due to broken transaction interfaces
00118   PRBool      mCommitted;       // do we stop auto absorbing any matching placeholder txns?
00119   // these next two members store the state of the selection in a safe way. 
00120   // selection at the start of the txn is stored, as is the selection at the end.
00121   // This is so that UndoTransaction() and RedoTransaction() can restore the
00122   // selection properly.
00123   nsSelectionState *mStartSel; // use a pointer because this is constructed before we exist
00124   nsSelectionState  mEndSel;
00125   nsIEditor*        mEditor;   
00126 };
00127 
00128 
00129 #endif