]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/statusbar/dolphinstatusbar.cpp
KStandardItemList: have emblem when hovering
[dolphin.git] / src / statusbar / dolphinstatusbar.cpp
index 166f6ab14411efb0aec163609807b2b2723b5aca..4d76afcbe6530f66e9c646f6e974919c5524a862 100644 (file)
@@ -1,72 +1,66 @@
-/***************************************************************************
- *   Copyright (C) 2006-2012 by Peter Penz <peter.penz19@gmail.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.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2006-2012 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #include "dolphinstatusbar.h"
 
 #include "dolphin_generalsettings.h"
+#include "statusbarspaceinfo.h"
+#include "views/dolphinview.h"
+#include "views/zoomlevelinfo.h"
 
-#include <QIcon>
 #include <KLocalizedString>
-#include <QMenu>
-
-#include "statusbarspaceinfo.h"
+#include <KSqueezedTextLabel>
 
 #include <QApplication>
 #include <QHBoxLayout>
-#include <QLabel>
+#include <QHelpEvent>
+#include <QIcon>
+#include <QMenu>
+#include <QPainter>
+#include <QPainterPath>
 #include <QProgressBar>
-#include <QToolButton>
-#include <QTime>
-#include <QTimer>
 #include <QSlider>
-#include <QTextDocument>
-#include <QHelpEvent>
-
-#include <views/dolphinview.h>
-#include <views/zoomlevelinfo.h>
+#include <QStyleOption>
+#include <QTimer>
+#include <QToolButton>
 
-namespace {
-    const int ResetToDefaultTimeout = 1000;
+namespace
+{
+const int UpdateDelay = 50;
 }
 
-DolphinStatusBar::DolphinStatusBar(QWidget* parent) :
-    QWidget(parent),
-    m_text(),
-    m_defaultText(),
-    m_label(0),
-    m_spaceInfo(0),
-    m_zoomSlider(0),
-    m_progressBar(0),
-    m_stopButton(0),
-    m_progress(100),
-    m_showProgressBarTimer(0),
-    m_resetToDefaultTextTimer(0),
-    m_textTimestamp()
+DolphinStatusBar::DolphinStatusBar(QWidget *parent)
+    : AnimatedHeightWidget(parent)
+    , m_text()
+    , m_defaultText()
+    , m_label(nullptr)
+    , m_zoomLabel(nullptr)
+    , m_spaceInfo(nullptr)
+    , m_zoomSlider(nullptr)
+    , m_progressBar(nullptr)
+    , m_stopButton(nullptr)
+    , m_progress(100)
+    , m_showProgressBarTimer(nullptr)
+    , m_delayUpdateTimer(nullptr)
+    , m_textTimestamp()
 {
+    setProperty("_breeze_statusbar_separator", true);
+
+    QWidget *contentsContainer = prepareContentsContainer();
+
     // Initialize text label
-    m_label = new QLabel(this);
-    m_label->setWordWrap(true);
+    m_label = new KSqueezedTextLabel(m_text, contentsContainer);
     m_label->setTextFormat(Qt::PlainText);
-    m_label->installEventFilter(this);
+    m_label->setTextInteractionFlags(Qt::TextBrowserInteraction | Qt::TextSelectableByKeyboard); // for accessibility but also to allow copy-pasting this text.
+
+    // Initialize zoom slider's explanatory label
+    m_zoomLabel = new KSqueezedTextLabel(i18nc("Used as a noun, i.e. 'Here is the zoom level:'", "Zoom:"), contentsContainer);
 
     // Initialize zoom widget
-    m_zoomSlider = new QSlider(Qt::Horizontal, this);
+    m_zoomSlider = new QSlider(Qt::Horizontal, contentsContainer);
     m_zoomSlider->setAccessibleName(i18n("Zoom"));
     m_zoomSlider->setAccessibleDescription(i18nc("Description for zoom-slider (accessibility)", "Sets the size of the file icons."));
     m_zoomSlider->setPageStep(1);
@@ -77,21 +71,28 @@ DolphinStatusBar::DolphinStatusBar(QWidget* parent) :
     connect(m_zoomSlider, &QSlider::sliderMoved, this, &DolphinStatusBar::showZoomSliderToolTip);
 
     // Initialize space information
-    m_spaceInfo = new StatusBarSpaceInfo(this);
+    m_spaceInfo = new StatusBarSpaceInfo(contentsContainer);
+    connect(m_spaceInfo, &StatusBarSpaceInfo::showMessage, this, &DolphinStatusBar::showMessage);
+    connect(m_spaceInfo,
+            &StatusBarSpaceInfo::showInstallationProgress,
+            this,
+            [this](const QString &currentlyRunningTaskTitle, int installationProgressPercent) {
+                showProgress(currentlyRunningTaskTitle, installationProgressPercent, CancelLoading::Disallowed);
+            });
 
     // Initialize progress information
-    m_stopButton = new QToolButton(this);
-    m_stopButton->setIcon(QIcon::fromTheme("process-stop"));
+    m_stopButton = new QToolButton(contentsContainer);
+    m_stopButton->setIcon(QIcon::fromTheme(QStringLiteral("process-stop")));
     m_stopButton->setAccessibleName(i18n("Stop"));
     m_stopButton->setAutoRaise(true);
     m_stopButton->setToolTip(i18nc("@tooltip", "Stop loading"));
     m_stopButton->hide();
     connect(m_stopButton, &QToolButton::clicked, this, &DolphinStatusBar::stopPressed);
 
-    m_progressTextLabel = new QLabel(this);
+    m_progressTextLabel = new QLabel(contentsContainer);
     m_progressTextLabel->hide();
 
-    m_progressBar = new QProgressBar(this);
+    m_progressBar = new QProgressBar(contentsContainer);
     m_progressBar->hide();
 
     m_showProgressBarTimer = new QTimer(this);
@@ -99,48 +100,61 @@ DolphinStatusBar::DolphinStatusBar(QWidget* parent) :
     m_showProgressBarTimer->setSingleShot(true);
     connect(m_showProgressBarTimer, &QTimer::timeout, this, &DolphinStatusBar::updateProgressInfo);
 
-    m_resetToDefaultTextTimer = new QTimer(this);
-    m_resetToDefaultTextTimer->setInterval(ResetToDefaultTimeout);
-    m_resetToDefaultTextTimer->setSingleShot(true);
-    connect(m_resetToDefaultTextTimer, &QTimer::timeout, this, &DolphinStatusBar::slotResetToDefaultText);
+    // initialize text updater delay timer
+    m_delayUpdateTimer = new QTimer(this);
+    m_delayUpdateTimer->setInterval(UpdateDelay);
+    m_delayUpdateTimer->setSingleShot(true);
+    connect(m_delayUpdateTimer, &QTimer::timeout, this, &DolphinStatusBar::updateLabelText);
 
     // Initialize top layout and size policies
     const int fontHeight = QFontMetrics(m_label->font()).height();
     const int zoomSliderHeight = m_zoomSlider->minimumSizeHint().height();
-    const int contentHeight = qMax(fontHeight, zoomSliderHeight);
+    const int buttonHeight = m_stopButton->height();
+    const int contentHeight = qMax(qMax(fontHeight, zoomSliderHeight), buttonHeight);
 
     QFontMetrics fontMetrics(m_label->font());
 
     m_label->setFixedHeight(contentHeight);
     m_label->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
 
-    m_zoomSlider->setMaximumWidth(fontMetrics.averageCharWidth() * 25);
+    m_zoomSlider->setMaximumWidth(fontMetrics.averageCharWidth() * 15);
 
     m_spaceInfo->setFixedHeight(contentHeight);
     m_spaceInfo->setMaximumWidth(fontMetrics.averageCharWidth() * 25);
     m_spaceInfo->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
 
-    m_progressBar->setFixedHeight(contentHeight);
-    m_progressBar->setMaximumWidth(fontMetrics.averageCharWidth() * 25);
-
-    QHBoxLayout* topLayout = new QHBoxLayout(this);
-    topLayout->setMargin(0);
-    topLayout->setSpacing(4);
-    topLayout->addWidget(m_label);
-    topLayout->addWidget(m_zoomSlider);
-    topLayout->addWidget(m_spaceInfo);
-    topLayout->addWidget(m_stopButton);
-    topLayout->addWidget(m_progressTextLabel);
-    topLayout->addWidget(m_progressBar);
-
-    setExtensionsVisible(true);
+    m_progressBar->setFixedHeight(zoomSliderHeight);
+    m_progressBar->setMaximumWidth(fontMetrics.averageCharWidth() * 20);
+
+    m_topLayout = new QHBoxLayout(contentsContainer);
+    updateContentsMargins();
+    m_topLayout->setSpacing(4);
+    m_topLayout->addWidget(m_label, 1);
+    m_topLayout->addWidget(m_zoomLabel);
+    m_topLayout->addWidget(m_zoomSlider, 1);
+    m_topLayout->addWidget(m_spaceInfo, 1);
+    m_topLayout->addWidget(m_stopButton);
+    m_topLayout->addWidget(m_progressTextLabel);
+    m_topLayout->addWidget(m_progressBar);
+
+    readSettings();
+    setWhatsThis(xi18nc("@info:whatsthis Statusbar",
+                        "<para>This is "
+                        "the <emphasis>Statusbar</emphasis>. It contains three elements "
+                        "by default (left to right):<list><item>A <emphasis>text field"
+                        "</emphasis> that displays the size of selected items. If only "
+                        "one item is selected the name and type is shown as well.</item>"
+                        "<item>A <emphasis>zoom slider</emphasis> that allows you "
+                        "to adjust the size of the icons in the view.</item>"
+                        "<item><emphasis>Space information</emphasis> about the "
+                        "current storage device.</item></list></para>"));
 }
 
 DolphinStatusBar::~DolphinStatusBar()
 {
 }
 
-void DolphinStatusBar::setText(const QStringtext)
+void DolphinStatusBar::setText(const QString &text)
 {
     if (m_text == text) {
         return;
@@ -148,19 +162,9 @@ void DolphinStatusBar::setText(const QString& text)
 
     m_textTimestamp = QTime::currentTime();
 
-    if (text.isEmpty()) {
-        // Assure that the previous set text won't get
-        // cleared immediatelly.
-        m_resetToDefaultTextTimer->start();
-    } else {
-        m_text = text;
-
-        if (m_resetToDefaultTextTimer->isActive()) {
-            m_resetToDefaultTextTimer->start();
-        }
-
-        updateLabelText();
-    }
+    m_text = text;
+    // will update status bar text in 50ms
+    m_delayUpdateTimer->start();
 }
 
 QString DolphinStatusBar::text() const
@@ -168,37 +172,43 @@ QString DolphinStatusBar::text() const
     return m_text;
 }
 
-void DolphinStatusBar::setProgressText(const QString& text)
-{
-    m_progressTextLabel->setText(text);
-}
-
-QString DolphinStatusBar::progressText() const
+void DolphinStatusBar::showProgress(const QString &currentlyRunningTaskTitle, int progressPercent, CancelLoading cancelLoading)
 {
-    return m_progressTextLabel->text();
-}
+    m_cancelLoading = cancelLoading;
 
-void DolphinStatusBar::setProgress(int percent)
-{
     // Show a busy indicator if a value < 0 is provided:
-    m_progressBar->setMaximum((percent < 0) ? 0 : 100);
+    m_progressBar->setMaximum((progressPercent < 0) ? 0 : 100);
 
-    percent = qBound(0, percent, 100);
-    const bool progressRestarted = (percent < 100) && (percent < m_progress);
-    m_progress = percent;
-    if (progressRestarted && !m_progressBar->isVisible()) {
+    progressPercent = qBound(0, progressPercent, 100);
+    if (!m_progressBar->isVisible()) {
         // Show the progress bar delayed: In the case if 100 % are reached within
         // a short time, no progress bar will be shown at all.
-        m_showProgressBarTimer->start();
+        if (!m_showProgressBarTimer->isActive()) {
+            m_showProgressBarTimer->start();
+        } else {
+            // The timer is already running. Should we restart it or keep it running?
+            if (m_progressTextLabel->text() != currentlyRunningTaskTitle || (progressPercent < 100 && progressPercent < m_progress)) {
+                m_showProgressBarTimer->start();
+            }
+        }
     }
+    m_progress = progressPercent;
 
     m_progressBar->setValue(m_progress);
-    if (percent == 100) {
+    if (progressPercent == 100) {
         // The end of the progress has been reached. Assure that the progress bar
         // gets hidden and the extensions widgets get visible again.
         m_showProgressBarTimer->stop();
         updateProgressInfo();
     }
+
+    m_progressTextLabel->setText(currentlyRunningTaskTitle);
+    updateWidthToContent();
+}
+
+QString DolphinStatusBar::progressText() const
+{
+    return m_progressTextLabel->text();
 }
 
 int DolphinStatusBar::progress() const
@@ -208,16 +218,17 @@ int DolphinStatusBar::progress() const
 
 void DolphinStatusBar::resetToDefaultText()
 {
+    m_text.clear();
+
     QTime currentTime;
-    if (currentTime.msecsTo(m_textTimestamp) < ResetToDefaultTimeout) {
-        m_resetToDefaultTextTimer->start();
+    if (currentTime.msecsTo(m_textTimestamp) < UpdateDelay) {
+        m_delayUpdateTimer->start();
     } else {
-        m_resetToDefaultTextTimer->stop();
-        slotResetToDefaultText();
+        updateLabelText();
     }
 }
 
-void DolphinStatusBar::setDefaultText(const QStringtext)
+void DolphinStatusBar::setDefaultText(const QString &text)
 {
     m_defaultText = text;
     updateLabelText();
@@ -228,9 +239,12 @@ QString DolphinStatusBar::defaultText() const
     return m_defaultText;
 }
 
-void DolphinStatusBar::setUrl(const QUrlurl)
+void DolphinStatusBar::setUrl(const QUrl &url)
 {
-    m_spaceInfo->setUrl(url);
+    if (GeneralSettings::showStatusBar() == GeneralSettings::EnumShowStatusBar::FullWidth && m_spaceInfo && m_spaceInfo->url() != url) {
+        m_spaceInfo->setUrl(url);
+        Q_EMIT urlChanged();
+    }
 }
 
 QUrl DolphinStatusBar::url() const
@@ -252,41 +266,99 @@ int DolphinStatusBar::zoomLevel() const
 
 void DolphinStatusBar::readSettings()
 {
+    updateMode();
     setExtensionsVisible(true);
 }
 
-void DolphinStatusBar::contextMenuEvent(QContextMenuEvent* event)
+void DolphinStatusBar::updateSpaceInfo()
 {
-    Q_UNUSED(event);
+    m_spaceInfo->update();
+}
+
+void DolphinStatusBar::updateWidthToContent()
+{
+    if (GeneralSettings::showStatusBar() == GeneralSettings::EnumShowStatusBar::Small) {
+        QStyleOptionSlider opt;
+        opt.initFrom(this);
+        opt.orientation = Qt::Vertical;
+        const QSize labelSize = QFontMetrics(font()).size(Qt::TextSingleLine, m_label->fullText());
+        // Make sure minimum height takes clipping into account.
+        setMinimumHeight(m_label->height() + clippingAmount());
+        const int scrollbarWidth = style()->pixelMetric(QStyle::PM_ScrollBarExtent, &opt, this);
+        // Make sure maximumViewWidth does not go below 0.
+        const int maximumViewWidth = qMax(0, parentWidget()->width() - scrollbarWidth);
+        if (m_stopButton->isVisible() || m_progressTextLabel->isVisible() || m_progressBar->isVisible()) {
+            // Use maximum width when interactable elements are shown, to keep them
+            // from "jumping around" when user tries to interact with them.
+            setFixedWidth(maximumViewWidth);
+        } else {
+            const int contentWidth = labelSize.width() + 15;
+            setFixedWidth(qMin(contentWidth, maximumViewWidth));
+        }
+        Q_EMIT widthUpdated();
+    } else {
+        setMinimumHeight(0);
+        setFixedWidth(QWIDGETSIZE_MAX);
+        Q_EMIT widthUpdated();
+    }
+}
+
+int DolphinStatusBar::clippingAmount() const
+{
+    QStyleOption opt;
+    opt.initFrom(this);
+    // Add 2 for extra padding due to how QRect coordinates work.
+    const int val = 2 + style()->pixelMetric(QStyle::PM_SplitterWidth, &opt, this) * 2;
+    return val;
+}
+
+void DolphinStatusBar::updateMode()
+{
+    switch (GeneralSettings::showStatusBar()) {
+    case GeneralSettings::EnumShowStatusBar::Small:
+        setEnabled(true);
+        m_spaceInfo->setShown(false);
+        m_zoomSlider->setVisible(false);
+        m_zoomLabel->setVisible(false);
+        setVisible(true, WithAnimation);
+        break;
+    case GeneralSettings::EnumShowStatusBar::FullWidth:
+        setEnabled(true);
+        m_spaceInfo->setShown(true);
+        setVisible(true, WithAnimation);
+        break;
+    case GeneralSettings::EnumShowStatusBar::Disabled:
+        setEnabled(false);
+        setVisible(false, WithoutAnimation);
+        break;
+    }
+    Q_EMIT modeUpdated();
+    updateWidthToContent();
+}
+
+void DolphinStatusBar::contextMenuEvent(QContextMenuEvent *event)
+{
+    Q_UNUSED(event)
+
+    // Do not show the context menu on small statusbar.
+    if (GeneralSettings::showStatusBar() == GeneralSettings::EnumShowStatusBar::Small) {
+        return;
+    }
 
     QMenu menu(this);
 
-    QActionshowZoomSliderAction = menu.addAction(i18nc("@action:inmenu", "Show Zoom Slider"));
+    QAction *showZoomSliderAction = menu.addAction(i18nc("@action:inmenu", "Show Zoom Slider"));
     showZoomSliderAction->setCheckable(true);
     showZoomSliderAction->setChecked(GeneralSettings::showZoomSlider());
 
-    QAction* showSpaceInfoAction = menu.addAction(i18nc("@action:inmenu", "Show Space Information"));
-    showSpaceInfoAction->setCheckable(true);
-    showSpaceInfoAction->setChecked(GeneralSettings::showSpaceInfo());
-
-    const QAction* action = menu.exec(QCursor::pos());
+    const QAction *action = menu.exec(event->reason() == QContextMenuEvent::Reason::Mouse ? QCursor::pos() : mapToGlobal(QPoint(width() / 2, height() / 2)));
     if (action == showZoomSliderAction) {
         const bool visible = showZoomSliderAction->isChecked();
         GeneralSettings::setShowZoomSlider(visible);
         m_zoomSlider->setVisible(visible);
-    } else if (action == showSpaceInfoAction) {
-        const bool visible = showSpaceInfoAction->isChecked();
-        GeneralSettings::setShowSpaceInfo(visible);
-        m_spaceInfo->setVisible(visible);
-    }
-}
-
-bool DolphinStatusBar::eventFilter(QObject* obj, QEvent* event)
-{
-    if (obj == m_label && event->type() == QEvent::Resize) {
-        updateLabelText();
+        m_zoomLabel->setVisible(visible);
     }
-    return QWidget::eventFilter(obj, event);
+    updateContentsMargins();
 }
 
 void DolphinStatusBar::showZoomSliderToolTip(int zoomLevel)
@@ -303,7 +375,7 @@ void DolphinStatusBar::updateProgressInfo()
 {
     if (m_progress < 100) {
         // Show the progress information and hide the extensions
-        m_stopButton->show();
+        m_stopButton->setVisible(m_cancelLoading == CancelLoading::Allowed);
         m_progressTextLabel->show();
         m_progressBar->show();
         setExtensionsVisible(false);
@@ -314,29 +386,14 @@ void DolphinStatusBar::updateProgressInfo()
         m_progressBar->hide();
         setExtensionsVisible(true);
     }
+    updateWidthToContent();
 }
 
 void DolphinStatusBar::updateLabelText()
 {
     const QString text = m_text.isEmpty() ? m_defaultText : m_text;
-
-    // Set status bar text and elide it if too long
-    QFontMetrics fontMetrics(m_label->font());
-    const QString elidedText = fontMetrics.elidedText(text, Qt::ElideRight, m_label->width());
-    m_label->setText(elidedText);
-
-    // If the text has been elided, set the original text as tooltip
-    if (text != elidedText) {
-        m_label->setToolTip(Qt::convertFromPlainText(text));
-    } else {
-        m_label->setToolTip(QString());
-    }
-}
-
-void DolphinStatusBar::slotResetToDefaultText()
-{
-    m_text.clear();
-    updateLabelText();
+    m_label->setText(text);
+    updateWidthToContent();
 }
 
 void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
@@ -347,13 +404,61 @@ void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
 
 void DolphinStatusBar::setExtensionsVisible(bool visible)
 {
-    bool showSpaceInfo = visible;
     bool showZoomSlider = visible;
     if (visible) {
-        showSpaceInfo = GeneralSettings::showSpaceInfo();
-        showZoomSlider = GeneralSettings::showZoomSlider();
+        showZoomSlider = GeneralSettings::showZoomSlider() && GeneralSettings::showStatusBar() == GeneralSettings::EnumShowStatusBar::FullWidth;
     }
-    m_spaceInfo->setVisible(showSpaceInfo);
+
     m_zoomSlider->setVisible(showZoomSlider);
+    m_zoomLabel->setVisible(showZoomSlider);
+    updateContentsMargins();
+}
+
+void DolphinStatusBar::updateContentsMargins()
+{
+    if (GeneralSettings::showStatusBar() == GeneralSettings::EnumShowStatusBar::FullWidth) {
+        // We reduce the outside margin for the flat button so it visually has the same margin as the status bar text label on the other end of the bar.
+        m_topLayout->setContentsMargins(6, 0, 2, 0);
+    } else {
+        // Add extra margins to toplayout to avoid clipping too early.
+        m_topLayout->setContentsMargins(clippingAmount() * 2, 0, clippingAmount(), clippingAmount());
+    }
+    setContentsMargins(0, 0, 0, 0);
+}
+
+void DolphinStatusBar::paintEvent(QPaintEvent *paintEvent)
+{
+    Q_UNUSED(paintEvent)
+    QPainter p(this);
+    QStyleOption opt;
+    opt.initFrom(this);
+    // Draw statusbar only if there is text.
+    if (GeneralSettings::showStatusBar() == GeneralSettings::EnumShowStatusBar::Small) {
+        if (m_label && !m_label->fullText().isEmpty()) {
+            opt.state = QStyle::State_Sunken;
+            QPainterPath path;
+            // Clip the left and bottom border off.
+            QRect clipRect;
+            if (layoutDirection() == Qt::RightToLeft) {
+                clipRect = QRect(opt.rect.topLeft(), opt.rect.bottomRight()).adjusted(0, 0, -clippingAmount(), -clippingAmount());
+            } else {
+                clipRect = QRect(opt.rect.topLeft(), opt.rect.bottomRight()).adjusted(clippingAmount(), 0, 0, -clippingAmount());
+            }
+            path.addRect(clipRect);
+            p.setClipPath(path);
+            opt.palette.setColor(QPalette::Base, palette().window().color());
+            style()->drawPrimitive(QStyle::PE_Frame, &opt, &p, this);
+        }
+    }
+    // Draw regular statusbar.
+    else {
+        style()->drawPrimitive(QStyle::PE_PanelStatusBar, &opt, &p, this);
+    }
+}
+
+int DolphinStatusBar::preferredHeight() const
+{
+    return m_spaceInfo->height();
 }
 
+#include "moc_dolphinstatusbar.cpp"