qgsoptionsdialoghighlightwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsoptionsdialoghighlightwidget.h
     -------------------------------
    Date                 : February 2018
    Copyright            : (C) 2018 Denis Rouzaud
    Email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSOPTIONSDIALOGHIGHLIGHTWIDGET_H
#define QGSOPTIONSDIALOGHIGHLIGHTWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QObject>
#include <QPointer>
#include <QWidget>
 
class QgsOptionsDialogHighlightWidget;
 
#ifndef SIP_RUN


class QgsOptionsDialogHighlightWidgetEventFilter : public QObject
{
    Q_OBJECT
  public:
    QgsOptionsDialogHighlightWidgetEventFilter( QgsOptionsDialogHighlightWidget *highlightWidget );
    bool eventFilter( QObject *obj, QEvent *event ) override;
 
  private:
    QgsOptionsDialogHighlightWidget *mHighlightWidget;
};

 
#endif

class GUI_EXPORT QgsOptionsDialogHighlightWidget
{
  public:

    static QgsOptionsDialogHighlightWidget *createWidget( QWidget *widget ) SIP_FACTORY;
 
    virtual ~QgsOptionsDialogHighlightWidget() = default;

    bool isValid() { return !mWidget.isNull(); }

    bool searchHighlight( const QString &text );

    QWidget *widget() { return mWidget; }
 
  protected:

    virtual bool searchText( const QString &text ) = 0;

    virtual bool highlightText( const QString &text ) = 0;

    virtual void reset() = 0;

    explicit QgsOptionsDialogHighlightWidget( QWidget *widget = nullptr );

    QPointer<QWidget> mWidget;
 
  private:
    friend class QgsOptionsDialogHighlightWidgetEventFilter;
 
    QString mSearchText = QString();
    bool mChangedStyle = false;
    QgsOptionsDialogHighlightWidgetEventFilter *mEventFilter = nullptr;
};
 
#endif // QGSOPTIONSDIALOGHIGHLIGHTWIDGET_H