Back to index

lightning-sunbird  0.9+nobinonly
nsMenuItemX.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.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 the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 #ifndef nsMenuItemX_h__
00039 #define nsMenuItemX_h__
00040 
00041 
00042 #include "nsIMenuItem.h"
00043 #include "nsString.h"
00044 #include "nsIMenuListener.h"
00045 #include "nsIChangeManager.h"
00046 #include "nsWeakReference.h"
00047 #include "nsIWidget.h"
00048 #include "nsAutoPtr.h"
00049 
00050 class nsIMenu;
00051 class nsMenuItemIcon;
00052 
00057 class nsMenuItemX : public nsIMenuItem_MOZILLA_1_8_BRANCH,
00058                     public nsIMenuListener,
00059                     public nsIChangeObserver,
00060                     public nsSupportsWeakReference
00061 {
00062 public:
00063   nsMenuItemX();
00064   virtual ~nsMenuItemX();
00065 
00066   // nsISupports
00067   NS_DECL_ISUPPORTS
00068   NS_DECL_NSICHANGEOBSERVER
00069 
00070   // nsIMenuItem Methods
00071   NS_IMETHOD Create ( nsIMenu* aParent, const nsString & aLabel, PRBool aIsSeparator,
00072                         EMenuItemType aItemType, PRBool aEnabled, 
00073                         nsIChangeManager* aManager, nsIDocShell* aShell, nsIContent* aNode ) ;
00074   NS_IMETHOD GetLabel(nsString &aText);
00075   NS_IMETHOD SetShortcutChar(const nsString &aText);
00076   NS_IMETHOD GetShortcutChar(nsString &aText);
00077   NS_IMETHOD GetEnabled(PRBool *aIsEnabled);
00078   NS_IMETHOD SetChecked(PRBool aIsEnabled);
00079   NS_IMETHOD GetChecked(PRBool *aIsEnabled);
00080   NS_IMETHOD GetMenuItemType(EMenuItemType *aIsCheckbox);
00081   NS_IMETHOD GetTarget(nsIWidget *& aTarget);
00082   NS_IMETHOD GetNativeData(void*& aData);
00083   NS_IMETHOD AddMenuListener(nsIMenuListener * aMenuListener);
00084   NS_IMETHOD RemoveMenuListener(nsIMenuListener * aMenuListener);
00085   NS_IMETHOD IsSeparator(PRBool & aIsSep);
00086 
00087   NS_IMETHOD DoCommand();
00088   NS_IMETHOD SetModifiers(PRUint8 aModifiers);
00089   NS_IMETHOD GetModifiers(PRUint8 * aModifiers);
00090   NS_IMETHOD SetupIcon();
00091 
00092   NS_IMETHOD DispatchDOMEvent(const nsString &eventName, PRBool *preventDefaultCalled);
00093  
00094   // nsIMenuListener interface
00095   nsEventStatus MenuItemSelected(const nsMenuEvent & aMenuEvent);
00096   nsEventStatus MenuSelected(const nsMenuEvent & aMenuEvent);
00097   nsEventStatus MenuDeselected(const nsMenuEvent & aMenuEvent);
00098   nsEventStatus MenuConstruct(const nsMenuEvent & aMenuEvent, nsIWidget * aParentWindow, 
00099                                 void * menuNode, void * aDocShell);
00100   nsEventStatus MenuDestruct(const nsMenuEvent & aMenuEvent);
00101   nsEventStatus CheckRebuild(PRBool & aMenuEvent);
00102   nsEventStatus SetRebuild(PRBool aMenuEvent);
00103 
00104 protected:
00105 
00106   void UncheckRadioSiblings ( nsIContent* inCheckedElement ) ;
00107 
00108   nsString        mLabel;
00109   nsString        mKeyEquivalent;
00110 
00111   nsIMenu*                  mMenuParent;          // weak, parent owns us
00112   nsIChangeManager*         mManager;             // weak
00113 
00114   nsCOMPtr<nsIWidget>       mTarget;              // never set?
00115   nsCOMPtr<nsIMenuListener> mXULCommandListener;
00116   
00117   nsWeakPtr                 mDocShellWeakRef;     // weak ref to docshell
00118   nsCOMPtr<nsIContent>      mContent;
00119   nsCOMPtr<nsIContent>      mCommandContent;
00120   nsRefPtr<nsMenuItemIcon>  mIcon;
00121   
00122   PRUint8           mModifiers;
00123   PRPackedBool      mIsSeparator;
00124   PRPackedBool      mEnabled;
00125   PRPackedBool      mIsChecked;
00126   EMenuItemType     mMenuType;
00127 };
00128 
00129 #endif // nsMenuItem_h__