/gecko_sdk/idl/nsIObserver.idl

 1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 2/* ***** BEGIN LICENSE BLOCK *****
 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 4 *
 5 * The contents of this file are subject to the Mozilla Public License Version
 6 * 1.1 (the "License"); you may not use this file except in compliance with
 7 * the License. You may obtain a copy of the License at
 8 * http://www.mozilla.org/MPL/
 9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either of the GNU General Public License Version 2 or later (the "GPL"),
26 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38#include "nsISupports.idl"
39
40/**
41 * This interface is implemented by an object that wants
42 * to observe an event corresponding to a topic.
43 *
44 * @status FROZEN
45 */
46
47[scriptable, uuid(DB242E01-E4D9-11d2-9DDE-000064657374)]
48interface nsIObserver : nsISupports {
49
50   /**
51    * Observe will be called when there is a notification for the
52    * topic |aTopic|.  This assumes that the object implementing
53    * this interface has been registered with an observer service
54    * such as the nsIObserverService. 
55    *
56    * If you expect multiple topics/subjects, the impl is 
57    * responsible for filtering.
58    *
59    * You should not modify, add, remove, or enumerate 
60    * notifications in the implemention of observe. 
61    *
62    * @param aSubject : Notification specific interface pointer.
63    * @param aTopic   : The notification topic or subject.
64    * @param aData    : Notification specific wide string.
65    *                    subject event.
66    */
67    void observe( in nsISupports aSubject,
68				  in string      aTopic,
69				  in wstring     aData );
70
71};
72