gecko-dev/widget/public/nsIMenu.h

187 lines
3.7 KiB
C
Raw Normal View History

1998-09-28 22:37:16 +00:00
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#ifndef nsIMenu_h__
#define nsIMenu_h__
#include "nsISupports.h"
#include "nsString.h"
#include "nsIDOMNode.h"
#include "nsIDOMElement.h"
#include "nsIWebShell.h"
1998-09-28 22:37:16 +00:00
class nsIMenuBar;
class nsIMenu;
1998-10-07 19:49:36 +00:00
class nsIMenuItem;
1999-03-01 17:08:13 +00:00
class nsIMenuListener;
1998-09-28 22:37:16 +00:00
// {35A3DEC1-4992-11d2-8DBA-00609703C14E}
#define NS_IMENU_IID \
{ 0x35a3dec1, 0x4992, 0x11d2, \
{ 0x8d, 0xba, 0x0, 0x60, 0x97, 0x3, 0xc1, 0x4e } }
/**
* Menu widget
*/
class nsIMenu : public nsISupports {
public:
NS_DEFINE_STATIC_IID_ACCESSOR(NS_IMENU_IID)
1999-03-03 15:17:33 +00:00
/**
1999-03-20 02:28:14 +00:00
* Creates the Menu
1998-09-28 22:37:16 +00:00
*
*/
1999-03-20 02:28:14 +00:00
NS_IMETHOD Create(nsISupports * aParent, const nsString &aLabel) = 0;
1998-10-07 19:49:36 +00:00
/**
* Get the Menu's Parent
*
*/
NS_IMETHOD GetParent(nsISupports *&aParent) = 0;
1998-09-28 22:37:16 +00:00
/**
* Get the Menu label
*
*/
NS_IMETHOD GetLabel(nsString &aText) = 0;
/**
* Set the Menu label
*
*/
1999-03-20 02:28:14 +00:00
NS_IMETHOD SetLabel(const nsString &aText) = 0;
1999-07-02 02:11:10 +00:00
/**
* Get the Menu Access Key
*
*/
NS_IMETHOD GetAccessKey(nsString &aText) = 0;
/**
* Set the Menu Access Key
*
*/
NS_IMETHOD SetAccessKey(const nsString &aText) = 0;
/**
* Set the Menu enabled state
*
*/
NS_IMETHOD SetEnabled(PRBool aIsEnabled) = 0;
/**
* Get the Menu enabled state
*
*/
NS_IMETHOD GetEnabled(PRBool* aIsEnabled) = 0;
/**
* Query if this is the help menu. Mostly for MacOS voodoo.
*
*/
NS_IMETHOD IsHelpMenu(PRBool* aIsHelpMenu) = 0;
1999-07-02 02:11:10 +00:00
/**
1998-09-28 22:37:16 +00:00
* Adds a Menu Item
*
*/
1999-03-20 02:28:14 +00:00
NS_IMETHOD AddItem(nsISupports* aItem) = 0;
1998-09-28 22:37:16 +00:00
/**
1999-03-20 02:28:14 +00:00
* Adds a separator
1998-09-28 22:37:16 +00:00
*
*/
NS_IMETHOD AddSeparator() = 0;
/**
* Returns the number of menu items
1999-03-20 02:28:14 +00:00
* This does count separators as items
1998-09-28 22:37:16 +00:00
*/
NS_IMETHOD GetItemCount(PRUint32 &aCount) = 0;
/**
* Returns a Menu or Menu Item at a specified Index
1998-09-28 22:37:16 +00:00
*
*/
NS_IMETHOD GetItemAt(const PRUint32 aPos, nsISupports *& aMenuItem) = 0;
1998-09-28 22:37:16 +00:00
/**
* Inserts a Menu Item at a specified Index
*
*/
NS_IMETHOD InsertItemAt(const PRUint32 aPos, nsISupports * aMenuItem) = 0;
1998-09-28 22:37:16 +00:00
/**
* Removes an Menu Item from a specified Index
*
*/
NS_IMETHOD RemoveItem(const PRUint32 aPos) = 0;
1998-09-28 22:37:16 +00:00
/**
* Removes all the Menu Items
*
*/
NS_IMETHOD RemoveAll() = 0;
/**
* Gets Native MenuHandle
*
*/
1999-03-20 02:28:14 +00:00
NS_IMETHOD GetNativeData(void** aData) = 0;
1999-03-01 16:22:40 +00:00
/**
* Sets Native MenuHandle
*
*/
NS_IMETHOD SetNativeData(void* aData) = 0;
1999-03-01 16:22:40 +00:00
/**
1999-03-20 02:28:14 +00:00
* Adds menu listener for dynamic construction
1999-03-01 16:22:40 +00:00
*
*/
NS_IMETHOD AddMenuListener(nsIMenuListener * aMenuListener) = 0;
/**
1999-03-20 02:28:14 +00:00
* Removes menu listener for dynamic construction
1999-03-01 16:22:40 +00:00
*
*/
NS_IMETHOD RemoveMenuListener(nsIMenuListener * aMenuListener) = 0;
/**
* Set DOMNode
*
*/
NS_IMETHOD SetDOMNode(nsIDOMNode * aMenuNode) = 0;
/**
* Set DOMElement
*
*/
NS_IMETHOD SetDOMElement(nsIDOMElement * aMenuElement) = 0;
/**
* Set WebShell
*
*/
NS_IMETHOD SetWebShell(nsIWebShell * aWebShell) = 0;
1998-09-28 22:37:16 +00:00
};
#endif