Added wxGenericValidator & doc

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1635 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-02-07 17:11:44 +00:00
parent af615124b6
commit 89c684ef82
25 changed files with 582 additions and 10 deletions

View File

@@ -143,7 +143,7 @@ These classes are related to drawing on device contexts and windows.
\twocolitem{\helpref{wxFont}{wxfont}}{Represents fonts}
\twocolitem{\helpref{wxFontList}{wxfontlist}}{The list of previously-created fonts}
\twocolitem{\helpref{wxIcon}{wxicon}}{A small, transparent bitmap for assigning to frames and drawing on device contexts}
\twocolitem{\helpref{wxImage}{wximage}}{A platform-independent image class.}
\twocolitem{\helpref{wxImage}{wximage}}{A platform-independent image class}
\twocolitem{\helpref{wxImageList}{wximagelist}}{A list of images, used with some controls}
\twocolitem{\helpref{wxMask}{wxmask}}{Represents a mask to be used with a bitmap for transparent drawing}
\twocolitem{\helpref{wxPen}{wxpen}}{Used for drawing lines on a device context}
@@ -196,8 +196,9 @@ These are the window validators, used for filtering and validating
user input.
\begin{twocollist}\itemsep=0pt
\twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class.}
\twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class.}
\twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class}
\twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class}
\twocolitem{\helpref{wxGenericValidator}{wxgenericvalidator}}{Generic control validator class}
\end{twocollist}
{\large {\bf Data structures}}
@@ -222,7 +223,7 @@ These are the data structure classes supported by wxWindows.
\twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size}
\twocolitem{\helpref{wxTime}{wxtime}}{A class for time manipulation}
\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types
that may change at run-time.}
that may change at run-time}
\end{twocollist}
{\large {\bf Run-time class information system}}

View File

@@ -100,6 +100,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$
\input ftp.tex
\input gauge.tex
\input gdiobj.tex
\input valgen.tex
\input grid.tex
\input hash.tex
\input helpinst.tex

View File

@@ -1,7 +1,7 @@
% -----------------------------------------------------------------------------
% wxSocketInputStream
% -----------------------------------------------------------------------------
\section{\class{wxSocketInputStream}}
\section{\class{wxSocketInputStream}}\label{wxsocketinputstream}
\wxheading{Derived from}
@@ -23,7 +23,7 @@ socket connection.
% -----------------------------------------------------------------------------
% wxSocketOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxSocketInputStream}}
\section{\class{wxSocketOutputStream}}\label{wxsocketoutputstream}
\wxheading{Derived from}

81
docs/latex/wx/valgen.tex Normal file
View File

@@ -0,0 +1,81 @@
\section{\class{wxGenericValidator}}\label{wxgenericvalidator}
wxGenericValidator performs data transfer (but not validation or filtering) for the following
basic controls: wxButton, wxCheckBox, wxListBox, wxStaticText, wxRadioButton, wxRadioBox,
wxChoice, wxComboBox, wxGauge, wxSlider, wxScrollBar, wxSpinButton, wxTextCtrl, wxCheckListBox.
It checks the type of the window and uses an appropriate type for that window. For example,
wxButton and wxTextCtrl transfer data to and from a wxString variable; wxListBox uses a
wxArrayInt; wxCheckBox uses a bool.
For more information, please see \helpref{Validator overview}{validatoroverview}.
\wxheading{Derived from}
\helpref{wxValidator}{wxvalidator}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{See also}
\helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator},
\helpref{wxTextValidator}{wxTextvalidator}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGenericValidator::wxGenericValidator}\label{wxgenericvalidatorconstr}
\func{}{wxGenericValidator}{\param{const wxGenericValidator\&}{ validator}}
Copy constructor.
\func{}{wxGenericValidator}{\param{bool*}{ valPtr}}
Constructor taking a bool pointer. This will be used for wxCheckBox and wxRadioButton.
\func{}{wxGenericValidator}{\param{wxString*}{ valPtr}}
Constructor taking a wxString pointer. This will be used for wxButton, wxComboBox, wxStaticText,
wxTextCtrl.
\func{}{wxGenericValidator}{\param{int*}{ valPtr}}
Constructor taking an integer pointer. This will be used for wxGauge, wxScrollBar, wxRadioBox, wxSpinButton,
wxChoice.
\func{}{wxGenericValidator}{\param{wxArrayInt*}{ valPtr}}
Constructor taking a wxArrayInt pointer. This will be used for wxListBox, wxCheckListBox.
\wxheading{Parameters}
\docparam{validator}{Validator to copy.}
\docparam{valPtr}{A pointer to a 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).}
\membersection{wxGenericValidator::\destruct{wxGenericValidator}}
\func{}{\destruct{wxGenericValidator}}{\void}
Destructor.
\membersection{wxGenericValidator::Clone}\label{wxgenericvalidatorclone}
\constfunc{virtual wxValidator*}{Clone}{\void}
Clones the generic validator using the copy constructor.
\membersection{wxGenericValidator::TransferFromWindow}\label{wxgenericvalidatortransferfromwindow}
\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
Transfers the value to the window.
\membersection{wxGenericValidator::TransferToWindow}\label{wxgenericvalidatortransfertowindow}
\func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}}
Transfers the window value to the appropriate data type.

View File

@@ -12,7 +12,8 @@ For more information, please see \helpref{Validator overview}{validatoroverview}
\wxheading{See also}
\helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator}
\helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator},
\helpref{wxGenericValidator}{wxgenericvalidator}
\latexignore{\rtfignore{\wxheading{Members}}}
@@ -57,7 +58,7 @@ Destructor.
\membersection{wxTextValidator::Clone}\label{wxtextvalidatorclone}
\constfunc{virtual wxTextValidator*}{Clone}{\void}
\constfunc{virtual wxValidator*}{Clone}{\void}
Clones the text validator using the copy constructor.