]>
git.saurik.com Git - wxWidgets.git/blob - interface/textdlg.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: documentation for wxPasswordEntryDialog class
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxPasswordEntryDialog
13 This class represents a dialog that requests a one-line password string from
15 It is implemented as a generic wxWidgets dialog.
21 @ref overview_wxpasswordentrydialogoverview "wxPassowrdEntryDialog overview"
23 class wxPasswordEntryDialog
: public wxTextEntryDialog
31 @class wxTextEntryDialog
34 This class represents a dialog that requests a one-line text string from the
36 It is implemented as a generic wxWidgets dialog.
42 @ref overview_wxtextentrydialogoverview "wxTextEntryDialog overview"
44 class wxTextEntryDialog
: public wxDialog
48 Constructor. Use ShowModal() to show the dialog.
54 Message to show on the dialog.
57 The default value, which may be the empty string.
60 A dialog style, specifying the buttons (wxOK, wxCANCEL)
61 and an optional wxCENTRE style. Additionally, wxTextCtrl styles (such as
62 wxTE_PASSWORD) may be specified here.
67 wxTextEntryDialog(wxWindow
* parent
, const wxString
& message
,
68 const wxString
& caption
= "Please enter text",
69 const wxString
& defaultValue
= "",
70 long style
= wxOK
| wxCANCEL
| wxCENTRE
,
71 const wxPoint
& pos
= wxDefaultPosition
);
79 Returns the text that the user has entered if the user has pressed OK, or the
81 if the user has pressed Cancel.
86 Sets the default text value.
88 void SetValue(const wxString
& value
);
91 Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
98 // ============================================================================
99 // Global functions/macros
100 // ============================================================================
103 Pop up a dialog box with title set to @e caption, @e message, and a
104 @e default_value. The user may type in text and press OK to return this text,
105 or press Cancel to return the empty string.
107 If @e centre is @true, the message text (which may include new line characters)
108 is centred; if @false, the message is left-justified.
110 wxString
wxGetTextFromUser(const wxString
& message
,
111 const wxString
& caption
= "Input text",
112 const wxString
& default_value
= "",
113 wxWindow
* parent
= @NULL
,
114 int x
= wxDefaultCoord
,
115 int y
= wxDefaultCoord
,
116 bool centre
= @
true);
119 Similar to wxGetTextFromUser but the text entered
120 in the dialog is not shown on screen but replaced with stars. This is intended
121 to be used for entering passwords as the function name implies.
123 wxString
wxGetPasswordFromUser(const wxString
& message
,
124 const wxString
& caption
= "Input text",
125 const wxString
& default_value
= "",
126 wxWindow
* parent
= @NULL
,
127 int x
= wxDefaultCoord
,
128 int y
= wxDefaultCoord
,
129 bool centre
= @
true);