qgsfilterlineedit.h

Go to the documentation of this file.

/***************************************************************************
                              qgsfilterlineedit.h
                              ------------------------
  begin                : October 27, 2012
  copyright            : (C) 2012 by Alexander Bruy
  email                : alexander dot bruy at gmail dot com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSFILTERLINEEDIT_H
#define QGSFILTERLINEEDIT_H

#include <QLineEdit>

class QToolButton;

class GUI_EXPORT QgsFilterLineEdit : public QLineEdit
{
    Q_OBJECT
    Q_ENUMS( ClearMode )
    Q_PROPERTY( ClearMode clearMode READ clearMode WRITE setClearMode )
    Q_PROPERTY( QString nullValue READ nullValue WRITE setNullValue )
    Q_PROPERTY( QString defaultValue READ defaultValue WRITE setDefaultValue )
    Q_PROPERTY( QString value READ value WRITE setValue NOTIFY valueChanged )
    Q_PROPERTY( bool showClearButton READ showClearButton WRITE setShowClearButton )

  public:

    enum ClearMode
    {
      ClearToNull = 0, 
      ClearToDefault, 
    };

    QgsFilterLineEdit( QWidget* parent = nullptr, const QString& nullValue = QString::null );

    bool showClearButton() const { return mClearButtonVisible; }

    void setShowClearButton( bool visible );

    ClearMode clearMode() const { return mClearMode; }

    void setClearMode( ClearMode mode ) { mClearMode = mode; }

    void setNullValue( const QString& nullValue ) { mNullValue = nullValue; }

    QString nullValue() const { return mNullValue; }

    void setDefaultValue( const QString& defaultValue ) { mDefaultValue = defaultValue; }

    QString defaultValue() const { return mDefaultValue; }

    void setValue( const QString& value ) { setText( value.isNull() ? mNullValue : value ); }

    QString value() const { return isNull() ? QString::null : text(); }

    inline bool isNull() const { return text() == mNullValue; }

  public slots:

    virtual void clearValue();

  signals:

    void cleared();

    void valueChanged( const QString& value );

  protected:
    void mousePressEvent( QMouseEvent* e ) override;
    void mouseMoveEvent( QMouseEvent* e ) override;
    void focusInEvent( QFocusEvent* e ) override;
    void paintEvent( QPaintEvent* e ) override;
    void leaveEvent( QEvent* e ) override;

  private slots:
    void onTextChanged( const QString &text );

  private:

    bool mClearButtonVisible;

    ClearMode mClearMode;

    QString mNullValue;
    QString mDefaultValue;
    QString mStyleSheet;
    bool mFocusInEvent;
    bool mClearHover;

    QSize mClearIconSize;
    QPixmap mClearIconPixmap;
    QPixmap mClearHoverPixmap;

    bool shouldShowClear() const;

    QRect clearRect() const;
};


class QgsSpinBoxLineEdit : public QgsFilterLineEdit
{
    Q_OBJECT

  public:

    QgsSpinBoxLineEdit( QWidget* parent = nullptr )
        : QgsFilterLineEdit( parent )
    {}

  public slots:

    virtual void clearValue() override
    {
      // don't change the value - let spin boxes handle that by detecting cleared() signal
      setCursor( Qt::IBeamCursor );
      setModified( true );
      emit cleared();
    }
};

#endif // QGSFILTERLINEEDIT_H