]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/validatr.tex
Moved include for Windows compilation; minor doc tweaks
[wxWidgets.git] / docs / latex / wx / validatr.tex
index c5c13bf4d2508e54ed644d453f57d4efe1455c34..765c4d20845fe5c727b9e83da1511371f0521aad 100644 (file)
@@ -18,14 +18,24 @@ 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}\\
 \helpref{wxObject}{wxobject}
 
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/validate.h>
+
 \wxheading{See also}
 
 \wxheading{See also}
 
-\helpref{Validator overview}{validatoroverview}, \helpref{wxTextValidator}{wxtextvalidator}
+\helpref{Validator overview}{validatoroverview}, 
+\helpref{wxTextValidator}{wxtextvalidator}, 
+\helpref{wxGenericValidator}{wxgenericvalidator},
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -43,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
@@ -60,6 +70,13 @@ This base function returns NULL.
 
 Returns the window associated with the validator.
 
 
 Returns the window associated with the validator.
 
+\membersection{wxValidator::SetBellOnError}{wxvalidatorsetbellonerror}
+
+\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.
+
 \membersection{wxValidator::SetWindow}\label{wxvalidatorsetwindow}
 
 \func{void}{SetWindow}{\param{wxWindow*}{ window}}
 \membersection{wxValidator::SetWindow}\label{wxvalidatorsetwindow}
 
 \func{void}{SetWindow}{\param{wxWindow*}{ window}}
@@ -68,14 +85,14 @@ 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
 transferred to the validator. Return FALSE if there is a problem.
 
 \membersection{wxValidator::TransferToWindow}\label{wxvalidatortransfertowindow}
 
 
 This overridable function is called when the value in the window must be
 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.
 
 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.
@@ -87,4 +104,3 @@ transferred to the window. Return FALSE if there is a problem.
 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.
 
 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.
 
-