Back to index

lightning-sunbird  0.9+nobinonly
InsertTextTxn.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 InsertTextTxn_h__
00039 #define InsertTextTxn_h__
00040 
00041 #include "EditTxn.h"
00042 #include "nsIDOMCharacterData.h"
00043 #include "nsIEditor.h"
00044 #include "nsCOMPtr.h"
00045 
00046 #define INSERT_TEXT_TXN_CID \
00047 {/* 93276f00-ab2c-11d2-8f4b-006008159b0c*/ \
00048 0x93276f00, 0xab2c, 0x11d2, \
00049 {0x8f, 0xb4, 0x0, 0x60, 0x8, 0x15, 0x9b, 0xc} }
00050 
00051 class nsIPresShell;
00052 
00056 class InsertTextTxn : public EditTxn
00057 {
00058 public:
00059 
00060   static const nsIID& GetCID() { static const nsIID iid = INSERT_TEXT_TXN_CID; return iid; }
00061 
00062   virtual ~InsertTextTxn();
00063 
00067   static nsIAtom *gInsertTextTxnName;
00068        
00075   NS_IMETHOD Init(nsIDOMCharacterData *aElement,
00076                   PRUint32 aOffset,
00077                   const nsAString& aString,
00078                   nsIEditor *aEditor);
00079 
00080 private:
00081        
00082        InsertTextTxn();
00083 
00084 public:
00085        
00086   NS_IMETHOD DoTransaction(void);
00087 
00088   NS_IMETHOD UndoTransaction(void);
00089 
00090   NS_IMETHOD Merge(nsITransaction *aTransaction, PRBool *aDidMerge);
00091 
00092   NS_IMETHOD GetTxnDescription(nsAString& aTxnDescription);
00093 
00094 // nsISupports declarations
00095 
00096   // override QueryInterface to handle InsertTextTxn request
00097   NS_IMETHOD QueryInterface(const nsIID& aIID, void** aInstancePtr);
00098 
00100   NS_IMETHOD GetData(nsString& aResult);
00101 
00103   static nsresult ClassInit();
00104 
00106   static nsresult ClassShutdown();
00107 
00108 protected:
00109 
00111   virtual PRBool IsSequentialInsert(InsertTextTxn *aOtherTxn);
00112   
00114   nsCOMPtr<nsIDOMCharacterData> mElement;
00115   
00117   PRUint32 mOffset;
00118 
00120   nsString mStringToInsert;
00121 
00123   nsIEditor *mEditor;   
00124 
00125   friend class TransactionFactory;
00126 
00127   friend class nsDerivedSafe<InsertTextTxn>; // work around for a compiler bug
00128 
00129 };
00130 
00131 #endif