Add overview widget (#159)

* Add overview widget

* Use pixmap

* Add changelog entry

* Rename to simply "Overview"

* Disable when no signal is open

Author: cbrnr

CHANGELOG.md

@@ -2,6 +2,7 @@
 ### ✨ Added
 - Add DMG background and Applications shortcut for macOS installer
 - Add new toolbar icons for zooming in/out all channels' amplitudes ([#158](https://github.com/cbrnr/sigviewer/pull/158) by [Clemens Brunner](https://github.com/cbrnr))
+- Add overview widget at the bottom of the window ([#159](https://github.com/cbrnr/sigviewer/pull/159) by [Clemens Brunner](https://github.com/cbrnr))
 
 ### 🔧 Fixed
 - Show error message when loading EDF files containing only annotations instead of hanging in the loading dialog

CMakeLists.txt

@@ -263,6 +263,8 @@ qt_add_library(sigviewer_objects OBJECT
     src/gui/signal_browser/event_graphics_item.h
     src/gui/signal_browser/label_widget.cpp
     src/gui/signal_browser/label_widget.h
+    src/gui/signal_browser/overview_widget.cpp
+    src/gui/signal_browser/overview_widget.h
     src/gui/signal_browser/signal_browser_graphics_view.h
     src/gui/signal_browser/signal_browser_model_4.cpp
     src/gui/signal_browser/signal_browser_model_4.h

src/gui/main_window.cpp

@@ -151,6 +151,20 @@ void MainWindow::toggleStatusBar (bool visible)
 }
 
 
+//-------------------------------------------------------------------
+void MainWindow::setOverviewActionEnabled (bool enabled)
+{
+    overview_action_->setEnabled (enabled);
+}
+
+//-----------------------------------------------------------------------------
+void MainWindow::toggleOverview (bool visible)
+{
+    QSettings settings;
+    settings.setValue ("MainWindow/overview", visible);
+    emit overviewVisibilityChanged (visible);
+}
+
 //-----------------------------------------------------------------------------
 void MainWindow::addBackgroundProcessToStatusBar (QString name, int max)
 {
@@ -239,9 +253,16 @@ void MainWindow::initMenus (QSharedPointer<ApplicationContext> application_conte
     toggle_status_bar->setChecked (settings.value ("MainWindow/statusbar", true).toBool());
     connect (toggle_status_bar, SIGNAL(toggled(bool)), this, SLOT(toggleStatusBar(bool)));
 
+    overview_action_ = new QAction (tr("Overview"), this);
+    overview_action_->setCheckable (true);
+    overview_action_->setChecked (settings.value ("MainWindow/overview", true).toBool());
+    overview_action_->setEnabled (false);
+    connect (overview_action_, SIGNAL(toggled(bool)), this, SLOT(toggleOverview(bool)));
+
     view_menu_ = menuBar()->addMenu(tr("&View"));
     view_menu_->addAction(file_toolbar_->toggleViewAction());
     view_menu_->addAction(toggle_status_bar);
+    view_menu_->addAction(overview_action_);
 #ifndef Q_OS_MACOS
     toggle_menubar_ = new QAction(tr("Menubar"), this);
     toggle_menubar_->setCheckable(true);

src/gui/main_window.h

@@ -31,12 +31,14 @@ class MainWindow : public QMainWindow
 
     void setStatusBarSignalLength(float64 length);
     void setStatusBarNrChannels(int32 nr_channels);
+    void setOverviewActionEnabled(bool enabled);
 
     void setRecentFiles(const QStringList& recent_file_list);
 
 signals:
     void recentFileActivated(QAction* recent_file_action);
     void recentFileMenuAboutToShow();
+    void overviewVisibilityChanged(bool visible);
 
 
 protected:
@@ -48,6 +50,7 @@ class MainWindow : public QMainWindow
 private slots:
     void toggleStatusBar (bool visible);
     void toggleMenuBar ();
+    void toggleOverview (bool visible);
     void addBackgroundProcessToStatusBar (QString name, int max);
     void updateBackgroundProcessonStatusBar (QString name, int value);
     void removeBackgroundProcessFromStatusBar (QString name);
@@ -77,6 +80,7 @@ private slots:
     QLabel* status_bar_signal_length_label_;
     QLabel* status_bar_nr_channels_label_;
 
+    QAction* overview_action_;
     QAction* toggle_menubar_;
     QAction* hamburger_spacer_action_;
     QAction* hamburger_action_;

src/gui/main_window_model.cpp

@@ -25,10 +25,12 @@ int const MainWindowModel::NUMBER_RECENT_FILES_ = 8;
 MainWindowModel::MainWindowModel (QSharedPointer<ApplicationContext> application_context)
 : application_context_ (application_context),
   main_window_ (new MainWindow (application_context)),
-  tab_widget_ (0)
+  tab_widget_ (0),
+  current_signal_browser_view_ (nullptr)
 {
     connect (main_window_, SIGNAL(recentFileActivated(QAction*)), SLOT(recentFileActivated(QAction*)));
     connect (main_window_, SIGNAL(recentFileMenuAboutToShow()), SLOT(recentFileMenuAboutToShow()));
+    connect (main_window_, SIGNAL(overviewVisibilityChanged(bool)), SLOT(setOverviewVisible(bool)));
     main_window_->show();
     loadSettings();
 }
@@ -197,14 +199,23 @@ void MainWindowModel::closeCurrentFileTabs ()
     //   to be refactored as soon as multi file support is implemented
     main_window_->setCentralWidget (0);
     tab_widget_ = 0;
+    current_signal_browser_view_ = nullptr;
     tab_contexts_.clear ();
     // --end
 
     main_window_->setStatusBarSignalLength(-1);
     main_window_->setStatusBarNrChannels(-1);
+    main_window_->setOverviewActionEnabled (false);
     resetCurrentFileName ("");
 }
 
+//-----------------------------------------------------------------------------
+void MainWindowModel::setOverviewVisible (bool visible)
+{
+    if (current_signal_browser_view_)
+        current_signal_browser_view_->setOverviewVisible (visible);
+}
+
 //-----------------------------------------------------------------------------
 QSharedPointer<SignalVisualisationModel> MainWindowModel::getCurrentSignalVisualisationModel ()
 {
@@ -250,6 +261,14 @@ int MainWindowModel::createSignalVisualisationImpl (ChannelManager const& channe
 
     int tab_index = tab_widget_->addTab (view, tr("Signal"));
 
+    // Store the view and apply the persisted overview visibility.
+    current_signal_browser_view_ = view;
+    {
+        QSettings settings;
+        view->setOverviewVisible (settings.value ("MainWindow/overview", true).toBool());
+    }
+    main_window_->setOverviewActionEnabled (true);
+
     model->setSignalBrowserView (view);
     browser_models_[tab_index] = model;
     event_views_[tab_index] = model;

src/gui/main_window_model.h

@@ -26,6 +26,7 @@ namespace sigviewer
 
 class ApplicationContext;
 class MainWindow;
+class SignalBrowserView;
 
 class MainWindowModel : public QObject
 {
@@ -51,6 +52,9 @@ public slots:
 
     void closeTab (int tab_index);
 
+    /// Propagate overview visibility to the currently open signal browser view.
+    void setOverviewVisible (bool visible);
+
 private slots:
     void recentFileActivated(QAction* recent_file_action);
 
@@ -73,6 +77,7 @@ private slots:
     QSharedPointer<ApplicationContext> application_context_;
     MainWindow* main_window_;
     QTabWidget* tab_widget_;
+    SignalBrowserView* current_signal_browser_view_;
     QStringList recent_file_list_;
     std::map<int, QSharedPointer<SignalVisualisationModel> > browser_models_;
     QMap<int, QSharedPointer<EventView> > event_views_;