]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/stockitem.h
derive wxConfig classes from wxObject and add wxRTTI macros to them (patch 1587607)
[wxWidgets.git] / include / wx / stockitem.h
index 7cb4afaaa771ae90c7c0f1d7677e28d68c5d1e29..cad8d3a8027a42d25998d75cc41d1deab41d7b66 100644 (file)
 #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/string.h"
 #include "wx/string.h"
+#include "wx/accel.h"
 
 // ----------------------------------------------------------------------------
 // Helper functions for stock items handling:
 
 // ----------------------------------------------------------------------------
 // Helper functions for stock items handling:
@@ -30,13 +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):
-WXDLLEXPORT wxString wxGetStockLabel(wxWindowID id);
+// 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,
+                                     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_