#3498 updatedialog: allow to search changelog

Signed-off-by: Patrizio Bekerle <patrizio@bekerle.com>

Author: pbek

CHANGELOG.md

@@ -1,5 +1,11 @@
 # QOwnNotes Changelog
 
+## 26.3.12
+
+- Added a search panel to the update dialog changelog so release note changes can
+  be searched directly with the standard find workflow (for
+  [#3498](https://github.com/pbek/QOwnNotes/issues/3498))
+
 ## 26.3.11
 
 - Changed Markdown formatting syntax hiding so named links keep their URL part

src/dialogs/updatedialog.cpp

@@ -4,10 +4,13 @@
 #include <services/metricsservice.h>
 #include <utils/gui.h>
 #include <utils/misc.h>
+#include <widgets/qtexteditsearchwidget.h>
 
 #include <QDebug>
 #include <QDesktopServices>
 #include <QDir>
+#include <QKeyEvent>
+#include <QLayout>
 #include <QMessageBox>
 #include <QNetworkReply>
 #include <QNetworkRequest>
@@ -21,7 +24,11 @@
 
 UpdateDialog::UpdateDialog(QWidget *parent, const QString &changesHtml, const QString &releaseUrl,
                            const QString &releaseVersionString)
-    : MasterDialog(parent), ui(new Ui::UpdateDialog) {
+    : MasterDialog(parent),
+      ui(new Ui::UpdateDialog),
+      _networkManager(nullptr),
+      _updateButton(nullptr),
+      _changeLogSearchWidget(nullptr) {
     ui->setupUi(this);
     afterSetupUI();
     ui->downloadProgressBar->hide();
@@ -38,6 +45,20 @@ UpdateDialog::UpdateDialog(QWidget *parent, const QString &changesHtml, const QS
     //    ui->label_4->setText("<style>" + Utils::Misc::genericCSS() +
     //                                 "</style>" + ui->label_4->text());
 
+    _changeLogSearchWidget = new QTextEditSearchWidget(ui->changeLogEdit);
+    _changeLogSearchWidget->setReplaceEnabled(false);
+    _changeLogSearchWidget->setDarkMode(
+        SettingsService().value(QStringLiteral("darkMode")).toBool());
+
+    auto *searchLayout = new QVBoxLayout(ui->searchFrame);
+    searchLayout->setSpacing(0);
+    searchLayout->setContentsMargins(0, 0, 0, 0);
+    searchLayout->addWidget(_changeLogSearchWidget);
+    ui->searchFrame->setLayout(searchLayout);
+
+    ui->changeLogEdit->installEventFilter(this);
+    ui->changeLogEdit->viewport()->installEventFilter(this);
+
     ui->changeLogEdit->setHtml(changesHtml);
     ui->versionLabel->setText("Version " + releaseVersionString);
     this->releaseVersionString = releaseVersionString;
@@ -121,6 +142,30 @@ void UpdateDialog::show() {
     MasterDialog::show();
 }
 
+bool UpdateDialog::eventFilter(QObject *obj, QEvent *event) {
+    if (((obj == ui->changeLogEdit) || (obj == ui->changeLogEdit->viewport())) &&
+        (event->type() == QEvent::KeyPress)) {
+        auto *keyEvent = static_cast<QKeyEvent *>(event);
+
+        if ((keyEvent->key() == Qt::Key_Escape) && _changeLogSearchWidget->isVisible()) {
+            _changeLogSearchWidget->deactivate();
+            return true;
+        }
+
+        if ((keyEvent->key() == Qt::Key_F) && keyEvent->modifiers().testFlag(Qt::ControlModifier)) {
+            _changeLogSearchWidget->activate();
+            return true;
+        }
+
+        if (keyEvent->key() == Qt::Key_F3) {
+            _changeLogSearchWidget->doSearch(!keyEvent->modifiers().testFlag(Qt::ShiftModifier));
+            return true;
+        }
+    }
+
+    return MasterDialog::eventFilter(obj, event);
+}
+
 void UpdateDialog::dialogButtonClicked(QAbstractButton *button) {
     int actionRole = button->property("ActionRole").toInt();
 

src/dialogs/updatedialog.h

@@ -8,8 +8,10 @@ class UpdateDialog;
 }
 
 class QAbstractButton;
+class QPushButton;
 class QNetworkReply;
 class QNetworkAccessManager;
+class QTextEditSearchWidget;
 
 class UpdateDialog : public MasterDialog {
     Q_OBJECT
@@ -37,6 +39,7 @@ class UpdateDialog : public MasterDialog {
     QString releaseVersionString;
     QNetworkAccessManager *_networkManager;
     QPushButton *_updateButton;
+    QTextEditSearchWidget *_changeLogSearchWidget;
 
     enum ButtonRole {
         Unset,    // nothing was selected
@@ -48,6 +51,7 @@ class UpdateDialog : public MasterDialog {
     };
 
     void closeEvent(QCloseEvent *event) override;
+    bool eventFilter(QObject *obj, QEvent *event) override;
 
     bool initializeUpdateProcess(const QString &filePath);
 

src/dialogs/updatedialog.ui

@@ -40,8 +40,8 @@
        </property>
       </widget>
      </item>
-     <item>
-      <widget class="QTextBrowser" name="changeLogEdit">
+      <item>
+       <widget class="QTextBrowser" name="changeLogEdit">
        <property name="readOnly">
         <bool>true</bool>
        </property>
@@ -61,10 +61,17 @@ p, li { white-space: pre-wrap; }
        <property name="openLinks">
         <bool>true</bool>
        </property>
-      </widget>
-     </item>
-     <item>
-      <widget class="QLabel" name="label_2">
+       </widget>
+      </item>
+      <item>
+       <widget class="QFrame" name="searchFrame">
+        <property name="frameShape">
+         <enum>QFrame::NoFrame</enum>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QLabel" name="label_2">
        <property name="text">
         <string>Do you want to download the new version?</string>
        </property>

src/widgets/qtexteditsearchwidget.cpp

@@ -21,9 +21,8 @@
 #include "ui_qtexteditsearchwidget.h"
 
 QTextEditSearchWidget::QTextEditSearchWidget(QTextEdit *parent)
-    : QWidget(parent), ui(new Ui::QTextEditSearchWidget) {
+    : QWidget(parent), ui(new Ui::QTextEditSearchWidget), _textEdit(parent), _darkMode(false) {
     ui->setupUi(this);
-    _textEdit = parent;
     hide();
 
     QObject::connect(ui->closeButton, SIGNAL(clicked()), this, SLOT(deactivate()));
@@ -231,15 +230,17 @@ bool QTextEditSearchWidget::doSearch(bool searchDown, bool allowRestartAtTop) {
         found = _textEdit->find(text, options);
     }
 
-    QRect rect = _textEdit->cursorRect();
-    QMargins margins = _textEdit->layout()->contentsMargins();
-    int searchWidgetHotArea = _textEdit->height() - this->height();
-    int marginBottom = (rect.y() > searchWidgetHotArea) ? (this->height() + 10) : 0;
+    if (_textEdit->layout() != nullptr) {
+        QRect rect = _textEdit->cursorRect();
+        QMargins margins = _textEdit->layout()->contentsMargins();
+        int searchWidgetHotArea = _textEdit->height() - this->height();
+        int marginBottom = (rect.y() > searchWidgetHotArea) ? (this->height() + 10) : 0;
 
-    // move the search box a bit up if we would block the search result
-    if (margins.bottom() != marginBottom) {
-        margins.setBottom(marginBottom);
-        _textEdit->layout()->setContentsMargins(margins);
+        // move the search box a bit up if we would block the search result
+        if (margins.bottom() != marginBottom) {
+            margins.setBottom(marginBottom);
+            _textEdit->layout()->setContentsMargins(margins);
+        }
     }
 
     // add a background color according if we found the text or not