Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgGroupRecord.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; 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 #include "nsISupports.idl"
00039 
00040 
00041 [scriptable, uuid(4ed03c60-b256-11d2-b7f0-00805f05ffa5)]
00042 interface nsIMsgGroupRecord : nsISupports {
00043 
00044     /* making this a voidPtr is really ugly, but it's a quick
00045      * solution right now
00046      */
00047     [noscript] void Init(in voidPtr parent,
00048                          in string partname,
00049                          in long long time,
00050                          in long uniqueid,
00051                          in long fileoffset,
00052                          in char delimiter);
00053     
00054     void InitFromParent(in nsIMsgGroupRecord parent,
00055                         in string saveline,
00056                         in long savelinelength,
00057                         in long fileoffset);
00058     
00059     void InitFromFile(in nsIMsgGroupRecord parent,
00060                       in string partname,
00061                       in long long time,
00062                       in long uniqueid,
00063                       in long fileoffset);
00064     
00065     void InitializeSibling();
00066     
00067     short GroupNameCompare(in string name1,
00068                            in string name2,
00069                            in char delimiter,
00070                            in boolean caseSensitive);
00071 
00072     nsIMsgGroupRecord FindDescendent(in string name);
00073     
00074     readonly attribute nsIMsgGroupRecord parent;
00075     readonly attribute nsIMsgGroupRecord children;
00076     readonly attribute nsIMsgGroupRecord sibling;
00077     nsIMsgGroupRecord GetSiblingOrAncestorSibling();
00078     nsIMsgGroupRecord GetNextAlphabetic();
00079     nsIMsgGroupRecord GetNextAlphabeticNoCategories();
00080 
00081     readonly attribute string partName;
00082     readonly attribute string fullName;
00083 
00084     attribute string prettyName;
00085     readonly attribute long long addTime;
00086 
00087     readonly attribute boolean isCategory;
00088     
00089     attribute boolean isCategoryContainer;
00090 
00091     readonly attribute nsIMsgGroupRecord categoryContainer;
00092     
00093     attribute boolean isVirtual;
00094     attribute boolean isGroup;
00095     
00096     attribute boolean isExpanded;
00097     attribute boolean isDescendentsLoaded;
00098     attribute boolean HTMLOkGroup;
00099     attribute boolean HTMLOkTree;
00100     attribute boolean needsExtraInfo;
00101     attribute boolean doesNotExistOnServer;
00102     readonly attribute long uniqueID;
00103     attribute long fileOffset;
00104 
00105     readonly attribute long numKids;
00106     readonly attribute string saveString;
00107 
00108     readonly attribute boolean dirty;
00109 
00110     readonly attribute long depth;
00111 
00112     readonly attribute char hierarchySeparator;
00113     
00114     
00115 };
00116