]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/textdlg.tex
initial draft of wxCollapsiblePane (patch 1577412 by Francesco)
[wxWidgets.git] / docs / latex / wx / textdlg.tex
index ec2f8d1db58017b5b23a2fd622958f974a712169..c09cb219553d5db4a64e0ddce73588d1f836f7a8 100644 (file)
@@ -1,7 +1,7 @@
 \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 wxWindows dialog.
+It is implemented as a generic wxWidgets dialog.
 
 \wxheading{Derived from}
 
@@ -10,16 +10,20 @@ It is implemented as a generic wxWindows dialog.
 \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{wxtextentrydialogconstr}
+\membersection{wxTextEntryDialog::wxTextEntryDialog}\label{wxtextentrydialogctor}
 
-\func{}{wxTextEntryDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Please enter text"},\rtfsp
-\param{const wxString\& }{defaultValue = ""}, \param{long }{style = wxOK \pipe wxCANCEL \pipe wxCENTRE}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
+\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.
 
@@ -31,11 +35,13 @@ Constructor. Use \helpref{wxTextEntryDialog::ShowModal}{wxtextentrydialogshowmod
 
 \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.}
+\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}}
+\membersection{wxTextEntryDialog::\destruct{wxTextEntryDialog}}\label{wxtextentrydialogdtor}
 
 \func{}{\destruct{wxTextEntryDialog}}{\void}
 
@@ -58,7 +64,7 @@ Sets the default text value.
 
 \func{int}{ShowModal}{\void}
 
-Shows the dialog, returning wxID\_OK if the user pressed OK, and wxOK\_CANCEL
+Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
 otherwise.