undo the last change as it results in buildbot configuration error

[wxWidgets.git] / interface / wx / menuitem.h

diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h
index e74e7bde17237a243dcb58c869565db4ff58ea66..324dbdc0d246eda6552f3b270f0e7a9d2218e783 100644 (file)
--- a/interface/wx/menuitem.h
+++ b/interface/wx/menuitem.h
@@ -15,7 +15,30 @@
     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 and GTK+.
+    only implemented for Windows, Mac and GTK+.
+
+    @beginEventEmissionTable{wxCommandEvent,wxMenuEvent}
+    @event{EVT_MENU(id, func)}
+        Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
+        This type of event is sent as wxCommandEvent.
+    @event{EVT_MENU_RANGE(id1, id2, func)}
+        Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
+        This type of event is sent as wxCommandEvent.
+    @event{EVT_MENU_OPEN(func)}
+        A menu is about to be opened. On Windows, this is only sent once for each
+        navigation of the menubar (up until all menus have closed).
+        This type of event is sent as wxMenuEvent.
+    @event{EVT_MENU_CLOSE(func)}
+        A menu has been just closed.
+        This type of event is sent as wxMenuEvent.
+    @event{EVT_MENU_HIGHLIGHT(id, func)}
+        The menu item with the specified id has been highlighted: used to show
+        help prompts in the status bar by wxFrame
+        This type of event is sent as wxMenuEvent.
+    @event{EVT_MENU_HIGHLIGHT_ALL(func)}
+        A menu item has been highlighted, i.e. the currently selected menu item has changed.
+        This type of event is sent as wxMenuEvent.
+    @endEventTable
 
     @library{wxcore}
     @category{menus}
@@ -50,7 +73,7 @@ public:
         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"));
+        helpMenu->Append(wxID_ABOUT, wxEmptyString, "My custom help string");
 
         // use all stock properties except for the bitmap:
         wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);
@@ -69,13 +92,13 @@ public:
             instead.
         @param 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
+            be specified using the ampersand @c & character. In order to embed an
             ampersand character in the menu item text, the ampersand must be doubled.
         @param helpString
             Optional help string that will be shown on the status bar.
         @param kind
             May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or
-            @c wxITEM_RADIO
+            @c wxITEM_RADIO.
         @param subMenu
             If non-@NULL, indicates that the menu item is a submenu.
     */
@@ -250,14 +273,21 @@ public:
     void SetBackgroundColour(const wxColour& colour) const;
 
     /**
-        Sets the bitmap for the menu item (Windows and GTK+ only).
-        It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).
+        Sets the bitmap for the menu item.
+
+        It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap) if @a
+        checked is @true (default value) or SetBitmaps(wxNullBitmap, bmp)
+        otherwise.
+
+        @onlyfor{wxmsw,wxosx,wxgtk}
     */
-    virtual void SetBitmap(const wxBitmap& bmp);
+    virtual void SetBitmap(const wxBitmap& bmp, bool checked = true);
 
     /**
-        Sets the checked/unchecked bitmaps for the menu item (Windows only).
+        Sets the checked/unchecked bitmaps for the menu item.
         The first bitmap is also used as the single bitmap for uncheckable menu items.
+
+        @onlyfor{wxmsw}
     */
     void SetBitmaps(const wxBitmap& checked,
                     const wxBitmap& unchecked = wxNullBitmap);