]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/validatr.tex
implemented nested index entries and index entries pointing to multiple documents...
[wxWidgets.git] / docs / latex / wx / validatr.tex
index bbb413bf01f4d18267ef608a3288b65d45814de7..0a725ccc74f37ac68a7a1bafbc5279d965e16850 100644 (file)
@@ -18,6 +18,10 @@ To specify a default, `null' validator, use the symbol {\bf wxDefaultValidator}.
 
 For more information, please see \helpref{Validator overview}{validatoroverview}.
 
 
 For more information, please see \helpref{Validator overview}{validatoroverview}.
 
+\pythonnote{If you wish to create a validator class in wxPython you should
+derive the class from {\tt wxPyValidator} in order to get Python-aware
+capabilities for the various virtual methods.}
+
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
@@ -30,9 +34,8 @@ For more information, please see \helpref{Validator overview}{validatoroverview}
 \wxheading{See also}
 
 \helpref{Validator overview}{validatoroverview}, 
 \wxheading{See also}
 
 \helpref{Validator overview}{validatoroverview}, 
-\helpref{wxTextValidator}{wxtextvalidator},
-\helpref{wxTextValidator}{wxgenericvalidator},
-
+\helpref{wxTextValidator}{wxtextvalidator}, 
+\helpref{wxGenericValidator}{wxgenericvalidator},
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -50,7 +53,7 @@ Destructor.
 
 \membersection{wxValidator::Clone}\label{wxvalidatorclone}
 
 
 \membersection{wxValidator::Clone}\label{wxvalidatorclone}
 
-\constfunc{virtual wxValidator*}{Clone}{\void}
+\constfunc{virtual wxObject*}{Clone}{\void}
 
 All validator classes must implement the {\bf Clone} function, which returns
 an identical copy of itself. This is because validators are passed to control
 
 All validator classes must implement the {\bf Clone} function, which returns
 an identical copy of itself. This is because validators are passed to control
@@ -69,7 +72,7 @@ Returns the window associated with the validator.
 
 \membersection{wxValidator::SetBellOnError}{wxvalidatorsetbellonerror}
 
 
 \membersection{wxValidator::SetBellOnError}{wxvalidatorsetbellonerror}
 
-\func{void}{SetBellOnError}{\param{bool}{ doIt = TRUE}}
+\func{void}{SetBellOnError}{\param{bool}{ doIt = true}}
 
 This functions switches on or turns off the error sound produced by the
 validators if an invalid key is pressed.
 
 This functions switches on or turns off the error sound produced by the
 validators if an invalid key is pressed.
@@ -82,23 +85,22 @@ Associates a window with the validator.
 
 \membersection{wxValidator::TransferFromWindow}\label{wxvalidatortransferfromwindow}
 
 
 \membersection{wxValidator::TransferFromWindow}\label{wxvalidatortransferfromwindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
 This overridable function is called when the value in the window must be
 
 This overridable function is called when the value in the window must be
-transferred to the validator. Return FALSE if there is a problem.
+transferred to the validator. Return false if there is a problem.
 
 \membersection{wxValidator::TransferToWindow}\label{wxvalidatortransfertowindow}
 
 
 \membersection{wxValidator::TransferToWindow}\label{wxvalidatortransfertowindow}
 
-\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
+\func{virtual bool}{TransferToWindow}{}
 
 This overridable function is called when the value associated with the validator must be
 
 This overridable function is called when the value associated with the validator must be
-transferred to the window. Return FALSE if there is a problem.
+transferred to the window. Return false if there is a problem.
 
 \membersection{wxValidator::Validate}\label{wxvalidatorvalidate}
 
 \func{virtual bool}{Validate}{\param{wxWindow*}{ parent}}
 
 This overridable function is called when the value in the associated window must be validated.
 
 \membersection{wxValidator::Validate}\label{wxvalidatorvalidate}
 
 \func{virtual bool}{Validate}{\param{wxWindow*}{ parent}}
 
 This overridable function is called when the value in the associated window must be validated.
-Return FALSE if the value in the window is not valid; you may pop up an error dialog.
-
+Return false if the value in the window is not valid; you may pop up an error dialog.