/embedding/components/commandhandler/public/nsPICommandUpdater.idl

 1/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 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 *   Simon Fraser <sfraser@netscape.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39#include "nsISupports.idl"
40#include "domstubs.idl"
41
42/*
43	The nsPICommandUpdater interface is used by modules that implement
44	commands, to tell the command manager that commands need updating.
45	This is a private interface; embedders should not use it.
46	
47	Command-implementing modules should get one of these by a QI
48	from an nsICommandManager.
49*/
50
51[scriptable, uuid(B135F602-0BFE-11D5-A73C-F0E420E8293C)]
52interface nsPICommandUpdater : nsISupports
53{
54
55  /*
56   * Init the command updater, passing an nsIDOMWindow which 
57   * is the window that the command updater lives on.
58   * 
59   */
60  void    init(in nsIDOMWindow aWindow);
61   
62  /*
63   * Notify the command manager that the status of a command
64   * changed. It may have changed from enabled to disabled,
65   * or vice versa, or become toggled etc.
66   */
67	void		commandStatusChanged(in string aCommandName);
68	
69};
70
71