From 34a9a0244bcb5ce86ecb515878cf44bebfa0b2fd Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sat, 25 Jul 2009 16:40:56 +0000
Subject: [PATCH] Correct wxGetStockLabel() documentation.

It was completely out of date; also separately documented wxStockLabelQueryFlag.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61525 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 interface/wx/stockitem.h | 43 +++++++++++++++++++++++++++++++---------
 1 file changed, 34 insertions(+), 9 deletions(-)

diff --git a/interface/wx/stockitem.h b/interface/wx/stockitem.h
index dcf7683286..34801d6578 100644
--- a/interface/wx/stockitem.h
+++ b/interface/wx/stockitem.h
@@ -6,6 +6,37 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    Possible values for flags parameter of wxGetStockLabel().
+
+    The elements of this enum are bit masks and may be combined with each other
+    (except when specified otherwise).
+ */
+enum wxStockLabelQueryFlag
+{
+    /**
+        Indicates absence of wxSTOCK_WITH_MNEMONIC and wxSTOCK_WITH_ACCELERATOR.
+
+        Requests just the label (e.g. "Print...").
+     */
+    wxSTOCK_NOFLAGS = 0,
+
+    /**
+        Request the label with mnemonics character.
+       
+        E.g. "&amp;Print...".
+     */
+    wxSTOCK_WITH_MNEMONIC = 1,
+
+    /**
+        Return the label with accelerator following it after TAB.
+
+        E.g. "Print...\tCtrl-P". This can be combined with
+        wxSTOCK_WITH_MNEMONIC to get "&Print...\tCtrl-P".
+     */
+    wxSTOCK_WITH_ACCELERATOR = 2
+};
+
 /** @addtogroup group_funcmacro_misc */
 //@{
 
@@ -14,18 +45,12 @@
 
     @param id
         Given id of the wxMenuItem, wxButton, wxToolBar tool, etc.
-    @param withCodes
-        If @false then strip accelerator code from the label; useful for
-        getting labels without accelerator char code like for toolbar tooltip
-        or on platforms without traditional keyboard like smartphones.
-    @param accelerator
-        Optional accelerator string automatically added to label; useful for
-        building labels for wxMenuItem.
+    @param flags
+        Combination of the elements of wxStockLabelQueryFlag.
 
     @header{wx/stockitem.h}
 */
-wxString wxGetStockLabel(wxWindowID id, bool withCodes = true,
-                         const wxString& accelerator = wxEmptyString);
+wxString wxGetStockLabel(wxWindowID id, long flags = wxSTOCK_WITH_MNEMONIC);
 
 //@}
 
-- 
2.45.2