File: textdlg.tex

package info (click to toggle)
wxwidgets2.8 2.8.10.1-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 239,052 kB
  • ctags: 289,550
  • sloc: cpp: 1,838,857; xml: 396,717; python: 282,506; ansic: 126,171; makefile: 51,406; sh: 14,581; asm: 299; sql: 258; lex: 194; perl: 139; yacc: 128; pascal: 95; php: 39; lisp: 38; tcl: 24; haskell: 20; java: 18; cs: 18; erlang: 17; ruby: 16; ada: 9; ml: 9; csh: 9
file content (70 lines) | stat: -rw-r--r-- 2,213 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
\section{\class{wxTextEntryDialog}}\label{wxtextentrydialog}

This class represents a dialog that requests a one-line text string from the user.
It is implemented as a generic wxWidgets dialog.

\wxheading{Derived from}

\helpref{wxDialog}{wxdialog}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/textdlg.h>

\wxheading{See also}

\helpref{wxTextEntryDialog overview}{wxtextentrydialogoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxTextEntryDialog::wxTextEntryDialog}\label{wxtextentrydialogctor}

\func{}{wxTextEntryDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message},\rtfsp
\param{const wxString\& }{caption = "Please enter text"}, \param{const wxString\& }{defaultValue = ""}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE}, \param{const wxPoint\& }{pos = wxDefaultPosition}}

Constructor. Use \helpref{wxTextEntryDialog::ShowModal}{wxtextentrydialogshowmodal} to show the dialog.

\wxheading{Parameters}

\docparam{parent}{Parent window.}

\docparam{message}{Message to show on the dialog.}

\docparam{defaultValue}{The default value, which may be the empty string.}

\docparam{style}{A dialog style, specifying the buttons (wxOK, wxCANCEL)
and an optional wxCENTRE style. Additionally, wxTextCtrl styles (such as
\windowstyle{wxTE\_PASSWORD}) may be specified here.}

\docparam{pos}{Dialog position.}

\membersection{wxTextEntryDialog::\destruct{wxTextEntryDialog}}\label{wxtextentrydialogdtor}

\func{}{\destruct{wxTextEntryDialog}}{\void}

Destructor.

\membersection{wxTextEntryDialog::GetValue}\label{wxtextentrydialoggetvalue}

\constfunc{wxString}{GetValue}{\void}

Returns the text that the user has entered if the user has pressed OK, or the original value
if the user has pressed Cancel.

\membersection{wxTextEntryDialog::SetValue}\label{wxtextentrydialogsetvalue}

\func{void}{SetValue}{\param{const wxString\& }{value}}

Sets the default text value.

\membersection{wxTextEntryDialog::ShowModal}\label{wxtextentrydialogshowmodal}

\func{int}{ShowModal}{\void}

Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
otherwise.