X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e54c96f187f46c06bd36be8cd52b35c19884aa2b..d9faa1fede04455b98de64001bcad46fa2061231:/interface/textdlg.h diff --git a/interface/textdlg.h b/interface/textdlg.h index ca65daaa8d..dc7245790d 100644 --- a/interface/textdlg.h +++ b/interface/textdlg.h @@ -46,7 +46,7 @@ class wxTextEntryDialog : public wxDialog public: /** Constructor. Use ShowModal() to show the dialog. - + @param parent Parent window. @param message @@ -96,12 +96,18 @@ public: // Global functions/macros // ============================================================================ +/** @ingroup group_funcmacro_dialog */ +//@{ + /** - Pop up a dialog box with title set to @e caption, @e message, and a - @e default_value. The user may type in text and press OK to return this text, - or press Cancel to return the empty string. - If @a centre is @true, the message text (which may include new line characters) - is centred; if @false, the message is left-justified. + Pop up a dialog box with title set to @e caption, @c message, and a + @c default_value. The user may type in text and press OK to return this + text, or press Cancel to return the empty string. + + If @c centre is @true, the message text (which may include new line + characters) is centred; if @false, the message is left-justified. + + @header{wx/textdlg.h} */ wxString wxGetTextFromUser(const wxString& message, const wxString& caption = "Input text", @@ -112,9 +118,11 @@ wxString wxGetTextFromUser(const wxString& message, bool centre = true); /** - Similar to wxGetTextFromUser() but the text entered - in the dialog is not shown on screen but replaced with stars. This is intended - to be used for entering passwords as the function name implies. + Similar to wxGetTextFromUser() but the text entered in the dialog is not + shown on screen but replaced with stars. This is intended to be used for + entering passwords as the function name implies. + + @header{wx/textdlg.h} */ wxString wxGetPasswordFromUser(const wxString& message, const wxString& caption = "Input text", @@ -124,3 +132,5 @@ wxString wxGetPasswordFromUser(const wxString& message, int y = wxDefaultCoord, bool centre = true); +//@} +