refactor QgsOptionsDialogHighlighWidget to use it as an interface

by removing the inheritance of QObject, an implementation of QWidget can now also inherit from QgsOptionsDialogHighlighWidget and provide the interface to search/highlight texts

python/gui/auto_generated/qgsoptionsdialoghighlightwidget.sip.in

@@ -9,7 +9,9 @@
 
 
 
-class QgsOptionsDialogHighlightWidget : QObject
+
+
+class QgsOptionsDialogHighlightWidget
 {
 %Docstring(signature="appended")
 Container for a widget to be used to search text in the option dialog
@@ -34,6 +36,8 @@ For instance a :py:class:`QgsOptionsDialogHighlightButton` for button.
          for the given widget.
 %End
 
+    virtual ~QgsOptionsDialogHighlightWidget();
+
     bool isValid();
 %Docstring
 Returns if it valid: if the widget type is handled and if the widget is not still available
@@ -51,11 +55,6 @@ search for a text pattern and highlight the widget if the text is found
 Returns the widget
 %End
 
-
-    virtual bool eventFilter( QObject *obj, QEvent *event );
-
-
-
   protected:
 
     virtual bool searchText( const QString &text ) = 0;

src/gui/qgsoptionsdialogbase.cpp

@@ -33,7 +33,6 @@
 #include <functional>
 
 #include "qgsfilterlineedit.h"
-#include "qgsmessagebaritem.h"
 #include "qgslogger.h"
 #include "qgsoptionsdialoghighlightwidget.h"
 #include "qgsoptionswidgetfactory.h"
@@ -652,31 +651,34 @@ void QgsOptionsDialogBase::registerTextSearchWidgets()
 
   for ( int i = 0; i < mOptStackedWidget->count(); i++ )
   {
-
     const QList< QWidget * > widgets = mOptStackedWidget->widget( i )->findChildren<QWidget *>();
-    for ( QWidget *w : widgets )
+    for ( QWidget *widget : widgets )
     {
-      // get custom highlight widget in user added pages
-      QHash<QWidget *, QgsOptionsDialogHighlightWidget *> customHighlightWidgets;
-      QgsOptionsPageWidget *opw = qobject_cast<QgsOptionsPageWidget *>( mOptStackedWidget->widget( i ) );
-      if ( opw )
-      {
-        customHighlightWidgets = opw->registeredHighlightWidgets();
-      }
-      QgsOptionsDialogHighlightWidget *shw = nullptr;
-      // take custom if exists
-      if ( customHighlightWidgets.contains( w ) )
+      // see if the widget also inherits QgsOptionsDialogHighlightWidget
+      QgsOptionsDialogHighlightWidget *shw = dynamic_cast<QgsOptionsDialogHighlightWidget *>( widget );
+      if ( !shw )
       {
-        shw = customHighlightWidgets.value( w );
+        // get custom highlight widget in user added pages
+        QHash<QWidget *, QgsOptionsDialogHighlightWidget *> customHighlightWidgets;
+        QgsOptionsPageWidget *opw = qobject_cast<QgsOptionsPageWidget *>( mOptStackedWidget->widget( i ) );
+        if ( opw )
+        {
+          customHighlightWidgets = opw->registeredHighlightWidgets();
+        }
+        // take custom if exists
+        if ( customHighlightWidgets.contains( widget ) )
+        {
+          shw = customHighlightWidgets.value( widget );
+        }
       }
       // try to construct one otherwise
       if ( !shw || !shw->isValid() )
       {
-        shw = QgsOptionsDialogHighlightWidget::createWidget( w );
+        shw = QgsOptionsDialogHighlightWidget::createWidget( widget );
       }
       if ( shw && shw->isValid() )
       {
-        QgsDebugMsgLevel( QStringLiteral( "Registering: %1" ).arg( w->objectName() ), 4 );
+        QgsDebugMsgLevel( QStringLiteral( "Registering: %1" ).arg( widget->objectName() ), 4 );
         mRegisteredSearchWidgets.append( qMakePair( shw, i ) );
       }
       else

src/gui/qgsoptionsdialoghighlightwidget.cpp

@@ -33,8 +33,7 @@
 
 
 QgsOptionsDialogHighlightWidget::QgsOptionsDialogHighlightWidget( QWidget *widget )
-  : QObject( widget )
-  , mWidget( widget )
+  : mWidget( widget )
 {}
 
 QgsOptionsDialogHighlightWidget *QgsOptionsDialogHighlightWidget::createWidget( QWidget *widget )
@@ -52,6 +51,11 @@ QgsOptionsDialogHighlightWidget *QgsOptionsDialogHighlightWidget::createWidget(
     }
   }
 
+  if ( dynamic_cast<QgsOptionsDialogHighlightWidget *>( widget ) )
+  {
+    return dynamic_cast<QgsOptionsDialogHighlightWidget *>( widget );
+  }
+
   if ( qobject_cast<QLabel *>( widget ) )
   {
     return new QgsOptionsDialogHighlightLabel( qobject_cast<QLabel *>( widget ) );
@@ -97,46 +101,55 @@ bool QgsOptionsDialogHighlightWidget::searchHighlight( const QString &text )
     mChangedStyle = false;
   }
 
-  if ( mInstalledFilter )
+  if ( mEventFilter )
   {
-    mWidget->removeEventFilter( this );
-    mInstalledFilter = false;
+    mWidget->removeEventFilter( mEventFilter );
+    delete mEventFilter;
+    mEventFilter = nullptr;
   }
 
   if ( !text.isEmpty() )
   {
-    found = searchText( text );
+    found = searchText( mSearchText );
   }
 
   if ( found )
   {
 
     if ( !mWidget->isVisible() )
     {
-      mWidget->installEventFilter( this );
-      mInstalledFilter = true;
+      mEventFilter = new QgsOptionsDialogHighlightWidgetEventFilter( this );
+      mWidget->installEventFilter( mEventFilter );
     }
     else
     {
-      mChangedStyle = highlightText( text );
+      mChangedStyle = highlightText( mSearchText );
     }
   }
 
   return found;
 }
 
-bool QgsOptionsDialogHighlightWidget::eventFilter( QObject *obj, QEvent *event )
+
+
+///@cond PRIVATE
+
+QgsOptionsDialogHighlightWidgetEventFilter::QgsOptionsDialogHighlightWidgetEventFilter( QgsOptionsDialogHighlightWidget *highlightWidget )
+  : QObject( highlightWidget->widget() )
+  , mHighlightWidget( highlightWidget )
+{}
+
+bool QgsOptionsDialogHighlightWidgetEventFilter::eventFilter( QObject *obj, QEvent *event )
 {
-  if ( mInstalledFilter && event->type() == QEvent::Show && obj == mWidget )
+  if ( event->type() == QEvent::Show && obj == mHighlightWidget->widget() )
   {
-    mWidget->removeEventFilter( this );
-    mInstalledFilter = false;
+    mHighlightWidget->widget()->removeEventFilter( this );
     // instead of catching the event and calling show again
     // it might be better to use a timer to change the style
     // after the widget is shown
 #if 1
-    mWidget->show();
-    mChangedStyle = highlightText( mSearchText );
+    mHighlightWidget->widget()->show();
+    mHighlightWidget->mChangedStyle = mHighlightWidget->highlightText( mHighlightWidget->mSearchText );
     return true;
 #else
     QTimer::singleShot( 500, this, [ = ]
@@ -148,5 +161,6 @@ bool QgsOptionsDialogHighlightWidget::eventFilter( QObject *obj, QEvent *event )
   return QObject::eventFilter( obj, event );
 }
 
+///@endcond
 
 

src/gui/qgsoptionsdialoghighlightwidget.h

@@ -23,6 +23,34 @@
 #include "qgis_gui.h"
 #include "qgis_sip.h"
 
+class QgsOptionsDialogHighlightWidget;
+
+#ifndef SIP_RUN
+
+///@cond PRIVATE
+
+/**
+ * \ingroup gui
+ * \class QgsOptionsDialogHighlightWidgetEventFilter
+ * \brief QgsOptionsDialogHighlightWidgetEventFilter is an event filter implementation for QgsOptionsDialogHighlightWidget
+ * \since QGIS 3.32
+ */
+class QgsOptionsDialogHighlightWidgetEventFilter : public QObject
+{
+    Q_OBJECT
+  public:
+    //! Constructor
+    QgsOptionsDialogHighlightWidgetEventFilter( QgsOptionsDialogHighlightWidget *highlightWidget );
+    bool eventFilter( QObject *obj, QEvent *event ) override;
+  private:
+    QgsOptionsDialogHighlightWidget *mHighlightWidget;
+
+};
+
+///@endcond
+
+#endif
+
 /**
  * \ingroup gui
  * \class QgsOptionsDialogHighlightWidget
@@ -32,10 +60,8 @@
  * This uses stylesheets.
  * \since QGIS 3.0
  */
-class GUI_EXPORT QgsOptionsDialogHighlightWidget : public QObject
+class GUI_EXPORT QgsOptionsDialogHighlightWidget
 {
-
-    Q_OBJECT
   public:
 
     /**
@@ -46,6 +72,8 @@ class GUI_EXPORT QgsOptionsDialogHighlightWidget : public QObject
      */
     static QgsOptionsDialogHighlightWidget *createWidget( QWidget *widget ) SIP_FACTORY;
 
+    virtual ~QgsOptionsDialogHighlightWidget() = default;
+
     /**
      * Returns if it valid: if the widget type is handled and if the widget is not still available
      */
@@ -62,10 +90,6 @@ class GUI_EXPORT QgsOptionsDialogHighlightWidget : public QObject
      */
     QWidget *widget() {return mWidget;}
 
-
-    bool eventFilter( QObject *obj, QEvent *event ) override;
-
-
   protected:
 
     /**
@@ -94,9 +118,11 @@ class GUI_EXPORT QgsOptionsDialogHighlightWidget : public QObject
     QPointer< QWidget > mWidget;
 
   private:
+    friend class QgsOptionsDialogHighlightWidgetEventFilter;
+
     QString mSearchText = QString();
     bool mChangedStyle = false;
-    bool mInstalledFilter = false;
+    QgsOptionsDialogHighlightWidgetEventFilter *mEventFilter = nullptr;
 };
 
 #endif // QGSOPTIONSDIALOGHIGHLIGHTWIDGET_H

src/gui/qgsoptionsdialoghighlightwidgetsimpl.cpp

@@ -26,8 +26,6 @@
 #include <QTextDocumentFragment>
 
 #include "qgsoptionsdialoghighlightwidget.h"
-#include "qgsmessagebaritem.h"
-#include "qgslogger.h"
 
 #include "qgsoptionsdialoghighlightwidgetsimpl.h"
 

src/gui/qgsoptionsdialoghighlightwidgetsimpl.h

@@ -43,7 +43,6 @@ class QTableView;
  */
 class GUI_EXPORT QgsOptionsDialogHighlightLabel : public QgsOptionsDialogHighlightWidget
 {
-    Q_OBJECT
   public:
     //! constructs a highlight widget for a label
     QgsOptionsDialogHighlightLabel( QLabel *label );
@@ -64,7 +63,6 @@ class GUI_EXPORT QgsOptionsDialogHighlightLabel : public QgsOptionsDialogHighlig
  */
 class GUI_EXPORT QgsOptionsDialogHighlightCheckBox : public QgsOptionsDialogHighlightWidget
 {
-    Q_OBJECT
   public:
     //! constructs a highlight widget for a checkbox
     QgsOptionsDialogHighlightCheckBox( QCheckBox *checkBox );
@@ -85,7 +83,6 @@ class GUI_EXPORT QgsOptionsDialogHighlightCheckBox : public QgsOptionsDialogHigh
  */
 class GUI_EXPORT QgsOptionsDialogHighlightButton : public QgsOptionsDialogHighlightWidget
 {
-    Q_OBJECT
   public:
     //! constructs a highlight widget for a button.
     QgsOptionsDialogHighlightButton( QAbstractButton *button );
@@ -106,7 +103,6 @@ class GUI_EXPORT QgsOptionsDialogHighlightButton : public QgsOptionsDialogHighli
  */
 class GUI_EXPORT QgsOptionsDialogHighlightGroupBox : public QgsOptionsDialogHighlightWidget
 {
-    Q_OBJECT
   public:
     //! constructs a highlight widget for a group box.
     QgsOptionsDialogHighlightGroupBox( QGroupBox *groupBox );
@@ -129,7 +125,6 @@ class GUI_EXPORT QgsOptionsDialogHighlightGroupBox : public QgsOptionsDialogHigh
  */
 class GUI_EXPORT QgsOptionsDialogHighlightTree : public QgsOptionsDialogHighlightWidget
 {
-    Q_OBJECT
   public:
     //! constructs a highlight widget for a tree view or widget.
     QgsOptionsDialogHighlightTree( QTreeView *treeView );
@@ -152,7 +147,6 @@ class GUI_EXPORT QgsOptionsDialogHighlightTree : public QgsOptionsDialogHighligh
  */
 class GUI_EXPORT QgsOptionsDialogHighlightTable : public QgsOptionsDialogHighlightWidget
 {
-    Q_OBJECT
   public:
     //! constructs a highlight widget for a table view or widget.
     QgsOptionsDialogHighlightTable( QTableView *tableView );