X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/41e69d79eaf36c46ed33d198ad094069d10e5ade..c729f16fa54e8484d8600fcb423c0983d71abab2:/interface/wx/textdlg.h diff --git a/interface/wx/textdlg.h b/interface/wx/textdlg.h index 41df73c85c..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 ///////////////////////////////////////////////////////////////////////////// /** @@ -14,7 +14,7 @@ It is implemented as a generic wxWidgets dialog. - @library{wxbase} + @library{wxcore} @category{cmndlg} @see @ref overview_cmndlg_password @@ -57,7 +57,7 @@ public: This class represents a dialog that requests a one-line text string from the user. It is implemented as a generic wxWidgets dialog. - @library{wxbase} + @library{wxcore} @category{cmndlg} @see @ref overview_cmndlg_textentry @@ -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. */ @@ -118,7 +119,7 @@ public: // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_dialog */ +/** @addtogroup group_funcmacro_dialog */ //@{ /** @@ -129,11 +130,17 @@ 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, const wxString& caption = "Input text", - const wxString& default_value = "", + const wxString& default_value = wxEmptyString, wxWindow* parent = NULL, int x = wxDefaultCoord, int y = wxDefaultCoord, @@ -148,7 +155,7 @@ wxString wxGetTextFromUser(const wxString& message, */ wxString wxGetPasswordFromUser(const wxString& message, const wxString& caption = "Input text", - const wxString& default_value = "", + const wxString& default_value = wxEmptyString, wxWindow* parent = NULL, int x = wxDefaultCoord, int y = wxDefaultCoord,