X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7b2e024e8ac565edf8ef6a0e3e798859dd9c63b9..26b22ae371c4ba3cfc35deb0f72b4288081b54fd:/interface/wx/menu.h

diff --git a/interface/wx/menu.h b/interface/wx/menu.h
index 093de2b1df..ad1044dc67 100644
--- a/interface/wx/menu.h
+++ b/interface/wx/menu.h
@@ -27,7 +27,7 @@
     @library{wxcore}
     @category{menus}
 
-    @see wxMenu, @ref overview_eventhandling
+    @see wxMenu, @ref overview_events
 */
 class wxMenuBar : public wxWindow
 {
@@ -53,6 +53,10 @@ public:
             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);
@@ -124,6 +128,12 @@ public:
             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
     */
     virtual wxMenuItem* FindItem(int id, wxMenu* menu = NULL) const;
 
@@ -427,12 +437,12 @@ public:
       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_eventhandling_connect.
+    connection; see @ref overview_events_bind.
 
     @library{wxcore}
     @category{menus}
 
-    @see wxMenuBar, wxWindow::PopupMenu, @ref overview_eventhandling,
+    @see wxMenuBar, wxWindow::PopupMenu, @ref overview_events,
          @ref wxFileHistory "wxFileHistory (most recently used files menu)"
 */
 class wxMenu : public wxEvtHandler
@@ -476,45 +486,27 @@ public:
             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.
 
-        The item string for the normal menu items (not submenus or separators)
-        may include the accelerator which can be used to activate the menu item
-        from keyboard.
-        The accelerator string follows the item label and is separated from it
-        by a TAB character ('\\t').
-
-        Its general syntax is any combination of "CTRL", "ALT" and "SHIFT" strings
-        (case doesn't matter) separated by either '-' or '+' characters and followed
-        by the accelerator itself.
-        The accelerator may be any alphanumeric character, any function key
-        (from F1 to F12) or one of the special characters listed in the table
-        below (again, case doesn't matter):
-
-        - DEL or DELETE: Delete key
-        - INS or INSERT: Insert key
-        - ENTER or RETURN: Enter key
-        - PGUP: PageUp key
-        - PGDN: PageDown key
-        - LEFT: Left cursor arrow key
-        - RIGHT: Right cursor arrow key
-        - UP: Up cursor arrow key
-        - DOWN: Down cursor arrow key
-        - HOME: Home key
-        - END: End key
-        - SPACE: Space
-        - TAB: Tab key
-        - ESC: or ESCAPE Escape key (Windows only)
-
         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
              SetHelpString(), wxMenuItem