Back to index

lightning-sunbird  0.9+nobinonly
nsMsgTxn.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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
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 nsMsgTxn_h__
00039 #define nsMsgTxn_h__
00040 
00041 #include "nsITransaction.h"
00042 #include "msgCore.h"
00043 #include "nsCOMPtr.h"
00044 #include "nsIMsgWindow.h"
00045 #include "nsHashPropertyBag.h"
00046 
00047 #define NS_MESSAGETRANSACTION_IID \
00048 { /* da621b30-1efc-11d3-abe4-00805f8ac968 */ \
00049     0xda621b30, 0x1efc, 0x11d3, \
00050        { 0xab, 0xe4, 0x00, 0x80, 0x5f, 0x8a, 0xc9, 0x68 } }
00051 
00055 #undef  IMETHOD_VISIBILITY
00056 #define IMETHOD_VISIBILITY NS_VISIBILITY_DEFAULT
00057 
00058 class NS_MSG_BASE nsMsgTxn : public nsITransaction, public nsHashPropertyBag
00059 {
00060     NS_DECL_ISUPPORTS_INHERITED
00061 
00062     nsMsgTxn();
00063     virtual ~nsMsgTxn();
00064 
00065     NS_IMETHOD DoTransaction(void);
00066 
00067     NS_IMETHOD UndoTransaction(void) = 0;
00068 
00069     NS_IMETHOD RedoTransaction(void) = 0;
00070     
00071     NS_IMETHOD GetIsTransient(PRBool *aIsTransient);
00072 
00073     NS_IMETHOD Merge(nsITransaction *aTransaction, PRBool *aDidMerge);
00074 
00075     nsresult GetMsgWindow(nsIMsgWindow **msgWindow);
00076     nsresult SetMsgWindow(nsIMsgWindow *msgWindow);
00077     nsresult SetTransactionType(PRUint32 txnType);
00078  
00079 protected:
00080     nsCOMPtr<nsIMsgWindow> m_msgWindow;
00081     PRUint32 m_txnType;
00082     nsresult CheckForToggleDelete(nsIMsgFolder *aFolder, const nsMsgKey &aMsgKey, PRBool *aResult);
00083 };
00084 
00085 #undef  IMETHOD_VISIBILITY
00086 #define IMETHOD_VISIBILITY NS_VISIBILITY_HIDDEN
00087 
00088 #endif