widget/src/cocoa/nsMenuItemX.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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  *   Josh Aas <josh@mozilla.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsMenuItemX_h_
  40 #define nsMenuItemX_h_
  41
  42 #include "nsMenuBaseX.h"
  43 #include "nsMenuGroupOwnerX.h"
  44 #include "nsChangeObserver.h"
  45 #include "nsAutoPtr.h"
  46
  47 #import <Cocoa/Cocoa.h>
  48
  49 class nsString;
  50 class nsMenuItemIconX;
  51 class nsMenuX;
  52
  53 enum {
  54   knsMenuItemNoModifier      = 0,
  55   knsMenuItemShiftModifier   = (1 << 0),
  56   knsMenuItemAltModifier     = (1 << 1),
  57   knsMenuItemControlModifier = (1 << 2),
  58   knsMenuItemCommandModifier = (1 << 3)
  59 };
  60
  61 enum EMenuItemType {
  62   eRegularMenuItemType = 0,
  63   eCheckboxMenuItemType,
  64   eRadioMenuItemType,
  65   eSeparatorMenuItemType
  66 };
  67
  68
  69 // Once instantiated, this object lives until its DOM node or its parent window is destroyed.
  70 // Do not hold references to this, they can become invalid any time the DOM node can be destroyed.
  71 class nsMenuItemX : public nsMenuObjectX,
  72                     public nsChangeObserver
  73 {
  74 public:
  75   nsMenuItemX();
  76   virtual ~nsMenuItemX();
  77
  78   NS_DECL_CHANGEOBSERVER
  79
  80   // nsMenuObjectX
  81   void*             NativeData()     {return (void*)mNativeMenuItem;}
  82   nsMenuObjectTypeX MenuObjectType() {return eMenuItemObjectType;}
  83
  84   // nsMenuItemX
  85   nsresult      Create(nsMenuX* aParent, const nsString& aLabel, EMenuItemType aItemType,
  86                        nsMenuGroupOwnerX* aMenuGroupOwner, nsIContent* aNode);
  87   nsresult      SetChecked(PRBool aIsChecked);
  88   EMenuItemType GetMenuItemType();
  89   void          DoCommand();
  90   nsresult      DispatchDOMEvent(const nsString &eventName, PRBool* preventDefaultCalled);
  91   void          SetupIcon();
  92
  93 protected:
  94   void UncheckRadioSiblings(nsIContent* inCheckedElement);
  95   void SetKeyEquiv(PRUint8 aModifiers, const nsString &aText);
  96
  97   EMenuItemType             mType;
  98   // nsMenuItemX objects should always have a valid native menu item.
  99   NSMenuItem*               mNativeMenuItem;      // [strong]
 100   nsMenuX*                  mMenuParent;          // [weak]
 101   nsMenuGroupOwnerX*        mMenuGroupOwner;      // [weak]
 102   nsCOMPtr<nsIContent>      mCommandContent;
 103   // The icon object should never outlive its creating nsMenuItemX object.
 104   nsRefPtr<nsMenuItemIconX> mIcon;
 105   PRBool                    mIsChecked;
 106 };
 107
 108 #endif // nsMenuItemX_h_