X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e9c3992c393926560befe4e312e4b135b675297f..b72ed64277a2b16c6c8681995e5f3f304a8fe38d:/interface/wx/textdlg.h diff --git a/interface/wx/textdlg.h b/interface/wx/textdlg.h index 24c3b80baf..a1ddf2e6ec 100644 --- a/interface/wx/textdlg.h +++ b/interface/wx/textdlg.h @@ -3,7 +3,7 @@ // Purpose: interface of wxPasswordEntryDialog // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -73,13 +73,14 @@ public: @param message Message to show on the dialog. @param caption - The caption of the the dialog. + The caption of the dialog. @param value The default value, which may be the empty string. @param style A dialog style, specifying the buttons (wxOK, wxCANCEL) and an optional wxCENTRE style. Additionally, wxTextCtrl styles - (such as wxTE_PASSWORD) may be specified here. + (such as @c wxTE_PASSWORD or @c wxTE_MULTILINE) may be specified + here. @param pos Dialog position. */ @@ -129,6 +130,12 @@ public: If @c centre is @true, the message text (which may include new line characters) is centred; if @false, the message is left-justified. + This function is a wrapper around wxTextEntryDialog and while it is usually + more convenient to use, using the dialog directly is more flexible, e.g. it + allows you to specify the @c wxTE_MULTILINE to allow the user enter + multiple lines of text while this function is limited to single line entry + only. + @header{wx/textdlg.h} */ wxString wxGetTextFromUser(const wxString& message,