From 1f165e74326dee190e4ff7462190271543a92034 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 20 Feb 2012 21:56:38 +0000 Subject: [PATCH] Add skeleton documentation for wxMessageDialog::ButtonLabel. This class shouldn't be really used directly but document it just to make the interface header valid C++ as this class was used as parameter type but never defined. Closes #14006. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70647 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/msgdlg.h | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/interface/wx/msgdlg.h b/interface/wx/msgdlg.h index 2ff0bbb857..5d2d37361a 100644 --- 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. -- 2.45.2