// Purpose: interface of wxMenuBar
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
A menu bar is a series of menus accessible from the top of a frame.
+ @remarks
+ To respond to a menu selection, provide a handler for EVT_MENU, in the frame
+ that contains the menu bar.
+
+ If you have a toolbar which uses the same identifiers as your EVT_MENU entries,
+ events from the toolbar will also be processed by your EVT_MENU event handlers.
+
+ Tip: under Windows, if you discover that menu shortcuts (for example, Alt-F
+ to show the file menu) are not working, check any EVT_CHAR events you are
+ handling in child windows.
+ If you are not calling event.Skip() for events that you don't process in
+ these event handlers, menu shortcuts may cease to work.
+
@library{wxcore}
@category{menus}
- @see wxMenu, @ref overview_eventhandling "Event Handling Overview"
+ @see wxMenu, @ref overview_events
*/
class wxMenuBar : public wxWindow
{
public:
/**
- Construct an empty menu barM
+ Construct an empty menu bar.
@param style
If wxMB_DOCKABLE the menu bar can be detached (wxGTK only).
*/
wxMenuBar(long style = 0);
-
+
/**
Construct a menu bar from arrays of menus and titles.
the menu bar.
@param style
If wxMB_DOCKABLE the menu bar can be detached (wxGTK only).
+
+ @beginWxPerlOnly
+ Not supported by wxPerl.
+ @endWxPerlOnly
*/
wxMenuBar(size_t n, wxMenu* menus[], const wxString titles[],
long style = 0);
/**
- Destructor, destroying the menu bar and removing it from the parent frame (if
- any).
+ Destructor, destroying the menu bar and removing it from the parent
+ frame (if any).
*/
virtual ~wxMenuBar();
Adds the item to the end of the menu bar.
@param menu
- The menu to add. Do not deallocate this menu after calling Append.
+ The menu to add. Do not deallocate this menu after calling Append().
@param title
- The title of the menu.
+ The title of the menu, must be non-empty.
@return @true on success, @false if an error occurred.
@remarks Only use this when the menu bar has been associated with a
frame; otherwise, use the wxMenu equivalent call.
*/
- void Check(int id, const bool check);
+ void Check(int id, bool check);
/**
Enables or disables (greys out) a menu item.
@remarks Only use this when the menu bar has been associated with a
frame; otherwise, use the wxMenu equivalent call.
*/
- void Enable(int id, const bool enable);
+ void Enable(int id, bool enable);
/**
Enables or disables a whole menu.
@remarks Only use this when the menu bar has been associated with a frame.
*/
- void EnableTop(int pos, const bool enable);
+ virtual void EnableTop(size_t pos, bool enable);
/**
Finds the menu item object associated with the given menu item identifier.
If not @NULL, menu will get set to the associated menu.
@return The found menu item object, or @NULL if one was not found.
+
+ @beginWxPerlOnly
+ In wxPerl this method takes just the @a id parameter;
+ in scalar context it returns the associated @c Wx::MenuItem, in list
+ context it returns a 2-element list (item, submenu).
+ @endWxPerlOnly
*/
- wxMenuItem* FindItem(int id, wxMenu menu = NULL) const;
+ virtual wxMenuItem* FindItem(int id, wxMenu* menu = NULL) const;
/**
Returns the index of the menu with the given @a title or @c wxNOT_FOUND if no
- such menu exists in this menubar. The @a title parameter may specify either
- the menu title (with accelerator characters, i.e. @c "File") or just the
+ such menu exists in this menubar.
+
+ The @a title parameter may specify either the menu title
+ (with accelerator characters, i.e. @c "&File") or just the
menu label (@c "File") indifferently.
*/
int FindMenu(const wxString& title) const;
@remarks Any special menu codes are stripped out of source and target
strings before matching.
*/
- int FindMenuItem(const wxString& menuString,
- const wxString& itemString) const;
+ virtual int FindMenuItem(const wxString& menuString,
+ const wxString& itemString) const;
/**
Gets the help string associated with the menu item identifier.
@remarks Use only after the menubar has been associated with a frame.
+ @deprecated
+ This function is deprecated in favour of GetMenuLabel() and GetMenuLabelText().
+
@see SetLabelTop()
*/
- wxString GetLabelTop(int pos) const;
+ wxString GetLabelTop(size_t pos) const;
/**
Returns the menu at @a menuIndex (zero-based).
*/
- wxMenu* GetMenu(int menuIndex) const;
+ wxMenu* GetMenu(size_t menuIndex) const;
/**
Returns the number of menus in this menubar.
@see GetMenuLabelText(), SetMenuLabel()
*/
- wxString GetMenuLabel(int pos) const;
+ virtual wxString GetMenuLabel(size_t pos) const;
/**
Returns the label of a top-level menu. Note that the returned string does not
@see GetMenuLabel(), SetMenuLabel()
*/
- wxString GetMenuLabelText(int pos) const;
+ virtual wxString GetMenuLabelText(size_t pos) const;
/**
Inserts the menu at the given position into the menu bar. Inserting menu at
position 0 will insert it in the very beginning of it, inserting at position
- GetMenuCount() is the same as calling
- Append().
+ GetMenuCount() is the same as calling Append().
@param pos
The position of the new menu in the menu bar
/**
Redraw the menu bar
*/
- void Refresh();
+ virtual void Refresh(bool eraseBackground = true, const wxRect* rect = NULL);
/**
- Removes the menu from the menu bar and returns the menu object - the caller is
- responsible for deleting it. This function may be used together with
- Insert() to change the menubar
- dynamically.
+ Removes the menu from the menu bar and returns the menu object - the caller
+ is responsible for deleting it. This function may be used together with
+ Insert() to change the menubar dynamically.
@see Replace()
*/
@param title
The title of the menu.
- @return The menu which was previously at position pos. The caller is
- responsible for deleting it.
+ @return The menu which was previously at position pos.
+ The caller is responsible for deleting it.
@see Insert(), Remove()
*/
@remarks Use only after the menubar has been associated with a frame.
+ @deprecated
+ This function has been deprecated in favour of SetMenuLabel().
+
@see GetLabelTop()
*/
- void SetLabelTop(int pos, const wxString& label);
+ void SetLabelTop(size_t pos, const wxString& label);
/**
Sets the label of a top-level menu.
@remarks Use only after the menubar has been associated with a frame.
*/
- void SetMenuLabel(int pos, const wxString& label);
+ virtual void SetMenuLabel(size_t pos, const wxString& label);
};
A menu item has an integer ID associated with it which can be used to
identify the selection, or to change the menu item in some way. A menu item
- with a special identifier -1 is a separator item and doesn't have an
- associated command but just makes a separator line appear in the menu.
-
- @note Please note that @e wxID_ABOUT and @e wxID_EXIT are
- predefined by wxWidgets and have a special meaning since entries
- using these IDs will be taken out of the normal menus under MacOS X
- and will be inserted into the system menu (following the appropriate
- MacOS X interface guideline). On PalmOS @e wxID_EXIT is disabled according
- to Palm OS Companion guidelines.
-
- Menu items may be either normal items, check items or radio items. Normal items
- don't have any special properties while the check items have a boolean flag
- associated to them and they show a checkmark in the menu when the flag is set.
+ with a special identifier @e wxID_SEPARATOR is a separator item and doesn't
+ have an associated command but just makes a separator line appear in the
+ menu.
+
+ @note
+ Please note that @e wxID_ABOUT and @e wxID_EXIT are predefined by wxWidgets
+ and have a special meaning since entries using these IDs will be taken out
+ of the normal menus under MacOS X and will be inserted into the system menu
+ (following the appropriate MacOS X interface guideline).
+ On PalmOS @e wxID_EXIT is disabled according to Palm OS Companion guidelines.
+
+ Menu items may be either @e normal items, @e check items or @e radio items.
+ Normal items don't have any special properties while the check items have a
+ boolean flag associated to them and they show a checkmark in the menu when
+ the flag is set.
wxWidgets automatically toggles the flag value when the item is clicked and its
- value may be retrieved using either wxMenu::IsChecked method
- of wxMenu or wxMenuBar itself or by using
- wxEvent::IsChecked when you get the menu
+ value may be retrieved using either wxMenu::IsChecked method of wxMenu or
+ wxMenuBar itself or by using wxEvent::IsChecked when you get the menu
notification for the item in question.
The radio items are similar to the check items except that all the other items
first item of this kind and ends with the first item of a different kind (or
the end of the menu). Notice that because the radio groups are defined in terms
of the item positions inserting or removing the items in the menu containing
- the radio items risks to not work correctly. Finally note that radio items
- are not supported under Motif.
+ the radio items risks to not work correctly.
+
+
+ @section menu_allocation Allocation strategy
+
+ All menus must be created on the @b heap because all menus attached to a
+ menubar or to another menu will be deleted by their parent when it is
+ deleted. The only exception to this rule are the popup menus (i.e. menus
+ used with wxWindow::PopupMenu()) as wxWidgets does not destroy them to
+ allow reusing the same menu more than once. But the exception applies only
+ to the menus themselves and not to any submenus of popup menus which are
+ still destroyed by wxWidgets as usual and so must be heap-allocated.
+
+ As the frame menubar is deleted by the frame itself, it means that normally
+ all menus used are deleted automatically.
+
+
+ @section menu_eventhandling Event handling
+
+ If the menu is part of a menubar, then wxMenuBar event processing is used.
+
+ With a popup menu (see wxWindow::PopupMenu), there is a variety of ways to
+ handle a menu selection event (@c wxEVT_COMMAND_MENU_SELECTED):
+ - Provide @c EVT_MENU handlers in the window which pops up the menu, or in an
+ ancestor of that window (the simplest method);
+ - Derive a new class from wxMenu and define event table entries using the @c EVT_MENU macro;
+ - Set a new event handler for wxMenu, through wxEvtHandler::SetNextHandler,
+ specifying an object whose class has @c EVT_MENU entries;
+
+ Note that instead of static @c EVT_MENU macros you can also use dynamic
+ connection; see @ref overview_events_bind.
@library{wxcore}
@category{menus}
- @see wxMenuBar, wxWindow::PopupMenu,
- @ref overview_eventhandling "Event Handling Overview",
- @ref wxFileHistory "wxFileHistory (most recently used files menu)"
+ @see wxMenuBar, wxWindow::PopupMenu, @ref overview_events,
+ @ref wxFileHistory "wxFileHistory (most recently used files menu)"
*/
class wxMenu : public wxEvtHandler
{
wxMenu(long style);
/**
- Constructs a wxMenu object with a title
+ Constructs a wxMenu object with a title.
@param title
Title at the top of the menu (not always supported).
@param style
If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK only).
*/
- wxMenu(const wxString& title = "", long style = 0);
-
+ wxMenu(const wxString& title, long style = 0);
+
/**
Destructor, destroying the menu.
- Note: under Motif, a popup menu must have a valid parent (the window
- it was last popped up on) when being destroyed. Therefore, make sure
- you delete or re-use the popup menu @e before destroying the
- parent window. Re-use in this context means popping up the menu on
- a different window from last time, which causes an implicit destruction
- and recreation of internal data structures.
+
+ @note
+ Under Motif, a popup menu must have a valid parent (the window
+ it was last popped up on) when being destroyed. Therefore, make sure
+ you delete or re-use the popup menu @e before destroying the parent
+ window. Re-use in this context means popping up the menu on a different
+ window from last time, which causes an implicit destruction and
+ recreation of internal data structures.
*/
virtual ~wxMenu();
/**
- Adds a menu item.
+ Adds a menu item.
@param id
The menu command identifier.
@param item
The string to appear on the menu item.
+ See wxMenuItem::SetItemLabel() for more details.
@param helpString
An optional help string associated with the item.
- By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
+ By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays
this string in the status line.
@param kind
- May be wxITEM_SEPARATOR, wxITEM_NORMAL,
- wxITEM_CHECK or wxITEM_RADIO
+ May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or @c wxITEM_RADIO.
+
+ Example:
+ @code
+ m_pFileMenu->Append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a new XYZ document");
+ @endcode
+ or even better for stock menu items (see wxMenuItem::wxMenuItem):
+ @code
+ m_pFileMenu->Append(wxID_NEW, "", "Creates a new XYZ document");
+ @endcode
+
+ @remarks
+ This command can be used after the menu has been shown, as well as on
+ initial creation of a menu or menubar.
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
- AppendSubMenu(), Insert(), SetLabel(),
- GetHelpString(), SetHelpString(), wxMenuItem
+ AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
+ SetHelpString(), wxMenuItem
*/
wxMenuItem* Append(int id, const wxString& item = wxEmptyString,
const wxString& helpString = wxEmptyString,
wxItemKind kind = wxITEM_NORMAL);
-
+
/**
Adds a submenu.
Pull-right submenu.
@param helpString
An optional help string associated with the item.
- By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
+ By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays
this string in the status line.
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
- AppendSubMenu(), Insert(), SetLabel(),
- GetHelpString(), SetHelpString(), wxMenuItem
+ AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
+ SetHelpString(), wxMenuItem
*/
wxMenuItem* Append(int id, const wxString& item, wxMenu* subMenu,
const wxString& helpString = wxEmptyString);
-
+
/**
- Adds a menu item object. This is the most generic variant of Append() method
- because it may be used for both items (including separators) and submenus and
- because you can also specify various extra properties of a menu item this way,
+ Adds a menu item object.
+
+ This is the most generic variant of Append() method because it may be
+ used for both items (including separators) and submenus and because
+ you can also specify various extra properties of a menu item this way,
such as bitmaps and fonts.
@param menuItem
- A menuitem object. It will be owned by the wxMenu object after this function
- is called, so do not delete it yourself.
+ A menuitem object. It will be owned by the wxMenu object after this
+ function is called, so do not delete it yourself.
+
+ @remarks
+ See the remarks for the other Append() overloads.
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
- AppendSubMenu(), Insert(), SetLabel(),
- GetHelpString(), SetHelpString(), wxMenuItem
+ AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
+ SetHelpString(), wxMenuItem
*/
wxMenuItem* Append(wxMenuItem* menuItem);
@see Append(), InsertCheckItem()
*/
wxMenuItem* AppendCheckItem(int id, const wxString& item,
- const wxString& helpString = "");
+ const wxString& help = wxEmptyString);
/**
- Adds a radio item to the end of the menu. All consequent radio items form a
- group and when an item in the group is checked, all the others are
- automatically unchecked.
+ Adds a radio item to the end of the menu.
+ All consequent radio items form a group and when an item in the group is
+ checked, all the others are automatically unchecked.
+
+ @note Radio items are not supported under wxMotif.
@see Append(), InsertRadioItem()
*/
wxMenuItem* AppendRadioItem(int id, const wxString& item,
- const wxString& helpString = "");
+ const wxString& help = wxEmptyString);
/**
Adds a separator to the end of the menu.
const wxString& help = wxEmptyString);
/**
- Inserts a break in a menu, causing the next appended item to appear in a new
- column.
+ Inserts a break in a menu, causing the next appended item to appear in
+ a new column.
*/
virtual void Break();
@see IsChecked()
*/
- void Check(int id, const bool check);
+ void Check(int id, bool check);
/**
Deletes the menu item from the menu. If the item is a submenu, it will
@see FindItem(), Destroy(), Remove()
*/
- void Delete(int id);
+ bool Delete(int id);
/**
Deletes the menu item from the menu. If the item is a submenu, it will
@see FindItem(), Destroy(), Remove()
*/
- void Delete(wxMenuItem* item);
+ bool Delete(wxMenuItem* item);
/**
Deletes the menu item from the menu. If the item is a submenu, it will
@param id
Id of the menu item to be deleted.
- @see FindItem(), Deletes(), Remove()
+ @see FindItem(), Delete(), Remove()
*/
- void Destroy(int id);
+ bool Destroy(int id);
/**
Deletes the menu item from the menu. If the item is a submenu, it will
@param item
Menu item to be deleted.
- @see FindItem(), Deletes(), Remove()
+ @see FindItem(), Delete(), Remove()
*/
- void Destroy(wxMenuItem* item);
+ bool Destroy(wxMenuItem* item);
/**
Enables or disables (greys out) a menu item.
@see IsEnabled()
*/
- void Enable(int id, const bool enable);
+ void Enable(int id, bool enable);
+
+ /**
+ Finds the menu item object associated with the given menu item identifier
+ and, optionally, the position of the item in the menu.
+
+ Unlike FindItem(), this function doesn't recurse but only looks at the
+ direct children of this menu.
+
+ @param id
+ The identifier of the menu item to find.
+ @param pos
+ If the pointer is not @NULL, it is filled with the item's position if
+ it was found or @c (size_t)wxNOT_FOUND otherwise.
+ @return
+ Menu item object or @NULL if not found.
+ */
+ wxMenuItem *FindChildItem(int id, size_t *pos = NULL) const;
/**
Finds the menu id for a menu item string.
@return Menu item object or NULL if none is found.
*/
- const wxMenuItem * FindItem(int id, wxMenu** menu = NULL) const;
+ wxMenuItem* FindItem(int id, wxMenu** menu = NULL) const;
/**
Returns the wxMenuItem given a position in the menu.
*/
size_t GetMenuItemCount() const;
+ //@{
/**
- Returns the list of items in the menu. wxMenuItemList is a pseudo-template
- list class containing wxMenuItem pointers, see wxList.
+ Returns the list of items in the menu.
+
+ wxMenuItemList is a pseudo-template list class containing wxMenuItem
+ pointers, see wxList.
*/
- wxMenuItemList GetMenuItems() const;
+ wxMenuItemList& GetMenuItems() const;
+ const wxMenuItemList& GetMenuItems() const;
+ //@}
/**
Returns the title of the menu.
- @remarks This is relevant only to popup menus, use
- wxMenuBar::GetMenuLabel for the menus in the menubar.
-
@see SetTitle()
*/
- wxString GetTitle() const;
+ const wxString& GetTitle() const;
/**
- Inserts the given @a item before the position @e pos. Inserting the item
- at position GetMenuItemCount() is the same
+ Inserts the given @a item before the position @a pos.
+
+ Inserting the item at position GetMenuItemCount() is the same
as appending it.
@see Append(), Prepend()
*/
wxMenuItem* Insert(size_t pos, wxMenuItem* item);
-
+
/**
- Inserts the given @a item before the position @e pos. Inserting the item
- at position GetMenuItemCount() is the same
+ Inserts the given @a item before the position @a pos.
+
+ Inserting the item at position GetMenuItemCount() is the same
as appending it.
@see Append(), Prepend()
*/
wxMenuItem* Insert(size_t pos, int id,
- const wxString& item = "",
- const wxString& helpString = "",
+ const wxString& item = wxEmptyString,
+ const wxString& helpString = wxEmptyString,
wxItemKind kind = wxITEM_NORMAL);
/**
@see Insert(), AppendCheckItem()
*/
- wxMenuItem* InsertCheckItem(size_t pos, int id,
- const wxString& item,
- const wxString& helpString = "");
+ wxMenuItem* InsertCheckItem(size_t pos, int id, const wxString& item,
+ const wxString& helpString = wxEmptyString);
/**
Inserts a radio item at the given position.
@see Insert(), AppendRadioItem()
*/
- wxMenuItem* InsertRadioItem(size_t pos, int id,
- const wxString& item,
- const wxString& helpString = "");
+ wxMenuItem* InsertRadioItem(size_t pos, int id, const wxString& item,
+ const wxString& helpString = wxEmptyString);
/**
Inserts a separator at the given position.
@see Append(), Insert()
*/
- wxMenuItem* Prepend(int id, const wxString& item = "",
- const wxString& helpString = "",
+ wxMenuItem* Prepend(int id, const wxString& item = wxEmptyString,
+ const wxString& helpString = wxEmptyString,
wxItemKind kind = wxITEM_NORMAL);
/**
@see Prepend(), AppendCheckItem()
*/
wxMenuItem* PrependCheckItem(int id, const wxString& item,
- const wxString& helpString = "");
+ const wxString& helpString = wxEmptyString);
/**
Inserts a radio item at position 0.
@see Prepend(), AppendRadioItem()
*/
wxMenuItem* PrependRadioItem(int id, const wxString& item,
- const wxString& helpString = "");
+ const wxString& helpString = wxEmptyString);
/**
Inserts a separator at position 0.
/**
Removes the menu item from the menu but doesn't delete the associated C++
- object. This allows you to reuse the same item later by adding it back to the menu
- (especially useful with submenus).
+ object. This allows you to reuse the same item later by adding it back to
+ the menu (especially useful with submenus).
@param id
The identifier of the menu item to remove.
@return A pointer to the item which was detached from the menu.
*/
wxMenuItem* Remove(int id);
-
+
/**
Removes the menu item from the menu but doesn't delete the associated C++
- object. This allows you to reuse the same item later by adding it back to the menu
- (especially useful with submenus).
+ object. This allows you to reuse the same item later by adding it back to
+ the menu (especially useful with submenus).
@param item
The menu item to remove.
@param title
The title to set.
- @remarks This is relevant only to popup menus, use
- wxMenuBar::SetLabelTop for the menus in the menubar.
+ @remarks Notice that you can only call this method directly for the
+ popup menus, to change the title of a menu that is part of a menu
+ bar you need to use wxMenuBar::SetLabelTop().
@see GetTitle()
*/
/**
Sends events to @a source (or owning window if @NULL) to update the
- menu UI. This is called just before the menu is popped up with
- wxWindow::PopupMenu, but
- the application may call it at other times if required.
+ menu UI.
+
+ This is called just before the menu is popped up with wxWindow::PopupMenu,
+ but the application may call it at other times if required.
*/
void UpdateUI(wxEvtHandler* source = NULL);
};
projects / wxWidgets.git / blobdiff