Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More initial reviews of [u*-v*] interface headers.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53303 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-04-22 06:01:48 +00:00
parent 0c1fe6e947
commit fbec75d080
6 changed files with 406 additions and 433 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
interface/validate.h
View File

@@ -10,26 +10,27 @@
@class wxValidator
@wxheader{validate.h}
wxValidator is the base class for a family of validator classes that mediate
between a class of control, and application data.
wxValidator is the base class for a family of validator classes that
mediate between a class of control, and application data.
A validator has three major roles:
@li to transfer data from a C++ variable or own storage to and from a control;
@li to validate data in a control, and show an appropriate error message;
@li to filter events (such as keystrokes), thereby changing the behaviour of the
associated control.
-# To transfer data from a C++ variable or own storage to and from a
control.
-# To validate data in a control, and show an appropriate error message.
-# To filter events (such as keystrokes), thereby changing the behaviour
of the associated control.
Validators can be plugged into controls dynamically.
To specify a default, 'null' validator, use the symbol ::wxDefaultValidator.
To specify a default, "null" validator, use ::wxDefaultValidator.
For more information, please see @ref overview_validator.
@beginWxPythonOnly
If you wish to create a validator class in wxPython you should
derive the class from @c wxPyValidator in order to get Python-aware
capabilities for the various virtual methods.
If you wish to create a validator class in wxPython you should derive the
class from @c wxPyValidator in order to get Python-aware capabilities for
the various virtual methods.
@endWxPythonOnly
@library{wxcore}
@@ -54,15 +55,15 @@ public:
~wxValidator();
/**
All validator classes must implement the Clone() function, which returns
an identical copy of itself.
All validator classes must implement the Clone() function, which
returns an identical copy of itself.
This is because validators are passed to control constructors as references
which must be copied. Unlike objects such as pens and brushes, it does not
make sense to have a reference counting scheme to do this cloning, because
all validators should have separate data.
This is because validators are passed to control constructors as
references which must be copied. Unlike objects such as pens and
brushes, it does not make sense to have a reference counting scheme to
do this cloning because all validators should have separate data.
@returns this base function returns @NULL.
@returns This base function returns @NULL.
*/
virtual wxObject* Clone() const;
@@ -83,8 +84,8 @@ public:
void SetWindow(wxWindow* window);
/**
This overridable function is called when the value in the window must be
transferred to the validator.
This overridable function is called when the value in the window must
be transferred to the validator.
@return @false if there is a problem.
*/
@@ -99,16 +100,17 @@ public:
virtual bool TransferToWindow();
/**
This overridable function is called when the value in the associated window
must be validated.
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.
*/
virtual bool Validate(wxWindow* parent);
};
/**
An empty wxValidator instance.
An empty, "null" wxValidator instance.
*/
wxValidator wxDefaultValidator;