docs/latex/wx/textdlg.tex

   1 \section{\class{wxTextEntryDialog}}\label{wxtextentrydialog}
   2
   3 This class represents a dialog that requests a one-line text string from the user.
   4 It is implemented as a generic wxWidgets dialog.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxDialog}{wxdialog}\\
   9 \helpref{wxWindow}{wxwindow}\\
  10 \helpref{wxEvtHandler}{wxevthandler}\\
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/textdlg.h>
  16
  17 \wxheading{See also}
  18
  19 \helpref{wxTextEntryDialog overview}{wxtextentrydialogoverview}
  20
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23 \membersection{wxTextEntryDialog::wxTextEntryDialog}\label{wxtextentrydialogctor}
  24
  25 \func{}{wxTextEntryDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
  26 \param{const wxString\& }{caption = "Please enter text"}, \param{const wxString\& }{defaultValue = ""}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
  27
  28 Constructor. Use \helpref{wxTextEntryDialog::ShowModal}{wxtextentrydialogshowmodal} to show the dialog.
  29
  30 \wxheading{Parameters}
  31
  32 \docparam{parent}{Parent window.}
  33
  34 \docparam{message}{Message to show on the dialog.}
  35
  36 \docparam{defaultValue}{The default value, which may be the empty string.}
  37
  38 \docparam{style}{A dialog style, specifying the buttons (wxOK, wxCANCEL)
  39 and an optional wxCENTRE style. Additionally, wxTextCtrl styles (such as
  40 \windowstyle{wxTE\_PASSWORD}) may be specified here.}
  41
  42 \docparam{pos}{Dialog position.}
  43
  44 \membersection{wxTextEntryDialog::\destruct{wxTextEntryDialog}}\label{wxtextentrydialogdtor}
  45
  46 \func{}{\destruct{wxTextEntryDialog}}{\void}
  47
  48 Destructor.
  49
  50 \membersection{wxTextEntryDialog::GetValue}\label{wxtextentrydialoggetvalue}
  51
  52 \constfunc{wxString}{GetValue}{\void}
  53
  54 Returns the text that the user has entered if the user has pressed OK, or the original value
  55 if the user has pressed Cancel.
  56
  57 \membersection{wxTextEntryDialog::SetValue}\label{wxtextentrydialogsetvalue}
  58
  59 \func{void}{SetValue}{\param{const wxString\& }{value}}
  60
  61 Sets the default text value.
  62
  63 \membersection{wxTextEntryDialog::ShowModal}\label{wxtextentrydialogshowmodal}
  64
  65 \func{int}{ShowModal}{\void}
  66
  67 Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
  68 otherwise.
  69
  70