| /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| * |
| * ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is |
| * Netscape Communications Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 1998 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsISupports.idl" |
| #include "nsICommandParams.idl" |
| |
| /** |
| * nsIControllerCommand |
| * |
| * A generic command interface. You can register an nsIControllerCommand |
| * with the nsIControllerCommandTable. |
| */ |
| |
| [scriptable, uuid(0eae9a46-1dd2-11b2-aca0-9176f05fe9db)] |
| interface nsIControllerCommand : nsISupports |
| { |
| |
| /** |
| * Returns true if the command is currently enabled. An nsIControllerCommand |
| * can implement more than one commands; say, a group of related commands |
| * (e.g. delete left/delete right). Because of this, the command name is |
| * passed to each method. |
| * |
| * @param aCommandName the name of the command for which we want the enabled |
| * state. |
| * @param aCommandContext a cookie held by the nsIControllerCommandTable, |
| * allowing the command to get some context information. |
| * The contents of this cookie are implementation-defined. |
| */ |
| boolean isCommandEnabled(in string aCommandName, in nsISupports aCommandContext); |
| |
| void getCommandStateParams(in string aCommandName, in nsICommandParams aParams, in nsISupports aCommandContext); |
| |
| /** |
| * Execute the name command. |
| * |
| * @param aCommandName the name of the command to execute. |
| * |
| * @param aCommandContext a cookie held by the nsIControllerCommandTable, |
| * allowing the command to get some context information. |
| * The contents of this cookie are implementation-defined. |
| */ |
| void doCommand(in string aCommandName, in nsISupports aCommandContext); |
| |
| void doCommandParams(in string aCommandName, in nsICommandParams aParams, in nsISupports aCommandContext); |
| |
| }; |
| |