content/xul/document/public/nsIController.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 [scriptable, uuid(D5B61B82-1DA4-11d3-BF87-00105A1B0627)]
  41 interface nsIController : nsISupports {
  42         boolean isCommandEnabled(in string command);
  43         boolean supportsCommand(in string command);
  44
  45         void doCommand(in string command);
  46
  47         void onEvent(in string eventName);
  48 };
  49
  50
  51 /*
  52
  53   Enhanced controller interface that allows for passing of parameters
  54   to commands.
  55
  56 */
  57
  58 interface nsICommandParams;
  59
  60 [scriptable, uuid(EBE55080-C8A9-11D5-A73C-DD620D6E04BC)]
  61 interface nsICommandController : nsISupports
  62 {
  63
  64   void        getCommandStateWithParams( in string command, in nsICommandParams aCommandParams);
  65
  66   void        doCommandWithParams(in string command, in nsICommandParams aCommandParams);
  67
  68 };
  69
  70
  71 /*
  72   An API for registering commands in groups, to allow for
  73   updating via nsIDOMWindowInternal::UpdateCommands.
  74 */
  75 interface nsISimpleEnumerator;
  76
  77 [scriptable, uuid(9F82C404-1C7B-11D5-A73C-ECA43CA836FC)]
  78 interface nsIControllerCommandGroup : nsISupports
  79 {
  80
  81   void  addCommandToGroup(in string aCommand, in string aGroup);
  82   void  removeCommandFromGroup(in string aCommand, in string aGroup);
  83
  84   boolean isCommandInGroup(in string aCommand, in string aGroup);
  85
  86   /*
  87     We should expose some methods that allow for enumeration.
  88   */
  89   nsISimpleEnumerator getGroupsEnumerator();
  90
  91   nsISimpleEnumerator getEnumeratorForGroup(in string aGroup);
  92
  93 };
  94