]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/valtext.tex
Whole bunch of minor doc updates from an external patch.
[wxWidgets.git] / docs / latex / wx / valtext.tex
index f466e3abd6d2f2d6524e06c1d32aacb1a2811232..18deafa423742ca4ed14c6dcbfcbb768fa98b255 100644 (file)
@@ -10,14 +10,18 @@ For more information, please see \helpref{Validator overview}{validatoroverview}
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/valtext.h>
+
 \wxheading{See also}
 
-\helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator}, 
+\helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator},
 \helpref{wxGenericValidator}{wxgenericvalidator}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTextValidator::wxTextValidator}\label{wxtextvalidatorconstr}
+\membersection{wxTextValidator::wxTextValidator}\label{wxtextvalidatorctor}
 
 \func{}{wxTextValidator}{\param{const wxTextValidator\&}{ validator}}
 
@@ -39,18 +43,26 @@ Constructor, taking a style and optional pointer to a wxString variable.
 \twocolitem{{\bf wxFILTER\_ALPHANUMERIC}}{Non-alphanumeric characters are filtered out.}
 \twocolitem{{\bf wxFILTER\_NUMERIC}}{Non-numeric characters are filtered out.}
 \twocolitem{{\bf wxFILTER\_INCLUDE\_LIST}}{Use an include list. The validator
-checks if the user input is on the list, complaining if not.}
+checks if the user input is on the list, complaining if not. See 
+\helpref{wxTextValidator::SetIncludeList}{wxtextvalidatorsetincludelist}.}
 \twocolitem{{\bf wxFILTER\_EXCLUDE\_LIST}}{Use an exclude list. The validator
-checks if the user input is on the list, complaining if it is.}
+checks if the user input is on the list, complaining if it is. See 
+\helpref{wxTextValidator::SetExcludeList}{wxtextvalidatorsetexcludelist}.}
+\twocolitem{{\bf wxFILTER\_INCLUDE\_CHAR\_LIST}}{Use an include list. The validator
+checks if each input character is in the list (one character per list element), complaining if not.
+See \helpref{wxTextValidator::SetIncludeList}{wxtextvalidatorsetincludelist}.}
+\twocolitem{{\bf wxFILTER\_EXCLUDE\_CHAR\_LIST}}{Use an include list. The validator
+checks if each input character is in the list (one character per list element), complaining if it is.
+See \helpref{wxTextValidator::SetExcludeList}{wxtextvalidatorsetexcludelist}.}
 \end{twocollist}
 }
 
 \docparam{valPtr}{A pointer to a wxString variable that contains the value. This variable
 should have a lifetime equal to or longer than the validator lifetime (which is usually
-determined by the lifetime of the window). If NULL, the validator uses its own internal
-storage for the value.}
+determined by the lifetime of the window). % If NULL, the validator uses its own internal storage for the value. NOT true
+}
 
-\membersection{wxTextValidator::\destruct{wxTextValidator}}
+\membersection{wxTextValidator::\destruct{wxTextValidator}}\label{wxtextvalidatordtor}
 
 \func{}{\destruct{wxTextValidator}}{\void}
 
@@ -107,15 +119,15 @@ Sets the validator style.
 
 \membersection{wxTextValidator::TransferFromWindow}\label{wxtextvalidatortransferfromwindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferFromWindow}{}
 
-Transfers the string value to the window.
+Transfers the value in the text control to the string.
 
 \membersection{wxTextValidator::TransferToWindow}\label{wxtextvalidatortransfertowindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
-Transfers the window value to the string.
+Transfers the string value to the text control.
 
 \membersection{wxTextValidator::Validate}\label{wxtextvalidatorvalidate}