Small usability improvements

[wxWidgets.git] / include / wx / stockitem.h

diff --git a/include/wx/stockitem.h b/include/wx/stockitem.h
index aa95845f4fc2ccbef5a790c4970b09d24e8a2e6d..7ca7bb8e5ccce09ba923cdc92aa589f8a63fbf8f 100644 (file)
--- a/include/wx/stockitem.h
+++ b/include/wx/stockitem.h
@@ -12,13 +12,10 @@
 #ifndef _WX_STOCKITEM_H_
 #define _WX_STOCKITEM_H_
 
 #ifndef _WX_STOCKITEM_H_
 #define _WX_STOCKITEM_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "stockitem.h"
-#endif
-

 #include "wx/defs.h"
 #include "wx/defs.h"

-#include "wx/wxchar.h"
+#include "wx/chartype.h"

 #include "wx/string.h"
 #include "wx/string.h"

+#include "wx/accel.h"

 
 // ----------------------------------------------------------------------------
 // Helper functions for stock items handling:
 
 // ----------------------------------------------------------------------------
 // Helper functions for stock items handling:


@@ -31,15 +28,46 @@ WXDLLEXPORT bool wxIsStockID(wxWindowID id);
 // given ID
 WXDLLEXPORT bool wxIsStockLabel(wxWindowID id, const wxString& label);
 
 // given ID
 WXDLLEXPORT bool wxIsStockLabel(wxWindowID id, const wxString& label);
 

+enum wxStockLabelQueryFlag
+{
+    wxSTOCK_NOFLAGS = 0,
+
+    wxSTOCK_WITH_MNEMONIC = 1,
+    wxSTOCK_WITH_ACCELERATOR = 2
+};
+

 // Returns label that should be used for given stock UI element (e.g. "&OK"
 // Returns label that should be used for given stock UI element (e.g. "&OK"

-// for wxSTOCK_OK):
+// for wxSTOCK_OK); if wxSTOCK_WITH_MNEMONIC is given, the & character
+// is included; if wxSTOCK_WITH_ACCELERATOR is given, the stock accelerator
+// for given ID is concatenated to the label using \t as separator

 WXDLLEXPORT wxString wxGetStockLabel(wxWindowID id,
 WXDLLEXPORT wxString wxGetStockLabel(wxWindowID id,

-                                     bool withCodes = true,
-                                     wxString accelerator = wxEmptyString);
+                                     long flags = wxSTOCK_WITH_MNEMONIC);
+
+#if wxUSE_ACCEL
+
+    // Returns the accelerator that should be used for given stock UI element
+    // (e.g. "Ctrl+x" for wxSTOCK_EXIT)
+    WXDLLEXPORT wxAcceleratorEntry wxGetStockAccelerator(wxWindowID id);
+
+#endif
+
+// wxStockHelpStringClient conceptually works like wxArtClient: it gives a hint to
+// wxGetStockHelpString() about the context where the help string is to be used
+enum wxStockHelpStringClient
+{
+    wxSTOCK_MENU        // help string to use for menu items
+};
+
+// Returns an help string for the given stock UI element and for the given "context".
+WXDLLEXPORT wxString wxGetStockHelpString(wxWindowID id,
+                                          wxStockHelpStringClient client = wxSTOCK_MENU);
+

 
 #ifdef __WXGTK20__
 
 #ifdef __WXGTK20__

+

 // Translates stock ID to GTK+'s stock item string indentifier:
 WXDLLEXPORT const char *wxGetStockGtkID(wxWindowID id);
 // Translates stock ID to GTK+'s stock item string indentifier:
 WXDLLEXPORT const char *wxGetStockGtkID(wxWindowID id);

+

 #endif
 
 #endif // _WX_STOCKITEM_H_
 #endif
 
 #endif // _WX_STOCKITEM_H_