Back to index

lightning-sunbird  0.9+nobinonly
nsIUrlListenerManager.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; 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) 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 #include "nsIUrlListener.idl"
00040 
00041 interface nsIMsgMailNewsUrl;
00042 %{C++
00043 #include "nsIMsgMailNewsUrl.h"
00044 %}
00045 
00046 /*
00047  * The url listener manager is a helper class used by all of our
00048  * subclassed urls to implement    registration and broadcasting of changes
00049  * to all of their registered url listeners. I envision every url
00050  * implementation to have a has a relationship with a nsIUrlListenerManager.
00051  * All url listener register/unregister calls are forwarded to the
00052  * listener manager. In addition, the url listener manager handles
00053  * broadcasting of event changes on the url.
00054  */
00055 
00056 [scriptable, uuid(5BCDB610-D00D-11d2-8069-006008128C4E)]
00057 interface nsIUrlListenerManager : nsISupports {
00058     void RegisterListener(in nsIUrlListener aUrlListener);
00059     void UnRegisterListener(in nsIUrlListener aUrlListener);
00060     
00061     // These functions turn around and broadcast the notifications to
00062     // all url listeners...
00063     
00064     void OnStartRunningUrl(in nsIMsgMailNewsUrl aUrl);
00065     void OnStopRunningUrl(in nsIMsgMailNewsUrl aUrl, in nsresult aExitCode);
00066 
00067 };
00068