src/libs/utils/basevalidatinglineedit.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef BASEVALIDATINGLINEEDIT_H
  35 #define BASEVALIDATINGLINEEDIT_H
  36
  37 #include "utils_global.h"
  38
  39 #include <QtGui/QLineEdit>
  40
  41 namespace Utils {
  42
  43 struct BaseValidatingLineEditPrivate;
  44
  45 /**
  46  * Base class for validating line edits that performs validation in a virtual
  47  * validate() function to be implemented in derived classes.
  48  * When invalid, the text color will turn red and a tooltip will
  49  * contain the error message. This approach is less intrusive than a
  50  * QValidator which will prevent the user from entering certain characters.
  51  *
  52  * The widget has a concept of an "initialText" which can be something like
  53  * "<Enter name here>". This results in state 'DisplayingInitialText', which
  54  * is not valid, but is not marked red.
  55  */
  56 class QTCREATOR_UTILS_EXPORT BaseValidatingLineEdit : public QLineEdit
  57 {
  58     Q_OBJECT
  59     Q_DISABLE_COPY(BaseValidatingLineEdit)
  60     Q_PROPERTY(QString initialText READ initialText WRITE setInitialText DESIGNABLE true)
  61     Q_PROPERTY(QColor errorColor READ errorColor WRITE setErrorColor DESIGNABLE true)
  62
  63 public:
  64     enum State { Invalid, DisplayingInitialText, Valid };
  65
  66     explicit BaseValidatingLineEdit(QWidget *parent = 0);
  67     virtual ~BaseValidatingLineEdit();
  68
  69
  70     State state() const;
  71     bool isValid() const;
  72     QString errorMessage() const;
  73
  74     QString initialText() const;
  75     void setInitialText(const QString &);
  76
  77     QColor errorColor() const;
  78     void setErrorColor(const  QColor &);
  79
  80     // Trigger an update (after changing settings)
  81     void triggerChanged();
  82
  83     static QColor textColor(const QWidget *w);
  84     static void setTextColor(QWidget *w, const QColor &c);
  85
  86 signals:
  87     void validChanged();
  88     void validChanged(bool validState);
  89     void validReturnPressed();
  90
  91 protected:
  92     virtual bool validate(const QString &value, QString *errorMessage) const = 0;
  93
  94 protected slots:
  95     // Custom behaviour can be added here. The base implementation must
  96     // be called.
  97     virtual void slotReturnPressed();
  98     virtual void slotChanged(const QString &t);
  99
 100 private:
 101     BaseValidatingLineEditPrivate *m_bd;
 102 };
 103
 104 } // namespace Utils
 105
 106 #endif // BASEVALIDATINGLINEEDIT_H