Back to index

lightning-sunbird  0.9+nobinonly
IMETextTxn.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 IMETextTxn_h__
00039 #define IMETextTxn_h__
00040 
00041 #include "EditTxn.h"
00042 #include "nsIDOMCharacterData.h"
00043 #include "nsIPrivateTextRange.h"
00044 #include "nsCOMPtr.h"
00045 #include "nsWeakPtr.h"
00046 #include "nsIAtom.h"
00047 
00048 // {D4D25721-2813-11d3-9EA3-0060089FE59B}
00049 #define IME_TEXT_TXN_CID                                              \
00050 {0xd4d25721, 0x2813, 0x11d3,                                          \
00051 {0x9e, 0xa3, 0x0, 0x60, 0x8, 0x9f, 0xe5, 0x9b }}
00052 
00053 
00054 
00055 
00056 class nsIPresShell;
00057 
00061 class IMETextTxn : public EditTxn
00062 {
00063 public:
00064   static const nsIID& GetCID() { static const nsIID iid = IME_TEXT_TXN_CID; return iid; }
00065 
00066   virtual ~IMETextTxn();
00067 
00071   static nsIAtom *gIMETextTxnName;
00072        
00080   NS_IMETHOD Init(nsIDOMCharacterData *aElement,
00081                   PRUint32 aOffset,
00082                   PRUint32 aReplaceLength,
00083                   nsIPrivateTextRangeList* aTextRangeList,
00084                   const nsAString& aString,
00085                   nsWeakPtr aSelCon);
00086 
00087 private:
00088        
00089        IMETextTxn();
00090 
00091 public:
00092        
00093   NS_IMETHOD DoTransaction(void);
00094 
00095   NS_IMETHOD UndoTransaction(void);
00096 
00097   NS_IMETHOD Merge(nsITransaction *aTransaction, PRBool *aDidMerge);
00098 
00099   NS_IMETHOD GetTxnDescription(nsAString& aTxnDescription);
00100 
00101   NS_IMETHOD MarkFixed(void);
00102 
00103 // nsISupports declarations
00104 
00105   // override QueryInterface to handle IMETextTxn request
00106   NS_IMETHOD QueryInterface(const nsIID& aIID, void** aInstancePtr);
00107 
00109   NS_IMETHOD GetData(nsString& aResult, nsIPrivateTextRangeList** aTextRangeList);
00110 
00112   static nsresult ClassInit();
00113 
00115   static nsresult ClassShutdown();
00116 
00117 protected:
00118 
00119   NS_IMETHOD CollapseTextSelection(void);
00120 
00122   nsCOMPtr<nsIDOMCharacterData> mElement;
00123   
00125   PRUint32 mOffset;
00126 
00127   PRUint32 mReplaceLength;
00128 
00130   nsString mStringToInsert;
00131 
00133   nsCOMPtr<nsIPrivateTextRangeList>       mRangeList;
00134 
00136   nsWeakPtr mSelConWeak;  // use a weak reference
00137 
00138   PRBool      mFixed;
00139 
00140   friend class TransactionFactory;
00141 
00142   friend class nsDerivedSafe<IMETextTxn>; // work around for a compiler bug
00143 
00144 };
00145 
00146 #endif