4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
10 * Full author contact details are available in file CREDITS.
12 * Validators are used to decide upon the legality of some input action.
13 * For example, a "line edit" widget might be used to input a "glue length".
14 * The correct syntax for such a length is "2em + 0.5em". The LengthValidator
15 * below will report whether the input text conforms to this syntax.
17 * This information is used in LyX primarily to give the user some
18 * feedback on the validity of the input data using the "checked_widget"
19 * concept. For example, if the data is invalid then the label of
20 * a "line edit" widget is changed in colour and the dialog's "Ok"
21 * and "Apply" buttons are disabled. See checked_widgets.[Ch] for
29 #include "Dialog.h" // KernelDocType
43 /** A class to ascertain whether the data passed to the @c validate()
44 * member function can be interpretted as a GlueLength.
46 class LengthValidator : public QValidator
50 /// Define a validator for widget @c parent.
51 LengthValidator(QWidget * parent);
53 /** @returns QValidator::Acceptable if @c data is a GlueLength.
54 * If not, returns QValidator::Intermediate.
56 QValidator::State validate(QString & data, int &) const;
59 * Set and retrieve the minimum allowed Length value.
62 void setBottom(Length const &);
63 void setBottom(GlueLength const &);
64 Length bottom() const { return b_; }
75 /// @returns a new @c LengthValidator that does not accept negative lengths.
76 LengthValidator * unsignedLengthValidator(QLineEdit *);
78 //FIXME This should be generalized to take "text" as part of the
79 //constructor and so to set what text we check for, rather than
80 //hard-coding it as "auto". But see qt_helpers.h for reasons this
81 //is not so trivial and an idea about how to do it. (RGH)
82 /** A class to ascertain whether the data passed to the @c validate()
83 * member function can be interpretted as a GlueLength or is "auto".
85 class LengthAutoValidator : public LengthValidator
89 /// Define a validator for widget @c parent.
90 LengthAutoValidator(QWidget * parent);
92 /** @returns QValidator::Acceptable if @c data is a GlueLength
93 * or is "auto". If not, returns QValidator::Intermediate.
95 QValidator::State validate(QString & data, int &) const;
98 /// @returns a new @c LengthAutoValidator that does not accept negative lengths.
99 LengthAutoValidator * unsignedLengthAutoValidator(QLineEdit *);
102 //FIXME As above, this should really take a text argument.
104 * A class to determine whether the passed is a double
108 class DoubleAutoValidator : public QDoubleValidator
112 DoubleAutoValidator(QWidget * parent);
113 DoubleAutoValidator(double bottom, double top, int decimals,
115 QValidator::State validate(QString & input, int & pos) const;
119 /** A class to ascertain whether the data passed to the @c validate()
120 * member function is a valid file path.
121 * The test is active only when the path is to be stored in a LaTeX
122 * file, LaTeX being quite picky about legal names.
124 class PathValidator : public QValidator
128 /** Define a validator for widget @c parent.
129 * If @c acceptable_if_empty is @c true then an empty path
130 * is regarded as acceptable.
132 PathValidator(bool acceptable_if_empty, QWidget * parent);
134 /** @returns QValidator::Acceptable if @c data is a valid path.
135 * If not, returns QValidator::Intermediate.
137 QValidator::State validate(QString &, int &) const;
139 /** Define what checks that @c validate() will perform.
140 * @param doc_type checks are activated only for @c LATEX docs.
141 * @param lyxrc contains a @c tex_allows_spaces member that
142 * is used to define what is legal.
144 void setChecker(KernelDocType const & doc_type, LyXRC const & lyxrc);
147 bool acceptable_if_empty_;
149 bool tex_allows_spaces_;
153 /// @returns the PathValidator attached to the widget, or 0.
154 PathValidator * getPathValidator(QLineEdit *);
156 } // namespace frontend
159 # endif // NOT VALIDATOR_H