X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..7b0ccb8a603b4f97740acc65d9429bb58f7ba1bd:/interface/valtext.h diff --git a/interface/valtext.h b/interface/valtext.h index 40849a7b95..29e9e283d2 100644 --- a/interface/valtext.h +++ b/interface/valtext.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: valtext.h -// Purpose: documentation for wxTextValidator class +// Purpose: interface of wxTextValidator // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,8 +19,7 @@ @library{wxcore} @category{validator} - @seealso - @ref overview_validatoroverview "Validator overview", wxValidator, + @see @ref overview_validatoroverview "Validator overview", wxValidator, wxGenericValidator */ class wxTextValidator : public wxValidator @@ -29,96 +28,150 @@ public: //@{ /** Constructor, taking a style and optional pointer to a wxString variable. - + @param style - A bitlist of flags, which can be: - - - wxFILTER_NONE - - - No filtering takes place. - - wxFILTER_ASCII - - - Non-ASCII characters are filtered out. - - wxFILTER_ALPHA - - - Non-alpha characters are filtered out. - - wxFILTER_ALPHANUMERIC - - - Non-alphanumeric characters are filtered out. - - wxFILTER_NUMERIC - - - Non-numeric characters are filtered out. - - wxFILTER_INCLUDE_LIST - - - Use an include list. The validator - checks if the user input is on the list, complaining if not. See - SetIncludes(). - - wxFILTER_EXCLUDE_LIST - - - Use an exclude list. The validator - checks if the user input is on the list, complaining if it is. See - SetExcludes(). - - wxFILTER_INCLUDE_CHAR_LIST - - - Use an include list. The validator - checks if each input character is in the list (one character per list element), - complaining if not. - See SetIncludes(). - - wxFILTER_EXCLUDE_CHAR_LIST - - - Use an include list. The validator - checks if each input character is in the list (one character per list element), - complaining if it is. - See SetExcludes(). - + A bitlist of flags, which can be: + + + + + + + + wxFILTER_NONE + + + + + No filtering takes place. + + + + + + wxFILTER_ASCII + + + + + Non-ASCII characters are filtered out. + + + + + + wxFILTER_ALPHA + + + + + Non-alpha characters are filtered out. + + + + + + wxFILTER_ALPHANUMERIC + + + + + Non-alphanumeric characters are filtered out. + + + + + + wxFILTER_NUMERIC + + + + + Non-numeric characters are filtered out. + + + + + + wxFILTER_INCLUDE_LIST + + + + + Use an include list. The validator + checks if the user input is on the list, complaining if not. See + SetIncludes(). + + + + + + wxFILTER_EXCLUDE_LIST + + + + + Use an exclude list. The validator + checks if the user input is on the list, complaining if it is. See + SetExcludes(). + + + + + + wxFILTER_INCLUDE_CHAR_LIST + + + + + Use an include list. The validator + checks if each input character is in the list (one character per list + element), complaining if not. + See SetIncludes(). + + + + + + wxFILTER_EXCLUDE_CHAR_LIST + + + + + Use an include list. The validator + checks if each input character is in the list (one character per list + element), complaining if it is. + See SetExcludes(). @param valPtr - A pointer to a wxString 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). + A pointer to a wxString 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). */ wxTextValidator(const wxTextValidator& validator); wxTextValidator(long style = wxFILTER_NONE, - wxString* valPtr = @NULL); + wxString* valPtr = NULL); //@} /** Clones the text validator using the copy constructor. */ - virtual wxValidator* Clone(); + virtual wxValidator* Clone() const; /** Returns a reference to the exclude list (the list of invalid values). */ - wxArrayString GetExcludes(); + wxArrayString GetExcludes() const; /** Returns a reference to the include list (the list of valid values). */ - wxArrayString GetIncludes(); + wxArrayString GetIncludes() const; /** Returns the validator style. */ - long GetStyle(); + long GetStyle() const; /** Receives character input from the window and filters it according to the @@ -157,3 +210,4 @@ public: */ virtual bool Validate(wxWindow* parent); }; +