From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sat, 31 Jan 2009 22:51:37 +0000 (+0000)
Subject: document FindChildItem() (closes #10455)
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/7b2e024e8ac565edf8ef6a0e3e798859dd9c63b9

document FindChildItem() (closes #10455)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58576 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/menu.h b/interface/wx/menu.h
index 175b574cb1..093de2b1df 100644
--- a/interface/wx/menu.h
+++ b/interface/wx/menu.h
@@ -678,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.