add wxGetLinuxDistributionInfo() and wxPlatformInfo::GetLinuxDistribution() functions...

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

diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h
index 3b6d3b455255e4eefef0d62d40ce0435312ade21..324dbdc0d246eda6552f3b270f0e7a9d2218e783 100644 (file)
--- a/interface/wx/menuitem.h
+++ b/interface/wx/menuitem.h
@@ -17,6 +17,29 @@
     Also please note that the methods related to fonts and bitmaps are currently
     only implemented for Windows, Mac and GTK+.
 
     Also please note that the methods related to fonts and bitmaps are currently
     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}
 
     @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);
 
         // 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);
 
         // use all stock properties except for the bitmap:
         wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);


@@ -69,7 +92,7 @@ public:
             instead.
         @param text
             Text for the menu item, as shown on the menu. An accelerator key can
             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.
             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.


@@ -251,11 +274,14 @@ public:
 
     /**
         Sets the bitmap for the menu item.
 
     /**
         Sets the bitmap for the menu item.

-        It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).

 
 

-        @onlyfor{wxmsw,wxmac,wxgtk}
+        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.
 
     /**
         Sets the checked/unchecked bitmaps for the menu item.