wxMenuItem Class Reference
[Menus]

#include <wx/menuitem.h>

Inheritance diagram for wxMenuItem:

Detailed Description

A menu item represents an item in a menu.

Note that you usually don't have to deal with it directly as wxMenu methods usually construct an object of this class for you.

Also please note that the methods related to fonts and bitmaps are currently only implemented for Windows, Mac and GTK+.

Library: wxCore

Category: Menus

See also:: wxMenuBar, wxMenu


Public Member Functions
	wxMenuItem (wxMenu parentMenu=NULL, int id=wxID_SEPARATOR, const wxString &text=wxEmptyString, const wxString &helpString=wxEmptyString, wxItemKind kind=wxITEM_NORMAL, wxMenu subMenu=NULL)
virtual	~wxMenuItem ()
virtual void	Check (bool check=true)
virtual void	Enable (bool enable=true)
wxColour	GetBackgroundColour () const
virtual const wxBitmap &	GetBitmap () const
wxFont	GetFont () const
const wxString &	GetHelp () const
int	GetId () const
virtual wxString	GetItemLabel () const
virtual wxString	GetItemLabelText () const
wxItemKind	GetKind () const
wxString	GetLabel () const
int	GetMarginWidth () const
wxMenu *	GetMenu () const
wxString	GetName () const
wxMenu *	GetSubMenu () const
const wxString &	GetText () const
wxColour	GetTextColour () const
bool	IsCheckable () const
virtual bool	IsChecked () const
virtual bool	IsEnabled () const
bool	IsSeparator () const
bool	IsSubMenu () const
void	SetBackgroundColour (const wxColour &colour) const
virtual void	SetBitmap (const wxBitmap &bmp)
void	SetBitmaps (const wxBitmap &checked, const wxBitmap &unchecked=wxNullBitmap)
void	SetFont (const wxFont &font)
void	SetHelp (const wxString &helpString)
virtual void	SetItemLabel (const wxString &label)
void	SetMarginWidth (int width) const
void	SetMenu (wxMenu *menu)
void	SetSubMenu (wxMenu *menu)
virtual void	SetText (const wxString &text)
void	SetTextColour (const wxColour &colour)
Static Public Member Functions
static wxString	GetLabelFromText (const wxString &text)
static wxString	GetLabelText (const wxString &text)

Constructor & Destructor Documentation

wxMenuItem::wxMenuItem	(	wxMenu *	parentMenu = `NULL`,
		int	id = `wxID_SEPARATOR`,
		const wxString &	text = `wxEmptyString`,
		const wxString &	helpString = `wxEmptyString`,
		wxItemKind	kind = `wxITEM_NORMAL`,
		wxMenu *	subMenu = `NULL`
	)

Constructs a wxMenuItem object.

Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see Stock items for the full list) it is enough to specify just the stock ID and leave text and helpString empty.

In fact, leaving at least text empty for the stock menu items is strongly recommended as they will have appearance and keyboard interface (including standard accelerators) familiar to the user.

For the custom (non-stock) menu items, text must be specified and while helpString may be left empty, it's recommended to pass the item description (which is automatically shown by the library in the status bar when the menu item is selected) in this parameter.

Finally note that you can e.g. use a stock menu label without using its stock help string:

        // use all stock properties:
        helpMenu->Append(wxID_ABOUT);

        // use the stock label and the stock accelerator but not the stock help string:
        helpMenu->Append(wxID_ABOUT, wxEmptyString, wxT("My custom help string"));

        // use all stock properties except for the bitmap:
        wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);
        mymenu->SetBitmap(wxArtProvider::GetBitmap(wxART_WARNING));
        helpMenu->Append(mymenu);

that is, stock properties are set independently one from the other.

Parameters:

	parentMenu	Menu that the menu item belongs to. Can be NULL if the item is going to be added to the menu later.
	id	Identifier for this menu item. May be `wxID_SEPARATOR`, in which case the given kind is ignored and taken to be `wxITEM_SEPARATOR` instead.
	text	Text for the menu item, as shown on the menu. An accelerator key can be specified using the ampersand " character. In order to embed an ampersand character in the menu item text, the ampersand must be doubled.
	helpString	Optional help string that will be shown on the status bar.
	kind	May be `wxITEM_SEPARATOR`, `wxITEM_NORMAL`, `wxITEM_CHECK` or `wxITEM_RADIO`.
	subMenu	If non-NULL, indicates that the menu item is a submenu.

virtual wxMenuItem::~wxMenuItem ( ) [virtual]

Destructor.

Member Function Documentation

virtual void wxMenuItem::Check ( bool check = true ) [virtual]

Checks or unchecks the menu item. Note that this only works when the item is already appended to a menu.

virtual void wxMenuItem::Enable ( bool enable = true ) [virtual]

Enables or disables the menu item.

wxColour wxMenuItem::GetBackgroundColour ( ) const

Returns the background colour associated with the menu item (Windows only).

virtual const wxBitmap& wxMenuItem::GetBitmap ( ) const [virtual]

Returns the checked or unchecked bitmap (Windows only).

wxFont wxMenuItem::GetFont ( ) const

Returns the font associated with the menu item (Windows only).

const wxString& wxMenuItem::GetHelp ( ) const

Returns the help string associated with the menu item.

int wxMenuItem::GetId ( ) const

Returns the menu item identifier.

virtual wxString wxMenuItem::GetItemLabel ( ) const [virtual]

Returns the text associated with the menu item including any accelerator characters that were passed to the constructor or SetItemLabel().

See also:: GetItemLabelText(), GetLabelText()

virtual wxString wxMenuItem::GetItemLabelText ( ) const [virtual]

Returns the text associated with the menu item, without any accelerator characters.

See also:: GetItemLabel(), GetLabelText()

wxItemKind wxMenuItem::GetKind ( ) const

Returns the item kind, one of wxITEM_SEPARATOR, wxITEM_NORMAL, wxITEM_CHECK or wxITEM_RADIO.

wxString wxMenuItem::GetLabel ( ) const

Returns the text associated with the menu item without any accelerator characters it might contain.

Deprecated:: This function is deprecated in favour of GetItemLabelText().

See also:: GetText(), GetLabelFromText()

static wxString wxMenuItem::GetLabelFromText ( const wxString & text ) [static]

Deprecated:: This function is deprecated; please use GetLabelText() instead.

See also:: GetText(), GetLabel()

static wxString wxMenuItem::GetLabelText ( const wxString & text ) [static]

Strips all accelerator characters and mnemonics from the given text. For example:

          wxMenuItem::GetLabelfromText("&Hello\tCtrl-h");

will return just "Hello".

See also:: GetItemLabelText(), GetItemLabel()

int wxMenuItem::GetMarginWidth ( ) const

Gets the width of the menu item checkmark bitmap (Windows only).

wxMenu* wxMenuItem::GetMenu ( ) const

Returns the menu this menu item is in, or NULL if this menu item is not attached.

wxString wxMenuItem::GetName ( ) const

Returns the text associated with the menu item.

Deprecated:: This function is deprecated. Please use

GetItemLabel() or GetItemLabelText() instead.

wxMenu* wxMenuItem::GetSubMenu ( ) const

Returns the submenu associated with the menu item, or NULL if there isn't one.

const wxString& wxMenuItem::GetText ( ) const

Returns the text associated with the menu item, such as it was passed to the wxMenuItem constructor, i.e. with any accelerator characters it may contain.

Deprecated:: This function is deprecated in favour of GetItemLabel().

See also:: GetLabel(), GetLabelFromText()

wxColour wxMenuItem::GetTextColour ( ) const

Returns the text colour associated with the menu item (Windows only).

bool wxMenuItem::IsCheckable ( ) const

Returns true if the item is checkable.

virtual bool wxMenuItem::IsChecked ( ) const [virtual]

Returns true if the item is checked.

virtual bool wxMenuItem::IsEnabled ( ) const [virtual]

Returns true if the item is enabled.

bool wxMenuItem::IsSeparator ( ) const

Returns true if the item is a separator.

bool wxMenuItem::IsSubMenu ( ) const

Returns true if the item is a submenu.

void wxMenuItem::SetBackgroundColour ( const wxColour & colour ) const

Sets the background colour associated with the menu item (Windows only).

virtual void wxMenuItem::SetBitmap ( const wxBitmap & bmp ) [virtual]

Sets the bitmap for the menu item. It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).

Availability: only available for the wxMSW, wxMac, wxGTK ports.

void wxMenuItem::SetBitmaps	(	const wxBitmap &	checked,
		const wxBitmap &	unchecked = `wxNullBitmap`
	)

Sets the checked/unchecked bitmaps for the menu item. The first bitmap is also used as the single bitmap for uncheckable menu items.

Availability: only available for the wxMSW port.

void wxMenuItem::SetFont ( const wxFont & font )

Sets the font associated with the menu item (Windows only).

void wxMenuItem::SetHelp ( const wxString & helpString )

Sets the help string.

virtual void wxMenuItem::SetItemLabel ( const wxString & label ) [virtual]

Sets the label associated with the menu item.

void wxMenuItem::SetMarginWidth ( int width ) const

Sets the width of the menu item checkmark bitmap (Windows only).

void wxMenuItem::SetMenu ( wxMenu * menu )

Sets the parent menu which will contain this menu item.

void wxMenuItem::SetSubMenu ( wxMenu * menu )

Sets the submenu of this menu item.

virtual void wxMenuItem::SetText ( const wxString & text ) [virtual]

Sets the text associated with the menu item.

Deprecated:: This function is deprecated in favour of SetItemLabel().

void wxMenuItem::SetTextColour ( const wxColour & colour )

Sets the text colour associated with the menu item (Windows only).

wxMenuItem Class Reference [Menus]

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

wxMenuItem Class Reference
[Menus]