Document wxNotificationMessage::Timeout_XXX values.

[wxWidgets.git] / interface / wx / msgdlg.h

diff --git a/interface/wx/msgdlg.h b/interface/wx/msgdlg.h
index 2ff0bbb857e00dca466ac25fb388cb3549f3e813..5d2d37361a3633d280f5d85c816c5a1473635709 100644 (file)
--- a/interface/wx/msgdlg.h
+++ b/interface/wx/msgdlg.h
@@ -81,6 +81,39 @@
 class wxMessageDialog : public wxDialog
 {
 public:
+    /**
+        Helper class allowing to use either stock id or string labels.
+
+        This class should never be used explicitly and is not really part of
+        wxWidgets API but rather is just an implementation helper allowing the
+        methods such as SetYesNoLabels() and SetOKCancelLabels() below to be
+        callable with either stock ids (e.g. ::wxID_CLOSE) or strings
+        ("&Close").
+     */
+    class ButtonLabel
+    {
+    public:
+        /// Construct the label from a stock id.
+        ButtonLabel(int stockId);
+
+        /// Construct the label from the specified string.
+        ButtonLabel(const wxString& label);
+
+        /**
+            Return the associated label as string.
+
+            Get the string label, whether it was originally specified directly
+            or as a stock id -- this is only useful for platforms without native
+            stock items id support
+         */
+        wxString GetAsString() const;
+
+        /**
+            Return the stock id or wxID_NONE if this is not a stock label.
+         */
+        int GetStockId() const;
+    };
+
     /**
         Constructor specifying the message box properties.
         Use ShowModal() to show the dialog.