docs/latex/wx/valtext.tex

   1 \section{\class{wxTextValidator}}\label{wxtextvalidator}
   2
   3 wxTextValidator validates text controls, providing a variety of filtering behaviours.
   4
   5 For more information, please see \helpref{Validator overview}{validatoroverview}.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxValidator}{wxvalidator}\\
  10 \helpref{wxEvtHandler}{wxevthandler}\\
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/valtext.h>
  16
  17 \wxheading{See also}
  18
  19 \helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator},
  20 \helpref{wxGenericValidator}{wxgenericvalidator}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24 \membersection{wxTextValidator::wxTextValidator}\label{wxtextvalidatorctor}
  25
  26 \func{}{wxTextValidator}{\param{const wxTextValidator\&}{ validator}}
  27
  28 Copy constructor.
  29
  30 \func{}{wxTextValidator}{\param{long}{ style = wxFILTER\_NONE}, \param{wxString* }{valPtr = NULL}}
  31
  32 Constructor, taking a style and optional pointer to a wxString variable.
  33
  34 \wxheading{Parameters}
  35
  36 \docparam{style}{A bitlist of flags, which can be:
  37
  38 \twocolwidtha{5cm}
  39 \begin{twocollist}
  40 \twocolitem{{\bf wxFILTER\_NONE}}{No filtering takes place.}
  41 \twocolitem{{\bf wxFILTER\_ASCII}}{Non-ASCII characters are filtered out.}
  42 \twocolitem{{\bf wxFILTER\_ALPHA}}{Non-alpha characters are filtered out.}
  43 \twocolitem{{\bf wxFILTER\_ALPHANUMERIC}}{Non-alphanumeric characters are filtered out.}
  44 \twocolitem{{\bf wxFILTER\_NUMERIC}}{Non-numeric characters are filtered out.}
  45 \twocolitem{{\bf wxFILTER\_INCLUDE\_LIST}}{Use an include list. The validator
  46 checks if the user input is on the list, complaining if not. See
  47 \helpref{wxTextValidator::SetIncludeList}{wxtextvalidatorsetincludelist}.}
  48 \twocolitem{{\bf wxFILTER\_EXCLUDE\_LIST}}{Use an exclude list. The validator
  49 checks if the user input is on the list, complaining if it is. See
  50 \helpref{wxTextValidator::SetExcludeList}{wxtextvalidatorsetexcludelist}.}
  51 \twocolitem{{\bf wxFILTER\_INCLUDE\_CHAR\_LIST}}{Use an include list. The validator
  52 checks if each input character is in the list (one character per list element), complaining if not.
  53 See \helpref{wxTextValidator::SetIncludeList}{wxtextvalidatorsetincludelist}.}
  54 \twocolitem{{\bf wxFILTER\_EXCLUDE\_CHAR\_LIST}}{Use an include list. The validator
  55 checks if each input character is in the list (one character per list element), complaining if it is.
  56 See \helpref{wxTextValidator::SetExcludeList}{wxtextvalidatorsetexcludelist}.}
  57 \end{twocollist}
  58 }
  59
  60 \docparam{valPtr}{A pointer to a wxString variable that contains the value. This variable
  61 should have a lifetime equal to or longer than the validator lifetime (which is usually
  62 determined by the lifetime of the window). % If NULL, the validator uses its own internal storage for the value. NOT true
  63 }
  64
  65 \membersection{wxTextValidator::\destruct{wxTextValidator}}\label{wxtextvalidatordtor}
  66
  67 \func{}{\destruct{wxTextValidator}}{\void}
  68
  69 Destructor.
  70
  71 \membersection{wxTextValidator::Clone}\label{wxtextvalidatorclone}
  72
  73 \constfunc{virtual wxValidator*}{Clone}{\void}
  74
  75 Clones the text validator using the copy constructor.
  76
  77 \membersection{wxTextValidator::GetExcludeList}\label{wxtextvalidatorgetexcludelist}
  78
  79 \constfunc{wxStringList\&}{GetExcludeList}{\void}
  80
  81 Returns a reference to the exclude list (the list of invalid values).
  82
  83 \membersection{wxTextValidator::GetIncludeList}\label{wxtextvalidatorgetincludelist}
  84
  85 \constfunc{wxStringList\&}{GetIncludeList}{\void}
  86
  87 Returns a reference to the include list (the list of valid values).
  88
  89 \membersection{wxTextValidator::GetStyle}\label{wxtextvalidatorgetstyle}
  90
  91 \constfunc{long}{GetStyle}{\void}
  92
  93 Returns the validator style.
  94
  95 \membersection{wxTextValidator::OnChar}\label{wxtextvalidatoronchar}
  96
  97 \func{void}{OnChar}{\param{wxKeyEvent\&}{ event}}
  98
  99 Receives character input from the window and filters it according to the
 100 current validator style.
 101
 102 \membersection{wxTextValidator::SetExcludeList}\label{wxtextvalidatorsetexcludelist}
 103
 104 \func{void}{SetExcludeList}{\param{const wxStringList\&}{ stringList}}
 105
 106 Sets the exclude list (invalid values for the user input).
 107
 108 \membersection{wxTextValidator::SetIncludeList}\label{wxtextvalidatorsetincludelist}
 109
 110 \func{void}{SetIncludeList}{\param{const wxStringList\&}{ stringList}}
 111
 112 Sets the include list (valid values for the user input).
 113
 114 \membersection{wxTextValidator::SetStyle}\label{wxtextvalidatorsetstyle}
 115
 116 \func{void}{SetStyle}{\param{long}{ style}}
 117
 118 Sets the validator style.
 119
 120 \membersection{wxTextValidator::TransferFromWindow}\label{wxtextvalidatortransferfromwindow}
 121
 122 \func{virtual bool}{TransferFromWindow}{}
 123
 124 Transfers the value in the text control to the string.
 125
 126 \membersection{wxTextValidator::TransferToWindow}\label{wxtextvalidatortransfertowindow}
 127
 128 \func{virtual bool}{TransferToWindow}{}
 129
 130 Transfers the string value to the text control.
 131
 132 \membersection{wxTextValidator::Validate}\label{wxtextvalidatorvalidate}
 133
 134 \func{virtual bool}{Validate}{\param{wxWindow*}{ parent}}
 135
 136 Validates the window contents against the include or exclude lists, depending
 137 on the validator style.
 138