X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..427861bde09badef1a2950ad799e69fac6b4a48a:/interface/wx/textdlg.h diff --git a/interface/wx/textdlg.h b/interface/wx/textdlg.h index dc7245790d..24c3b80baf 100644 --- a/interface/wx/textdlg.h +++ b/interface/wx/textdlg.h @@ -8,38 +8,59 @@ /** @class wxPasswordEntryDialog - @wxheader{textdlg.h} This class represents a dialog that requests a one-line password string from the user. + It is implemented as a generic wxWidgets dialog. - @library{wxbase} + @library{wxcore} @category{cmndlg} - @see @ref overview_wxpasswordentrydialogoverview "wxPassowrdEntryDialog - overview" + @see @ref overview_cmndlg_password */ class wxPasswordEntryDialog : public wxTextEntryDialog { public: + /** + Constructor. + Use wxTextEntryDialog::ShowModal to show the dialog. + + @param parent + Parent window. + @param message + Message to show on the dialog. + @param caption + The caption of the dialog. + @param defaultValue + The default value, which may be the empty string. + @param style + A dialog style, specifying the buttons (wxOK, wxCANCEL) and an + optional wxCENTRE style. You do not need to specify the wxTE_PASSWORD style, + it is always applied. + @param pos + Dialog position. + */ + wxPasswordEntryDialog(wxWindow* parent, const wxString& message, + const wxString& caption = wxGetPasswordFromUserPromptStr, + const wxString& defaultValue = wxEmptyString, + long style = wxOK | wxCANCEL | wxCENTRE, + const wxPoint& pos = wxDefaultPosition); }; /** @class wxTextEntryDialog - @wxheader{textdlg.h} - This class represents a dialog that requests a one-line text string from the - user. + 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_wxtextentrydialogoverview "wxTextEntryDialog overview" + @see @ref overview_cmndlg_textentry */ class wxTextEntryDialog : public wxDialog { @@ -51,30 +72,31 @@ public: Parent window. @param message Message to show on the dialog. - @param defaultValue + @param caption + The caption of the 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. + and an optional wxCENTRE style. Additionally, wxTextCtrl styles + (such as wxTE_PASSWORD) may be specified here. @param pos Dialog position. */ wxTextEntryDialog(wxWindow* parent, const wxString& message, - const wxString& caption = "Please enter text", - const wxString& defaultValue = "", + const wxString& caption = wxGetTextFromUserPromptStr, + const wxString& value = wxEmptyString, long style = wxOK | wxCANCEL | wxCENTRE, const wxPoint& pos = wxDefaultPosition); /** Destructor. */ - ~wxTextEntryDialog(); + virtual ~wxTextEntryDialog(); /** Returns the text that the user has entered if the user has pressed OK, or the - original value - if the user has pressed Cancel. + original value if the user has pressed Cancel. */ wxString GetValue() const; @@ -96,7 +118,7 @@ public: // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_dialog */ +/** @addtogroup group_funcmacro_dialog */ //@{ /** @@ -111,7 +133,7 @@ public: */ 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, @@ -126,7 +148,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,