Back to index

lightning-sunbird  0.9+nobinonly
nsIMAPGroupRecord.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 // This class should only be used by the subscribe UI and by newshost.cpp.
00039 // And, well, a bit by the category code.  Everyone else should use the stuff
00040 // in newshost.h.
00041 
00042 #ifndef _nsIMAPGroupRecord_h__
00043 #define _nsIMAPGroupRecord_h__
00044 
00045 #include "nsMsgGroupRecord.h"
00046 #include "prlog.h"
00047 
00048 class nsIMAPGroupRecord : public nsMsgGroupRecord {
00049 
00050 
00051 public:
00052        static nsIMAPGroupRecord* Create(nsIMAPGroupRecord* parent,
00053                                                                       const char* folderName,
00054                                                                       char delimiter,
00055                                                                       PRBool filledInGroup,
00056                                                                       PRBool folderIsNamespace);
00057 
00058        static nsIMAPGroupRecord* CreateFromPartname(nsIMAPGroupRecord* parent, const char* partname, char delimiter,
00059               PRBool filledInGroup);
00060 
00061        virtual PRBool IsCategory() { return PR_FALSE;}
00062        virtual PRBool IsCategoryContainer() { return PR_FALSE; }
00063        virtual int SetIsCategoryContainer(PRBool /* value */) { PR_ASSERT(0); return 0; }
00064        virtual PRBool IsIMAPGroupRecord() { return PR_TRUE; }
00065        virtual nsIMAPGroupRecord *GetIMAPGroupRecord() { return this; }
00066 
00067        virtual PRBool IsGroup() { return PR_TRUE; }
00068 
00069        virtual char GetHierarchySeparator() { return m_onlineDelimiter; }
00070        void SetHierarchySeparator(char delimiter) { m_onlineDelimiter = delimiter; }
00071 
00072        PRBool GetAllGrandChildrenDiscovered() { return m_allGrandChildrenDiscovered; }
00073        void SetAllGrandChildrenDiscovered(PRBool discovered) { m_allGrandChildrenDiscovered = discovered; }
00074 
00075        PRBool GetIsGroupFilledIn() { return m_filledInGroup; }
00076        void SetIsGroupFilledIn(PRBool filledIn) { m_filledInGroup = filledIn; }
00077 
00078        void SetFlags(PRUint32 flags) { m_flags = flags; }
00079        PRUint32 GetFlags() { return m_flags; }
00080 
00081        void          SetFolderIsNamespace(PRBool isNamespace) { m_folderIsNamespace = isNamespace; }
00082        PRBool        GetFolderIsNamespace() { return m_folderIsNamespace; }
00083 
00084        PRBool        GetCanToggleSubscribe();
00085 
00086 protected:
00087        nsIMAPGroupRecord(nsIMAPGroupRecord* parent, const char* partname, char delimiter, PRBool filledInGroup);
00088 
00089        PRBool m_allGrandChildrenDiscovered;
00090        PRBool m_filledInGroup;
00091        PRBool m_folderIsNamespace;
00092        char   m_onlineDelimiter;
00093        PRUint32 m_flags;
00094 
00095 };
00096 
00097 
00098 #endif
00099