Back to index

lightning-sunbird  0.9+nobinonly
nsINNTPNewsgroupList.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 /* this interface is basically for the old ListNewsGroupState class
00039  * (the implementation of this class probably wants to also implement
00040  * or contain ChangeListener so that it can react to OnAnnouncerGoingAway()
00041  * to destroy the DBView)
00042  */
00043 #include "nsISupports.idl"
00044 
00045 interface nsIMsgNewsFolder;
00046 interface nsINntpUrl;
00047 interface nsIMsgWindow;
00048 
00049 [scriptable, uuid(E628ED19-9452-11d2-B7EA-00805F05FFA5)]
00050 interface nsINNTPNewsgroupList : nsISupports {
00051   
00052   void initialize(in nsINntpUrl runningURL, in nsIMsgNewsFolder newsFolder);
00053   
00054   long getRangeOfArtsToDownload(in nsIMsgWindow aMsgWindow, in long first_message,
00055                                 in long last_message,
00056                                 in long maxextra,
00057                                 out long real_first_message,
00058                                 out long real_last_message);
00059   
00060   void addToKnownArticles(in long first_message, in long last_message);
00061 
00062 
00063   /* The NNTP module of netlib calls these to feed XOVER data to the message
00064      library, in response to a news:group.name URL having been opened.
00065      If MSG_FinishXOVER() returns a message ID, that message will be loaded
00066      next (used for selecting the first unread message in a group after
00067      listing that group.)
00068 
00069      deprecated:
00070      The "out" arguments are (if non-NULL) a file descriptor to write the XOVER
00071      line to, followed by a "\n".  This is used by the XOVER-caching code.
00072   */
00073   /* the XOVER Sink should maintain the ListNewsGroupState */
00074   void initXOVER(in long first_message, in long last_message);  
00075   void processXOVERLINE(in string line, out unsigned long status);
00076   void processNonXOVER(in string line);
00077   void resetXOVER();
00078   void finishXOVERLINE(in long status, out long newstatus);
00079   void clearXOVERState();
00080 
00081   attribute boolean getOldMessages;
00082 };
00083