Back to index

lightning-sunbird  0.9+nobinonly
nsIMenuFrame.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 
00038 #ifndef nsIMenuFrame_h___
00039 #define nsIMenuFrame_h___
00040 
00041 // {2281EFC8-A8BA-4a73-8CF7-DB4EECA5EAEC}
00042 #define NS_IMENUFRAME_IID \
00043 { 0x2281efc8, 0xa8ba, 0x4a73, { 0x8c, 0xf7, 0xdb, 0x4e, 0xec, 0xa5, 0xea, 0xec } };
00044 
00045 class nsIMenuParent;
00046 class nsIDOMElement;
00047 class nsIDOMKeyEvent;
00048 
00049 enum nsMenuType {
00050   eMenuType_Normal = 0,
00051   eMenuType_Checkbox = 1,
00052   eMenuType_Radio = 2
00053 };
00054 
00055 class nsIMenuFrame : public nsISupports {
00056 
00057 public:
00058   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IMENUFRAME_IID)
00059 
00060   NS_IMETHOD ActivateMenu(PRBool aActivate) = 0;
00061   NS_IMETHOD SelectMenu(PRBool aFlag) = 0;
00062   NS_IMETHOD OpenMenu(PRBool aFlag) = 0;
00063 
00064   NS_IMETHOD MenuIsOpen(PRBool& aResult) = 0;
00065   NS_IMETHOD MenuIsContainer(PRBool& aResult) = 0;
00066   NS_IMETHOD MenuIsChecked(PRBool& aResult) = 0;
00067   NS_IMETHOD MenuIsDisabled(PRBool& aResult) = 0;
00068 
00069   NS_IMETHOD SelectFirstItem() = 0;
00070 
00071   NS_IMETHOD Escape(PRBool& aHandledFlag) = 0;
00072   NS_IMETHOD Enter() = 0;
00073   NS_IMETHOD ShortcutNavigation(nsIDOMKeyEvent* aKeyEvent, PRBool& aHandledFlag) = 0;
00074   NS_IMETHOD KeyboardNavigation(PRUint32 aKeyCode, PRBool& aHandledFlag) = 0;
00075 
00076   virtual nsIMenuParent *GetMenuParent() = 0;
00077   virtual nsIFrame *GetMenuChild() = 0;
00078  
00079   NS_IMETHOD GetRadioGroupName(nsString &aName) = 0;
00080   NS_IMETHOD GetMenuType(nsMenuType &aType) = 0;
00081 
00082   NS_IMETHOD MarkAsGenerated() = 0;
00083 
00084   NS_IMETHOD UngenerateMenu() = 0;
00085 
00086   NS_IMETHOD GetActiveChild(nsIDOMElement** aResult)=0;
00087   NS_IMETHOD SetActiveChild(nsIDOMElement* aChild)=0;
00088 };
00089 
00090 #endif
00091