Back to index

lightning-sunbird  0.9+nobinonly
nsIXULCommand.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 Communicator client 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 #ifndef nsIXULCommand_h___
00038 #define nsIXULCommand_h___
00039 
00040 #include "nsIMenuListener.h"
00041 #include "nsString.h"
00042 #include "nsIDOMElement.h"
00043 #include "nsIDocShell.h"
00044 class nsIDOMNode;
00045 class nsIFactory;
00046 class nsIMenuItem;
00047 
00048 // Interface ID for nsIXULCommand
00049 #define NS_IXULCOMMAND_IID \
00050  { 0xabf645a1, 0xb3d0, 0x11d2, { 0x9a, 0x42, 0x0, 0x0, 0x64, 0x65, 0x73, 0x74}}
00051 
00052 // Class ID for an implementation of nsIXULCommand
00053 #define NS_XULCOMMAND_CID \
00054  { 0xabf645a1, 0xb3d0, 0x11d2, { 0x9a, 0x42, 0x0, 0x0, 0x64, 0x65, 0x73, 0x74}}
00055 
00056 
00057 //----------------------------------------------------------------------
00058 
00059 
00060 class nsIXULCommand : public nsIMenuListener {
00061 public:
00062 
00063   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXULCOMMAND_IID)
00064 
00065   
00070   NS_IMETHOD SetMenuItem(nsIMenuItem * aMenuItem) = 0;
00071 
00077   NS_IMETHOD AttributeHasBeenSet(const nsString & aAttr) = 0;
00078 
00084   NS_IMETHOD SetCommand(const nsString & aStrCmd) = 0;
00085 
00090   NS_IMETHOD DoCommand() = 0;
00091 
00092   NS_IMETHOD SetDOMElement(nsIDOMElement * aDOMElement) = 0;
00093   NS_IMETHOD GetDOMElement(nsIDOMElement ** aDOMElement) = 0;
00094   NS_IMETHOD SetDocShell(nsIDocShell * aDocShell) = 0;
00095 };
00096 
00097 
00098 extern "C" nsresult
00099 NS_NewXULCommandFactory(nsIFactory** aFactory);
00100 
00101 #endif /* nsIXULCommand_h___ */