/usr/include/Wt/WValidator is in libwt-dev 3.1.10-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WVALIDATOR_H_
#define WVALIDATOR_H_
#include <iostream>
#include <Wt/WObject>
#include <Wt/WString>
namespace Wt {
class WFormWidget;
/*! \class WValidator Wt/WValidator Wt/WValidator
* \brief A validator is used to validate user input according to
* pre-defined rules.
*
* A validator may be associated with a form widget using
* WFormWidget::setValidator().
*
* The validator validates the user input. A validator may have a
* split implementation to provide both validation at the client-side
* (which gives instant feed-back to the user while editing), and
* server-side validation (to be sure that the client was not tampered
* with). The feed-back given by (client-side and server-side)
* validation is reflected in the style class of the form field: a
* style class of <tt>Wt-invalid</tt> is set for a field that is
* invalid.
*
* This %WValidator only checks that mandatory fields are not empty.
* This class is reimplemented in WDateValidator, WIntValidator,
* WDoubleValidator, WLengthValidator and WRegExpValidator. All these
* validators provibe both client-side and server-side validation.
*
* If these validators are not suitable, you can inherit from this
* class, and provide a suitable implementation to validate() which
* does the server-side validation. If you want to provide client-side
* validation for your own validator, you may also reimplement
* javaScriptValidate().
*
* <h3>i18n</h3>
*
* The strings used in this class can be translated by overriding
* the default values for the following localization keys:
* - Wt.WValidator.Invalid: This field cannot be empty
*
* \sa WFormWidget
*/
class WT_API WValidator : public WObject
{
public:
/*! \brief The state in which validated input can exist.
*/
enum State { Invalid, //!< The input is invalid.
InvalidEmpty, //!< The input is invalid (emtpy and mandatory).
Valid //!< The input is valid.
};
/*! \brief Creates a new validator.
*/
WValidator(WObject *parent = 0);
/*! \brief Creates a new validator.
*
* Indicate whether input is mandatory.
*
* \sa setMandatory(bool)
*/
WValidator(bool mandatory, WObject *parent = 0);
/*! \brief Destructor.
*
* The validator automatically removes itself from all formfields to
* which it was associated.
*/
~WValidator();
/*! \brief Sets if input is mandatory
*
* When an input is not mandatory, then an empty field is always
* valid.
*/
void setMandatory(bool how);
/*! \brief Returns if input is mandatory.
*/
bool isMandatory() const { return mandatory_; }
/*! \brief Sets the message to display when a mandatory field is left blank
*
* The default value is "This field cannot be empty".
*/
void setInvalidBlankText(const WString& text);
/*! \brief Returns the message displayed when a mandatory field is left blank
*
* \sa setInvalidBlankText(const WString&)
*/
WString invalidBlankText() const;
/*! \brief This function attempts to change input to be valid according to
* the validator's rules.
*
* In general the function needs not to change the input into a
* valid input. The default implementation does nothing. But it may
* help the user in getting its input right.
*/
virtual void fixup(WString& input) const;
/*! \brief Validates the given input.
*
* This function returns the current validation state of the
* input. The default implementation only checks whether a mandatory
* field is not left blank.
*/
virtual State validate(WT_USTRING& input) const;
/*! \brief Provides Ext-compatible config options for client-side validation.
*/
virtual void createExtConfig(std::ostream& config) const;
/*! \brief Creates a Javascript object that validates the input.
*
* The JavaScript expression should evaluate to an object which contains
* a <tt>validate(text)</tt> function, which returns an object that contains
* the following two fields:
* - fields: a boolean <i>valid</i>,
* - a \p message that indicates the problem if not valid.
*
* Return an empty string if you are not provide the client-side
* validation.
*
* \note The signature and contract changed changed in %Wt 3.1.9.
*
* \sa inputFilter()
*/
virtual std::string javaScriptValidate() const;
/*! \brief Returns a regular expression that filters input.
*
* The returned regular expression is used to filter keys
* presses. The regular expression should accept valid single
* characters.
*
* For details on valid regular expressions, see WRegExpValidator.
* As an example, "[0-9]" would only accept numbers as valid input.
*
* The default implementation returns an empty string, which does not
* filter any input.
*
* \sa javaScriptValidate()
*/
virtual std::string inputFilter() const;
protected:
void repaint();
private:
bool mandatory_;
WString mandatoryText_;
std::vector<WFormWidget *> formWidgets_;
void addFormWidget(WFormWidget *w);
void removeFormWidget(WFormWidget *w);
friend class WFormWidget;
};
}
#endif // WVALIDATOR_H_
|