@library{wxcore}
@category{menus}
- @see wxMenu, @ref overview_eventhandlingoverview
+ @see wxMenu, @ref overview_eventhandling "Event Handling Overview"
*/
class wxMenuBar : public wxWindow
{
@param title
The title of the menu.
- @returns @true on success, @false if an error occurred.
+ @return @true on success, @false if an error occurred.
@see Insert()
*/
@param menu
If not @NULL, menu will get set to the associated menu.
- @returns The found menu item object, or @NULL if one was not found.
+ @return The found menu item object, or @NULL if one was not found.
*/
wxMenuItem* FindItem(int id, wxMenu menu = NULL) const;
@param itemString
Item to find.
- @returns The menu item identifier, or wxNOT_FOUND if none was found.
+ @return The menu item identifier, or wxNOT_FOUND if none was found.
@remarks Any special menu codes are stripped out of source and target
strings before matching.
@param id
The menu item identifier.
- @returns The help string, or the empty string if there was no help string
- or the menu item was not found.
+ @return The help string, or the empty string if there was no help string
+ or the menu item was not found.
@see SetHelpString()
*/
@param id
The menu item identifier.
- @returns The menu item label, or the empty string if the item was not
- found.
+ @return The menu item label, or the empty string if the item was not
+ found.
@remarks Use only after the menubar has been associated with a frame.
*/
@param pos
Position of the menu on the menu bar, starting from zero.
- @returns The menu label, or the empty string if the menu was not found.
+ @return The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@param pos
Position of the menu on the menu bar, starting from zero.
- @returns The menu label, or the empty string if the menu was not found.
+ @return The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@param pos
Position of the menu on the menu bar, starting from zero.
- @returns The menu label, or the empty string if the menu was not found.
+ @return The menu label, or the empty string if the menu was not found.
@remarks Use only after the menubar has been associated with a frame.
@param title
The title of the menu.
- @returns @true on success, @false if an error occurred.
+ @return @true on success, @false if an error occurred.
@see Append()
*/
@param id
The menu item identifier.
- @returns @true if the item was found and is checked, @false otherwise.
+ @return @true if the item was found and is checked, @false otherwise.
*/
bool IsChecked(int id) const;
@param id
The menu item identifier.
- @returns @true if the item was found and is enabled, @false otherwise.
+ @return @true if the item was found and is enabled, @false otherwise.
*/
bool IsEnabled(int id) const;
@param title
The title of the menu.
- @returns 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()
*/
@library{wxcore}
@category{menus}
- @see wxMenuBar, wxWindow::PopupMenu, @ref overview_eventhandlingoverview, @ref
- overview_wxfilehistory "wxFileHistory (most recently used files menu)"
+ @see wxMenuBar, wxWindow::PopupMenu,
+ @ref overview_eventhandling "Event Handling Overview",
+ @ref wxFileHistory "wxFileHistory (most recently used files menu)"
*/
class wxMenu : public wxEvtHandler
{
The menu command identifier.
@param item
The string to appear on the menu item.
- @param kind
- May be wxITEM_SEPARATOR, wxITEM_NORMAL,
- wxITEM_CHECK or wxITEM_RADIO
@param helpString
An optional help string associated with the item.
By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
this string in the status line.
+ @param kind
+ May be wxITEM_SEPARATOR, wxITEM_NORMAL,
+ wxITEM_CHECK or wxITEM_RADIO
@see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
AppendSubMenu(), Insert(), SetLabel(),
GetHelpString(), SetHelpString(), wxMenuItem
*/
- wxMenuItem* Append(int id, const wxString& item = "",
- const wxString& helpString = "",
+ wxMenuItem* Append(int id, const wxString& item = wxEmptyString,
+ const wxString& helpString = wxEmptyString,
wxItemKind kind = wxITEM_NORMAL);
/**
Adds a submenu.
+ @deprecated This function is deprecated, use AppendSubMenu() instead.
+
@param id
The menu command identifier.
@param item
The string to appear on the menu item.
- @param menu
+ @param subMenu
Pull-right submenu.
@param helpString
An optional help string associated with the item.
*/
wxMenuItem* Append(int id, const wxString& item,
wxMenu* subMenu,
- const wxString& helpString = "");
+ const wxString& helpString = wxEmptyString);
/**
Adds a menu item object. This is the most generic variant of Append() method
@param itemString
Menu item string to find.
- @returns Menu item identifier, or wxNOT_FOUND if none is found.
+ @return Menu item identifier, or wxNOT_FOUND if none is found.
@remarks Any special menu codes are stripped out of source and target
strings before matching.
If the pointer is not @NULL, it will be filled with the item's
parent menu (if the item was found)
- @returns Menu item object or NULL if none is found.
+ @return Menu item object or NULL if none is found.
*/
const wxMenuItem * FindItem(int id, wxMenu** menu = NULL) const;
@param id
The menu item identifier.
- @returns The help string, or the empty string if there is no help string
- or the item was not found.
+ @return The help string, or the empty string if there is no help string
+ or the item was not found.
@see SetHelpString(), Append()
*/
@param id
The menu item identifier.
- @returns The item label, or the empty string if the item was not found.
+ @return The item label, or the empty string if the item was not found.
@see GetLabelText(), SetLabel()
*/
@param id
The menu item identifier.
- @returns The item label, or the empty string if the item was not found.
+ @return The item label, or the empty string if the item was not found.
@see GetLabel(), SetLabel()
*/
@param id
The menu item identifier.
- @returns @true if the menu item is checked, @false otherwise.
+ @return @true if the menu item is checked, @false otherwise.
@see Check()
*/
@param id
The menu item identifier.
- @returns @true if the menu item is enabled, @false otherwise.
+ @return @true if the menu item is enabled, @false otherwise.
@see Enable()
*/
/**
Removes the menu item from the menu but doesn't delete the associated C++
- object. This allows to reuse the same item later by adding it back to the menu
+ 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.
- @returns The item which was detached from the menu.
+ @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 to reuse the same item later by adding it back to the menu
+ 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.
- @returns The item which was detached from the menu.
+ @return A pointer to the item which was detached from the menu.
*/
wxMenuItem* Remove(wxMenuItem* item);
projects / wxWidgets.git / blobdiff