X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/43c48e1e53d74cef62d15f08f015d9efeb45a0c1..97d13342cc2ac77e21c38115cc6ebecac930f92a:/interface/wx/menu.h

diff --git a/interface/wx/menu.h b/interface/wx/menu.h
index 3e17236f68..f1c9b97d05 100644
--- a/interface/wx/menu.h
+++ b/interface/wx/menu.h
@@ -24,11 +24,10 @@
     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
+    @see wxMenu, @ref overview_events
 */
 class wxMenuBar : public wxWindow
 {
@@ -102,7 +101,7 @@ public:
         @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.
@@ -387,7 +386,7 @@ public:
     (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.
+    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.
@@ -402,15 +401,15 @@ public:
     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 except the popup ones must be created on the heap.
+    All menus except the popup ones must be created on the @b heap.
     All menus attached to a menubar or to another menu will be deleted by their
     parent when it is deleted.
+
     As the frame menubar is deleted by the frame itself, it means that normally
     all menus used are deleted automatically.
 
@@ -418,18 +417,22 @@ public:
     @section menu_eventhandling Event handling
 
     If the menu is part of a menubar, then wxMenuBar event processing is used.
-    With a popup menu, there is a variety of ways to handle a menu selection event
-    (wxEVT_COMMAND_MENU_SELECTED).
-    Derive a new class from wxMenu and define event table entries using the EVT_MENU macro.
-    Set a new event handler for wxMenu, using an object whose class has EVT_MENU entries.
-    Provide EVT_MENU handlers in the window which pops up the menu, or in an
-    ancestor of this window.
 
+    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,
+    @see wxMenuBar, wxWindow::PopupMenu, @ref overview_events,
          @ref wxFileHistory "wxFileHistory (most recently used files menu)"
 */
 class wxMenu : public wxEvtHandler
@@ -451,7 +454,7 @@ public:
         @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.
@@ -577,6 +580,8 @@ public:
         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,
@@ -624,7 +629,7 @@ public:
 
         @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
@@ -635,7 +640,7 @@ public:
 
         @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
@@ -647,7 +652,7 @@ public:
 
         @see FindItem(), Deletes(), Remove()
     */
-    void Destroy(int id);
+    bool Destroy(int id);
 
     /**
         Deletes the menu item from the menu. If the item is a submenu, it will
@@ -659,7 +664,7 @@ public:
 
         @see FindItem(), Deletes(), Remove()
     */
-    void Destroy(wxMenuItem* item);
+    bool Destroy(wxMenuItem* item);
 
     /**
         Enables or disables (greys out) a menu item.
@@ -673,6 +678,23 @@ public:
     */
     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.
 
@@ -698,7 +720,7 @@ public:
 
         @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.
@@ -748,13 +770,16 @@ public:
     */
     size_t GetMenuItemCount() const;
 
+    //@{
     /**
         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.
@@ -785,8 +810,8 @@ public:
         @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);
 
     /**
@@ -850,8 +875,8 @@ public:
 
         @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);
 
     /**