Back to index

lightning-sunbird  0.9+nobinonly
nsNewsDatabase.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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) 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 #ifndef _nsNewsDatabase_H_
00038 #define _nsNewsDatabase_H_
00039 
00040 #include "nsMsgDatabase.h"
00041 #include "nsINewsDatabase.h"
00042 
00043 class nsIDBChangeListener;
00044 class nsMsgKeyArray;
00045 class MSG_RetrieveArtInfo;
00046 class MSG_PurgeInfo;
00047 // news group database
00048 
00049 class nsNewsDatabase : public nsMsgDatabase , public nsINewsDatabase
00050 {
00051 public:
00052   nsNewsDatabase();
00053   virtual ~nsNewsDatabase();
00054 
00055   NS_DECL_ISUPPORTS_INHERITED 
00056   NS_DECL_NSINEWSDATABASE
00057 
00058   NS_IMETHOD Close(PRBool forceCommit);
00059   NS_IMETHOD ForceClosed();
00060   NS_IMETHOD Commit(nsMsgDBCommit commitType);
00061   virtual PRUint32 GetCurVersion();
00062 
00063   // methods to get and set docsets for ids.
00064   NS_IMETHOD  IsRead(nsMsgKey key, PRBool *pRead);
00065   virtual nsresult  IsHeaderRead(nsIMsgDBHdr *msgHdr, PRBool *pRead);
00066 
00067   NS_IMETHOD         GetHighWaterArticleNum(nsMsgKey *key);
00068   NS_IMETHOD         GetLowWaterArticleNum(nsMsgKey *key);
00069   NS_IMETHOD         MarkAllRead(nsMsgKeyArray *thoseMarked);
00070 
00071   virtual nsresult    ExpireUpTo(nsMsgKey expireKey);
00072   virtual nsresult    ExpireRange(nsMsgKey startRange, nsMsgKey endRange);
00073  
00074   virtual PRBool      SetHdrReadFlag(nsIMsgDBHdr *msgHdr, PRBool bRead);
00075  
00076   virtual nsresult  AdjustExpungedBytesOnDelete(nsIMsgDBHdr *msgHdr);
00077   nsresult          SyncWithReadSet();
00078   
00079   NS_IMETHOD GetDefaultViewFlags(nsMsgViewFlagsTypeValue *aDefaultViewFlags);
00080   NS_IMETHOD GetDefaultSortType(nsMsgViewSortTypeValue *aDefaultSortType);
00081   NS_IMETHOD GetDefaultSortOrder(nsMsgViewSortOrderValue *aDefaultSortOrder);
00082 
00083 protected:
00084   // this is owned by the nsNewsFolder, which lives longer than the db.
00085   nsMsgKeySet           *m_readSet;
00086 };
00087 
00088 #endif