cross-reference types in the generated docs (patch 1038083)

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

diff --git a/docs/latex/wx/validatr.tex b/docs/latex/wx/validatr.tex
index b6319b0a39dfafb8b688d598e0a8e3f996b2d3ac..aa21a3017a5f34ad91e46c084efdece5fd28bd8e 100644 (file)
--- a/docs/latex/wx/validatr.tex
+++ b/docs/latex/wx/validatr.tex
@@ -18,6 +18,10 @@ To specify a default, `null' validator, use the symbol {\bf wxDefaultValidator}.
 
 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}\\
@@ -29,17 +33,19 @@ For more information, please see \helpref{Validator overview}{validatoroverview}
 
 \wxheading{See also}
 
-\helpref{Validator overview}{validatoroverview}, \helpref{wxTextValidator}{wxtextvalidator}
+\helpref{Validator overview}{validatoroverview}, 
+\helpref{wxTextValidator}{wxtextvalidator}, 
+\helpref{wxGenericValidator}{wxgenericvalidator},
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxValidator::wxValidator}\label{wxvalidatorconstr}
+\membersection{wxValidator::wxValidator}\label{wxvalidatorctor}
 
 \func{}{wxValidator}{\void}
 
 Constructor.
 
-\membersection{wxValidator::\destruct{wxValidator}}
+\membersection{wxValidator::\destruct{wxValidator}}\label{wxvalidatordtor}
 
 \func{}{\destruct{wxValidator}}{\void}
 
@@ -47,7 +53,7 @@ Destructor.
 
 \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
@@ -64,9 +70,9 @@ This base function returns NULL.
 
 Returns the window associated with the validator.
 
-\membersection{wxValidator::SetBellOnError}{wxvalidatorsetbellonerror}
+\membersection{wxValidator::SetBellOnError}\label{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.
@@ -79,23 +85,22 @@ Associates a window with the validator.
 
 \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
-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}
 
-\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
-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.
-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.