Back to index

lightning-sunbird  0.9+nobinonly
DeleteRangeTxn.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 DeleteRangeTxn_h__
00039 #define DeleteRangeTxn_h__
00040 
00041 #include "EditAggregateTxn.h"
00042 #include "nsIDOMNode.h"
00043 #include "nsIDOMRange.h"
00044 #include "nsIEditor.h"
00045 #include "nsCOMPtr.h"
00046 
00047 #define DELETE_RANGE_TXN_CID \
00048 {/* 5ec6b260-ac49-11d2-86d8-000064657374 */ \
00049 0x5ec6b260, 0xac49, 0x11d2, \
00050 {0x86, 0xd8, 0x0, 0x0, 0x64, 0x65, 0x73, 0x74} }
00051 
00052 class nsIDOMRange;
00053 class nsIEditor;
00054 class nsRangeUpdater;
00055 
00059 class DeleteRangeTxn : public EditAggregateTxn
00060 {
00061 public:
00062 
00063   static const nsIID& GetCID() { static const nsIID iid = DELETE_RANGE_TXN_CID; return iid; }
00064 
00069   NS_IMETHOD Init(nsIEditor *aEditor, 
00070                   nsIDOMRange *aRange,
00071                   nsRangeUpdater *aRangeUpdater);
00072 
00073 private:
00074   DeleteRangeTxn();
00075 
00076 public:
00077 
00078   virtual ~DeleteRangeTxn();
00079 
00080   NS_IMETHOD DoTransaction(void);
00081 
00082   NS_IMETHOD UndoTransaction(void);
00083 
00084   NS_IMETHOD RedoTransaction(void);
00085 
00086   NS_IMETHOD Merge(nsITransaction *aTransaction, PRBool *aDidMerge);
00087 
00088   NS_IMETHOD GetTxnDescription(nsAString& aTxnDescription);
00089 
00090 protected:
00091 
00092   NS_IMETHOD CreateTxnsToDeleteBetween(nsIDOMNode *aStartParent, 
00093                                              PRUint32    aStartOffset, 
00094                                              PRUint32    aEndOffset);
00095 
00096   NS_IMETHOD CreateTxnsToDeleteNodesBetween();
00097 
00098   NS_IMETHOD CreateTxnsToDeleteContent(nsIDOMNode *aParent, 
00099                                              PRUint32 aOffset, 
00100                                              nsIEditor::EDirection aAction);
00101   
00102 protected:
00103   
00105   nsCOMPtr<nsIDOMRange> mRange;                  // is this really an owning ptr?
00106 
00108   nsCOMPtr<nsIDOMNode> mStartParent;
00109 
00111   PRInt32 mStartOffset;
00112 
00114   nsCOMPtr<nsIDOMNode> mEndParent;
00115 
00117   nsCOMPtr<nsIDOMNode> mCommonParent;
00118 
00120   PRInt32 mEndOffset;
00121 
00123   nsIEditor* mEditor;
00124 
00126   nsRangeUpdater *mRangeUpdater;
00127   
00128   friend class TransactionFactory;
00129 
00130 };
00131 
00132 #endif