git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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