4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
8 * \author Richard Kimberly Heck
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
28 #include "support/Length.h"
41 enum class KernelDocType : int;
43 /** A class to ascertain whether the data passed to the @c validate()
44 * member function can be interpreted 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 override;
59 * Set and retrieve the minimum allowed Length value.
62 void setBottom(Length const &);
63 void setBottom(GlueLength const &);
64 Length bottom() const { return bottom_; }
65 void setUnsigned(bool const u) { unsigned_ = u; }
66 void setPositive(bool const u) { positive_ = u; }
71 GlueLength glue_bottom_;
72 bool no_bottom_ = true;
73 bool glue_length_ = false;
74 bool unsigned_ = false;
75 bool positive_ = false;
79 /// @returns a new @c LengthValidator that does not accept negative lengths.
80 LengthValidator * unsignedLengthValidator(QLineEdit *);
83 /** @returns a new @c LengthValidator that does not accept negative lengths.
86 LengthValidator * unsignedGlueLengthValidator(QLineEdit *);
89 /** A class to ascertain whether the data passed to the @c validate()
90 * member function can be interpreted as a GlueLength or is @param autotext.
92 class LengthAutoValidator : public LengthValidator
96 /// Define a validator for widget @c parent.
97 LengthAutoValidator(QWidget * parent, QString const & autotext);
99 /** @returns QValidator::Acceptable if @c data is a GlueLength
100 * or is "auto". If not, returns QValidator::Intermediate.
102 QValidator::State validate(QString & data, int &) const override;
108 /// @returns a new @c LengthAutoValidator that does not accept negative lengths.
109 LengthAutoValidator * unsignedLengthAutoValidator(QLineEdit *, QString const & autotext);
112 /// @returns a new @c LengthAutoValidator that does not accept negative lengths.
113 LengthAutoValidator * positiveLengthAutoValidator(QLineEdit *, QString const & autotext);
117 * A class to determine whether the passed is a double
118 * or is @param autotext.
121 class DoubleAutoValidator : public QDoubleValidator
125 DoubleAutoValidator(QWidget * parent, QString const & autotext);
126 DoubleAutoValidator(double bottom, double top, int decimals,
128 QValidator::State validate(QString & input, int & pos) const override;
135 // A class to ascertain that no newline characters are passed.
136 class NoNewLineValidator : public QValidator
140 // Define a validator.
141 NoNewLineValidator(QWidget *);
142 // Remove newline characters from input.
143 QValidator::State validate(QString &, int &) const override;
147 /** A class to ascertain whether the data passed to the @c validate()
148 * member function is a valid file path.
149 * The test is active only when the path is to be stored in a LaTeX
150 * file, LaTeX being quite picky about legal names.
152 class PathValidator : public QValidator
156 /** Define a validator for widget @c parent.
157 * If @c acceptable_if_empty is @c true then an empty path
158 * is regarded as acceptable.
160 PathValidator(bool acceptable_if_empty, QWidget * parent);
162 /** @returns QValidator::Acceptable if @c data is a valid path.
163 * If not, returns QValidator::Intermediate.
165 QValidator::State validate(QString &, int &) const override;
167 /** Define what checks that @c validate() will perform.
168 * @param doc_type checks are activated only for @c LATEX docs.
169 * @param lyxrc contains a @c tex_allows_spaces member that
170 * is used to define what is legal.
172 void setChecker(KernelDocType const & doc_type, LyXRC const & lyxrc);
175 bool acceptable_if_empty_;
177 bool tex_allows_spaces_;
181 /// @returns the PathValidator attached to the widget, or 0.
182 PathValidator * getPathValidator(QLineEdit *);
184 } // namespace frontend
187 # endif // NOT VALIDATOR_H