Back to index

lightning-sunbird  0.9+nobinonly
SetDocTitleTxn.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 SetDocTitleTxn_h__
00039 #define SetDocTitleTxn_h__
00040 
00041 #include "EditTxn.h"
00042 #include "nsIEditor.h"
00043 #include "nsIHTMLEditor.h"
00044 #include "nsITransaction.h"
00045 #include "nsCOMPtr.h"
00046 
00047 #define SET_DOC_TITLE_TXN_CID \
00048 { /*7FC508B5-ED8F-11d4-AF02-0050040AE132 */ \
00049 0x7fc508b5, 0xed8f, 0x11d4, \
00050 { 0xaf, 0x2, 0x0, 0x50, 0x4, 0xa, 0xe1, 0x32 } }
00051 
00057 class SetDocTitleTxn : public EditTxn
00058 {
00059 public:
00060 
00061   static const nsIID& GetCID() { static const nsIID iid = SET_DOC_TITLE_TXN_CID; return iid; }
00062 
00063   virtual ~SetDocTitleTxn();
00064 
00065 
00070   NS_IMETHOD Init(nsIHTMLEditor  *aEditor,
00071                   const nsAString *aValue);
00072 private:
00073   SetDocTitleTxn();
00074   nsresult SetDocTitle(const nsAString& aTitle);
00075   nsresult SetDomTitle(const nsAString& aTitle);
00076 
00077 public:
00078   NS_IMETHOD DoTransaction(void);
00079 
00080   NS_IMETHOD UndoTransaction(void);
00081 
00082   NS_IMETHOD RedoTransaction(void);
00083 
00084   NS_IMETHOD Merge(nsITransaction *aTransaction, PRBool *aDidMerge);
00085 
00086   NS_IMETHOD GetIsTransient(PRBool *aIsTransient);
00087 
00088   NS_IMETHOD GetTxnDescription(nsAString& aTxnDescription);
00089 
00090 protected:
00091 
00093   nsIHTMLEditor*  mEditor;
00094   
00096   nsString    mValue;
00097 
00099   nsString    mUndoValue;
00100 
00102   PRPackedBool mIsTransient;
00103 
00104   friend class TransactionFactory;
00105 };
00106 
00107 #endif