Back to index

lightning-sunbird  0.9+nobinonly
nsMsgXFVirtualFolderDBView.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) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   David Bienvenu <bienvenu@nventure.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef _nsMsgXFVirtualFolderDBView_H_
00040 #define _nsMsgXFVirtualFolderDBView_H_
00041 
00042 #include "nsMsgSearchDBView.h"
00043 #include "nsIMsgCopyServiceListener.h"
00044 #include "nsIMsgSearchNotify.h"
00045 #include "nsCOMArray.h"
00046 
00047 class nsMsgXFVirtualFolderDBView : public nsMsgSearchDBView
00048 {
00049 public:
00050   nsMsgXFVirtualFolderDBView();
00051   virtual ~nsMsgXFVirtualFolderDBView();
00052 
00053   NS_IMETHOD SetSearchSession(nsIMsgSearchSession *aSearchSession);
00054   // we override all the methods, currently. Might change...
00055   NS_DECL_NSIMSGSEARCHNOTIFY
00056 
00057   virtual const char * GetViewName(void) {return "XFVirtualFolderView"; }
00058   NS_IMETHOD Open(nsIMsgFolder *folder, nsMsgViewSortTypeValue sortType, nsMsgViewSortOrderValue sortOrder, 
00059         nsMsgViewFlagsTypeValue viewFlags, PRInt32 *pCount);
00060   NS_IMETHOD CloneDBView(nsIMessenger *aMessengerInstance, nsIMsgWindow *aMsgWindow, 
00061                          nsIMsgDBViewCommandUpdater *aCmdUpdater, nsIMsgDBView **_retval);
00062   NS_IMETHOD CopyDBView(nsMsgDBView *aNewMsgDBView, nsIMessenger *aMessengerInstance, 
00063                         nsIMsgWindow *aMsgWindow, nsIMsgDBViewCommandUpdater *aCmdUpdater);
00064   NS_IMETHOD Close();
00065   NS_IMETHOD GetViewType(nsMsgViewTypeValue *aViewType);
00066   NS_IMETHOD DoCommand(nsMsgViewCommandTypeValue command);
00067   virtual nsresult OnNewHeader(nsIMsgDBHdr *newHdr, nsMsgKey parentKey, PRBool ensureListed);
00068   virtual nsresult InsertHdrFromFolder(nsIMsgDBHdr *msgHdr, nsISupports *folder);
00069   NS_IMETHOD GetMsgFolder(nsIMsgFolder **aMsgFolder);
00070   void UpdateCacheAndViewForPrevSearchedFolders(nsIMsgFolder *curSearchFolder);
00071   void UpdateCacheAndViewForFolder(nsIMsgFolder *folder, nsMsgKey *newHits, PRUint32 numNewHits);
00072   void RemovePendingDBListeners();
00073 
00074 protected:
00075 
00076   PRUint32 m_cachedFolderArrayIndex; // array index of next folder with cached hits to deal with.
00077   nsCOMArray<nsIMsgFolder> m_foldersSearchingOver;
00078   nsCOMArray<nsIMsgDBHdr> m_hdrHits;
00079   nsCOMPtr <nsIMsgFolder> m_curFolderGettingHits;
00080   PRUint32 m_curFolderStartKeyIndex; // keeps track of the index of the first hit from the cur folder
00081   PRBool m_curFolderHasCachedHits;
00082   PRBool m_doingSearch;
00083   nsWeakPtr m_searchSession;
00084 };
00085 
00086 #endif