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 "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QIcon>
#include <QLineEdit>
 
class QToolButton;
class QgsAnimatedIcon;

class GUI_EXPORT QgsFilterLineEdit : public QLineEdit
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsFilterLineEdit *>( sipCpp ) )
      sipType = sipType_QgsFilterLineEdit;
    else
      sipType = NULL;
    SIP_END
#endif
 
    Q_OBJECT
    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 )
    Q_PROPERTY( bool showSearchIcon READ showSearchIcon WRITE setShowSearchIcon )
    Q_PROPERTY( bool showSpinner READ showSpinner WRITE setShowSpinner NOTIFY showSpinnerChanged )
 
  public:
    enum ClearMode
    {
      ClearToNull = 0, 
      ClearToDefault,  
    };
    Q_ENUM( ClearMode )
 
    
    QgsFilterLineEdit( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QString &nullValue = QString() );

    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 setShowSearchIcon( bool visible );

    bool showSearchIcon() const { return static_cast<bool>( mSearchAction ); }

    void setDefaultValue( const QString &defaultValue );

    QString defaultValue() const { return mDefaultValue; }

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

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

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

    bool showSpinner() const;

    void setShowSpinner( bool showSpinner );

    bool selectOnFocus() const;

    void setSelectOnFocus( bool selectOnFocus );

    bool event( QEvent *event ) override;

    bool hasStateStored() const { return mLineEditState.hasStateStored; }
 
  public slots:

    virtual void clearValue();

    void storeState();

    void restoreState();
 
  signals:

    void cleared();

    void valueChanged( const QString &value );

    void showSpinnerChanged();
 

    void selectOnFocusChanged();
 
  protected:
    void focusInEvent( QFocusEvent *e ) override;
    void mouseReleaseEvent( QMouseEvent *e ) override;
 
  private slots:
    void onTextChanged( const QString &text );
    void updateBusySpinner();
    void updateClearIcon();
 
  private:
    struct LineEditState
    {
        bool hasStateStored = false;
        QString text;
        int selectionStart;
        int selectionLength;
        int cursorPosition;
    };
 
    QIcon mClearIcon;
    QAction *mClearAction = nullptr;
    QAction *mSearchAction = nullptr;
    QAction *mBusySpinnerAction = nullptr;
 
    bool mClearButtonVisible = true;
    bool mShowSpinner = false;
 
    ClearMode mClearMode = ClearToNull;
 
    QString mNullValue;
    QString mDefaultValue;
    QString mStyleSheet;
    bool mWaitingForMouseRelease = false;
    bool mSelectOnFocus = false;
 
    LineEditState mLineEditState;
 
    QgsAnimatedIcon *mBusySpinnerAnimatedIcon = nullptr;

    bool shouldShowClear() const;
 
    friend class TestQgsFeatureListComboBox;
};


class SIP_SKIP QgsSpinBoxLineEdit : public QgsFilterLineEdit
{
    Q_OBJECT
 
  public:
    QgsSpinBoxLineEdit( QWidget *parent = nullptr )
      : QgsFilterLineEdit( parent )
    {}
 
  public slots:
 
    void clearValue() override
    {
      // don't change the value - let spin boxes handle that by detecting cleared() signal
      setCursor( Qt::IBeamCursor );
      setModified( true );
      emit cleared();
    }
 
  protected:
    void focusInEvent( QFocusEvent *e ) override;
};
 
#endif // QGSFILTERLINEEDIT_H