d7f19ee610
Apply the utility from https://github.com/codespell-project/codespell/ to fix spelling issues in the headers under both include and interface directories and add a file with a couple of exceptions. The exact command line used was: $ codespell -w -I misc/scripts/codespell.ignore -i 3 in*
317 lines
10 KiB
Objective-C
317 lines
10 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: valtext.h
|
|
// Purpose: interface of wxTextValidator
|
|
// Author: wxWidgets team
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
/**
|
|
Styles used by wxTextValidator.
|
|
|
|
Notice that wxFILTER_EXCLUDE[_CHAR]_LIST pair can be used to document the
|
|
purpose of the validator only and are not enforced in the implementation of
|
|
the wxTextValidator. Therefore, calling the corresponding member functions:
|
|
wxTextValidator::{SetExcludes,SetCharExcludes}(), is enough to create the
|
|
desired validator.
|
|
*/
|
|
enum wxTextValidatorStyle
|
|
{
|
|
/// No filtering takes place.
|
|
wxFILTER_NONE,
|
|
|
|
/// Empty strings are filtered out.
|
|
/// If this style is not specified then empty strings are accepted
|
|
/// only if they pass the other checks (if you use more than one wxTextValidatorStyle).
|
|
wxFILTER_EMPTY,
|
|
|
|
/// Non-ASCII characters are filtered out. See wxString::IsAscii.
|
|
wxFILTER_ASCII,
|
|
|
|
/// Non-alpha characters are filtered out.
|
|
/// Uses the wxWidgets wrapper for the standard CRT function @c isalpha
|
|
/// (which is locale-dependent) on all characters of the string.
|
|
wxFILTER_ALPHA,
|
|
|
|
/// Non-alphanumeric characters are filtered out.
|
|
/// Uses the wxWidgets wrapper for the standard CRT function @c isalnum
|
|
/// (which is locale-dependent) on all characters of the string.
|
|
/// Equivalent to wxFILTER_ALPHA combined with wxFILTER_DIGITS or
|
|
/// wxFILTER_XDIGITS, or with both of them.
|
|
wxFILTER_ALPHANUMERIC,
|
|
|
|
/// Non-digit characters are filtered out.
|
|
/// Uses the wxWidgets wrapper for the standard CRT function @c isdigit
|
|
/// (which is locale-dependent) on all characters of the string.
|
|
wxFILTER_DIGITS,
|
|
|
|
/// Non-numeric characters are filtered out.
|
|
/// Works like @c wxFILTER_DIGITS but allows also decimal points,
|
|
/// minus/plus signs and the 'e' or 'E' character to input exponents.
|
|
/// Note that this is not the same behaviour of wxString::IsNumber().
|
|
wxFILTER_NUMERIC,
|
|
|
|
/// Use an include list. The validator checks if the user input is on
|
|
/// the list, complaining if not. See wxTextValidator::SetIncludes().
|
|
wxFILTER_INCLUDE_LIST,
|
|
|
|
/// Use an include char list.
|
|
/// Characters in the include char list will be allowed to be in the
|
|
/// user input. See wxTextValidator::SetCharIncludes().
|
|
/// If this style is set with one or more of the following styles:
|
|
/// wxFILTER_ASCII, wxFILTER_ALPHA, wxFILTER_ALPHANUMERIC, wxFILTER_DIGITS,
|
|
/// wxFILTER_XDIGITS, wxFILTER_NUMERIC it just extends the character class
|
|
/// denoted by the aforementioned styles with those specified in the include
|
|
/// char list. If set alone, then the characters allowed to be in the user input
|
|
/// are restricted to those, and only those, present in the include char list.
|
|
wxFILTER_INCLUDE_CHAR_LIST,
|
|
|
|
/// Use an exclude list. The validator checks if the user input is on
|
|
/// the list, complaining if it is. See wxTextValidator::SetExcludes().
|
|
wxFILTER_EXCLUDE_LIST,
|
|
|
|
/// Use an exclude char list.
|
|
/// Characters in the exclude char list won't be allowed to be in the
|
|
/// user input. See wxTextValidator::SetCharExcludes().
|
|
wxFILTER_EXCLUDE_CHAR_LIST,
|
|
|
|
/// Non-hexadecimal characters are filtered out.
|
|
/// Uses the wxWidgets wrapper for the standard CRT function @c isxdigit
|
|
/// (which is locale-dependent) on all characters of the string.
|
|
wxFILTER_XDIGITS,
|
|
|
|
/// A convenience flag for use with the other flags.
|
|
/// The space character is more often used with alphanumeric characters
|
|
/// which makes setting a flag more easier than calling SetCharIncludes(" ")
|
|
/// for that matter.
|
|
wxFILTER_SPACE
|
|
};
|
|
|
|
/**
|
|
@class wxTextValidator
|
|
|
|
wxTextValidator validates text controls, providing a variety of filtering
|
|
behaviours.
|
|
|
|
For more information, please see @ref overview_validator.
|
|
|
|
@library{wxcore}
|
|
@category{validator}
|
|
|
|
@see @ref overview_validator, wxValidator, wxGenericValidator,
|
|
wxIntegerValidator, wxFloatingPointValidator
|
|
*/
|
|
class wxTextValidator : public wxValidator
|
|
{
|
|
public:
|
|
/**
|
|
Copy constructor.
|
|
*/
|
|
wxTextValidator(const wxTextValidator& validator);
|
|
|
|
/**
|
|
Constructor taking a style and optional pointer to a wxString variable.
|
|
|
|
@param style
|
|
One or more of the ::wxTextValidatorStyle styles. See SetStyle().
|
|
@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).
|
|
*/
|
|
wxTextValidator(long style = wxFILTER_NONE, wxString* valPtr = NULL);
|
|
|
|
/**
|
|
Clones the text validator using the copy constructor.
|
|
*/
|
|
virtual wxObject* Clone() const;
|
|
|
|
/**
|
|
Returns a copy of the exclude char list (the list of invalid characters).
|
|
|
|
@since 3.1.3
|
|
*/
|
|
wxString GetCharExcludes() const;
|
|
|
|
/**
|
|
Returns a copy of the include char list (the list of additional valid characters).
|
|
|
|
@since 3.1.3
|
|
*/
|
|
wxString GetCharIncludes() const;
|
|
|
|
/**
|
|
Returns a const reference to the exclude list (the list of invalid values).
|
|
*/
|
|
const wxArrayString& GetExcludes() const;
|
|
|
|
/**
|
|
Returns a const reference to the include list (the list of valid values).
|
|
*/
|
|
const wxArrayString& GetIncludes() const;
|
|
|
|
/**
|
|
Returns the validator style.
|
|
|
|
@see HasFlag()
|
|
*/
|
|
long GetStyle() const;
|
|
|
|
/**
|
|
Returns @true if the given @a style bit is set in the current style.
|
|
*/
|
|
bool HasFlag(wxTextValidatorStyle style) const;
|
|
|
|
/**
|
|
Receives character input from the window and filters it according to
|
|
the current validator style.
|
|
*/
|
|
void OnChar(wxKeyEvent& event);
|
|
|
|
/**
|
|
Sets the exclude list (invalid values for the user input).
|
|
|
|
@note Beware that exclusion takes priority over inclusion.
|
|
*/
|
|
void SetExcludes(const wxArrayString& stringList);
|
|
|
|
/**
|
|
Sets the exclude char list (invalid characters for the user input).
|
|
|
|
@note Beware that exclusion takes priority over inclusion.
|
|
@note This function may cancel the effect of @c wxFILTER_SPACE if the passed
|
|
in string @a chars contains the @b space character.
|
|
*/
|
|
void SetCharExcludes(const wxString& chars);
|
|
|
|
/**
|
|
Sets the include list (valid values for the user input).
|
|
|
|
@see IsIncluded()
|
|
*/
|
|
void SetIncludes(const wxArrayString& stringList);
|
|
|
|
/**
|
|
Sets the include char list (additional valid values for the user input).
|
|
|
|
@note Any explicitly excluded characters will still be excluded even if
|
|
they're part of @a chars.
|
|
*/
|
|
void SetCharIncludes(const wxString& chars);
|
|
|
|
/**
|
|
Adds @a exclude to the list of excluded values.
|
|
|
|
@note Beware that exclusion takes priority over inclusion.
|
|
|
|
@since 3.1.3
|
|
*/
|
|
void AddExclude(const wxString& exclude);
|
|
|
|
/**
|
|
Adds @a include to the list of included values.
|
|
|
|
@note Any explicitly excluded characters will still be excluded.
|
|
|
|
@since 3.1.3
|
|
*/
|
|
void AddInclude(const wxString& include);
|
|
|
|
/**
|
|
Adds @a chars to the list of excluded characters.
|
|
|
|
@note Beware that exclusion takes priority over inclusion.
|
|
|
|
@since 3.1.3
|
|
*/
|
|
void AddCharExcludes(const wxString& chars);
|
|
|
|
/**
|
|
Adds @a chars to the list of included characters.
|
|
|
|
@note Any explicitly excluded characters will still be excluded even if
|
|
they're part of @a chars.
|
|
|
|
@since 3.1.3
|
|
*/
|
|
void AddCharIncludes(const wxString& chars);
|
|
|
|
|
|
/**
|
|
Sets the validator style which must be a combination of one or more
|
|
of the ::wxTextValidatorStyle values.
|
|
|
|
Note that not all possible combinations make sense! Also, some
|
|
combinations have shorter and more idiomatic alternative, e.g.
|
|
@c wxFILTER_ALPHANUMERIC can be used instead of
|
|
@c wxFILTER_ALPHA|wxFILTER_DIGITS.
|
|
*/
|
|
void SetStyle(long style);
|
|
|
|
/**
|
|
Transfers the value in the text control to the string.
|
|
*/
|
|
virtual bool TransferFromWindow();
|
|
|
|
/**
|
|
Transfers the string value to the text control.
|
|
*/
|
|
virtual bool TransferToWindow();
|
|
|
|
/**
|
|
Validates the window contents against the include or exclude lists,
|
|
depending on the validator style.
|
|
*/
|
|
virtual bool Validate(wxWindow* parent);
|
|
|
|
/**
|
|
Returns the error message if the contents of @a val are invalid
|
|
or the empty string if @a val is valid.
|
|
*/
|
|
virtual wxString IsValid(const wxString& val) const;
|
|
|
|
protected:
|
|
|
|
/**
|
|
Returns @true if the char @a c is allowed to be in the user input string.
|
|
Additional characters, set by SetCharIncludes() or AddCharIncludes() are
|
|
also considered.
|
|
|
|
@since 3.1.3
|
|
*/
|
|
bool IsCharIncluded(const wxUniChar& c) const;
|
|
|
|
/**
|
|
Returns @true if the char @a c is not allowed to be in the user input string.
|
|
(characters set by SetCharExcludes() or AddCharExcludes()).
|
|
|
|
@since 3.1.3
|
|
*/
|
|
bool IsCharExcluded(const wxUniChar& c) const;
|
|
|
|
/**
|
|
Returns @true if the string @a str is one of the includes strings set by
|
|
SetIncludes() or AddInclude().
|
|
|
|
Notice that unless wxFILTER_INCLUDE_LIST is specified (in which case the
|
|
validator will complain if the user input is not on the list), the list
|
|
will be ignored and won't participate in the validation process.
|
|
|
|
@since 3.1.3
|
|
*/
|
|
bool IsIncluded(const wxString& str) const;
|
|
|
|
/**
|
|
Returns @true if the string @a str is one of the excludes strings set by
|
|
SetExcludes() or AddExclude().
|
|
|
|
@since 3.1.3
|
|
*/
|
|
bool IsExcluded(const wxString& str) const;
|
|
|
|
/// Returns false if the character @a c is invalid.
|
|
bool IsValidChar(const wxUniChar& c) const;
|
|
};
|
|
|