Back to index

lightning-sunbird  0.9+nobinonly
nsLocalFolderSummarySpec.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 
00038 #ifndef _nsLocalFolderSummarySpec_H
00039 #define _nsLocalFolderSummarySpec_H
00040 
00041 #include "msgCore.h"
00042 #include "nsFileSpec.h"
00043 
00044 // Class to name a summary file for a local mail folder,
00045 // given a full folder file spec. For windows, this just means tacking .msf on the end.
00046 // For Unix, it might mean something like putting a '.' on the front and .msgsummary on the end.
00047 // Note this class expects the invoking code to fully specify the folder path. 
00048 // This class does NOT prepend the local folder directory, or put .sbd on the containing
00049 // directory names.
00050 class NS_MSG_BASE nsLocalFolderSummarySpec : public nsFileSpec
00051 {
00052 public:
00053                      virtual ~nsLocalFolderSummarySpec();
00054                      nsLocalFolderSummarySpec();
00055                      nsLocalFolderSummarySpec(const char *folderPath, PRBool create = PR_FALSE);
00056                      nsLocalFolderSummarySpec(const nsFileSpec& inFolderPath);
00057                      nsLocalFolderSummarySpec(const nsFilePath &inFolderPath, PRBool create = PR_FALSE);
00058                      void SetFolderName(const char *folderPath);
00059 
00060 protected:
00061        void   CreateSummaryFileName();
00062 
00063 };
00064 
00065 #endif