clarified global and local config files behavior

[wxWidgets.git] / docs / latex / wx / valtext.tex

diff --git a/docs/latex/wx/valtext.tex b/docs/latex/wx/valtext.tex
index 87ca0bb22ba19520d3d9ba59d268a9c4fcd32669..7a7d53a83d09465e4a6e1e7c96c8040ef633127b 100644 (file)
--- a/docs/latex/wx/valtext.tex
+++ b/docs/latex/wx/valtext.tex
@@ -21,7 +21,7 @@ For more information, please see \helpref{Validator overview}{validatoroverview}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxTextValidator::wxTextValidator}\label{wxtextvalidatorconstr}
+\membersection{wxTextValidator::wxTextValidator}\label{wxtextvalidatorctor}

 
 \func{}{wxTextValidator}{\param{const wxTextValidator\&}{ validator}}
 
 
 \func{}{wxTextValidator}{\param{const wxTextValidator\&}{ validator}}
 


@@ -43,42 +43,40 @@ 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
 \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::SetIncludes}{wxtextvalidatorsetincludes}.}

 \twocolitem{{\bf wxFILTER\_EXCLUDE\_LIST}}{Use an exclude list. The validator
 \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::SetExcludes}{wxtextvalidatorsetexcludes}.}

 \twocolitem{{\bf wxFILTER\_INCLUDE\_CHAR\_LIST}}{Use an include list. The validator
 \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.}
+checks if each input character is in the list (one character per list element), complaining if not.
+See \helpref{wxTextValidator::SetIncludes}{wxtextvalidatorsetincludes}.}

 \twocolitem{{\bf wxFILTER\_EXCLUDE\_CHAR\_LIST}}{Use an include list. The validator
 \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.}
+checks if each input character is in the list (one character per list element), complaining if it is.
+See \helpref{wxTextValidator::SetExcludes}{wxtextvalidatorsetexcludes}.}

 \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
 \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. NOT TRUE
+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}}
-
-\func{}{\destruct{wxTextValidator}}{\void}
-
-Destructor.
-

 \membersection{wxTextValidator::Clone}\label{wxtextvalidatorclone}
 
 \constfunc{virtual wxValidator*}{Clone}{\void}
 
 Clones the text validator using the copy constructor.
 
 \membersection{wxTextValidator::Clone}\label{wxtextvalidatorclone}
 
 \constfunc{virtual wxValidator*}{Clone}{\void}
 
 Clones the text validator using the copy constructor.
 

-\membersection{wxTextValidator::GetExcludeList}\label{wxtextvalidatorgetexcludelist}
+\membersection{wxTextValidator::GetExcludes}\label{wxtextvalidatorgetexcludes}

 
 

-\constfunc{wxStringList\&}{GetExcludeList}{\void}
+\constfunc{wxArrayString\&}{GetExcludes}{\void}

 
 Returns a reference to the exclude list (the list of invalid values).
 
 
 Returns a reference to the exclude list (the list of invalid values).
 

-\membersection{wxTextValidator::GetIncludeList}\label{wxtextvalidatorgetincludelist}
+\membersection{wxTextValidator::GetIncludes}\label{wxtextvalidatorgetincludes}

 
 

-\constfunc{wxStringList\&}{GetIncludeList}{\void}
+\constfunc{wxArrayString\&}{GetIncludes}{\void}

 
 Returns a reference to the include list (the list of valid values).
 
 
 Returns a reference to the include list (the list of valid values).
 


@@ -95,15 +93,15 @@ Returns the validator style.
 Receives character input from the window and filters it according to the
 current validator style.
 
 Receives character input from the window and filters it according to the
 current validator style.
 

-\membersection{wxTextValidator::SetExcludeList}\label{wxtextvalidatorsetexcludelist}
+\membersection{wxTextValidator::SetExcludes}\label{wxtextvalidatorsetexcludes}

 
 

-\func{void}{SetExcludeList}{\param{const wxStringList\&}{ stringList}}
+\func{void}{SetExcludes}{\param{const wxArrayString\&}{ stringList}}

 
 Sets the exclude list (invalid values for the user input).
 
 
 Sets the exclude list (invalid values for the user input).
 

-\membersection{wxTextValidator::SetIncludeList}\label{wxtextvalidatorsetincludelist}
+\membersection{wxTextValidator::SetIncludes}\label{wxtextvalidatorsetincludes}

 
 

-\func{void}{SetIncludeList}{\param{const wxStringList\&}{ stringList}}
+\func{void}{SetIncludes}{\param{const wxArrayString\&}{ stringList}}

 
 Sets the include list (valid values for the user input).
 
 
 Sets the include list (valid values for the user input).
 


@@ -117,13 +115,13 @@ Sets the validator style.
 
 \func{virtual bool}{TransferFromWindow}{}
 
 
 \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}{}
 
 
 \membersection{wxTextValidator::TransferToWindow}\label{wxtextvalidatortransfertowindow}
 
 \func{virtual bool}{TransferToWindow}{}
 

-Transfers the window value to the string.
+Transfers the string value to the text control.

 
 \membersection{wxTextValidator::Validate}\label{wxtextvalidatorvalidate}
 
 
 \membersection{wxTextValidator::Validate}\label{wxtextvalidatorvalidate}