Back to index

lightning-sunbird  0.9+nobinonly
nsIController.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; 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 [scriptable, uuid(D5B61B82-1DA4-11d3-BF87-00105A1B0627)]
00041 interface nsIController : nsISupports {
00042        boolean isCommandEnabled(in string command);
00043        boolean supportsCommand(in string command);
00044 
00045        void doCommand(in string command);
00046 
00047        void onEvent(in string eventName);
00048 };
00049 
00050 
00051 /*
00052 
00053   Enhanced controller interface that allows for passing of parameters
00054   to commands.
00055   
00056 */
00057 
00058 interface nsICommandParams;
00059 
00060 [scriptable, uuid(EBE55080-C8A9-11D5-A73C-DD620D6E04BC)]
00061 interface nsICommandController : nsISupports
00062 {
00063   
00064   void        getCommandStateWithParams( in string command, in nsICommandParams aCommandParams);
00065     
00066   void        doCommandWithParams(in string command, in nsICommandParams aCommandParams);
00067 
00068 };
00069 
00070 
00071 /*
00072   An API for registering commands in groups, to allow for 
00073   updating via nsIDOMWindowInternal::UpdateCommands.
00074 */
00075 interface nsISimpleEnumerator;
00076 
00077 [scriptable, uuid(9F82C404-1C7B-11D5-A73C-ECA43CA836FC)]
00078 interface nsIControllerCommandGroup : nsISupports
00079 {
00080 
00081   void  addCommandToGroup(in string aCommand, in string aGroup);
00082   void  removeCommandFromGroup(in string aCommand, in string aGroup);
00083   
00084   boolean isCommandInGroup(in string aCommand, in string aGroup);
00085 
00086   /*
00087     We should expose some methods that allow for enumeration.
00088   */
00089   nsISimpleEnumerator getGroupsEnumerator();
00090   
00091   nsISimpleEnumerator getEnumeratorForGroup(in string aGroup);
00092 
00093 };
00094