]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/statusbar/dolphinstatusbar.cpp
Add clang-format and format code as in Frameworks
[dolphin.git] / src / statusbar / dolphinstatusbar.cpp
index 4cfa3aeaec85dfd13664713d4a0b460e46880a04..42ce58f64478d444a157bcb352608c58d54dc26c 100644 (file)
-/***************************************************************************
- *   Copyright (C) 2006 by Peter Penz                                      *
- *   peter.penz@gmx.at                                                     *
- *                                                                         *
- *   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 <kiconloader.h>
-#include <kicon.h>
-#include <klocale.h>
-#include <kmenu.h>
-#include <kvbox.h>
-
-#include "settings/dolphinsettings.h"
 #include "statusbarspaceinfo.h"
+#include "views/dolphinview.h"
+#include "views/zoomlevelinfo.h"
+
+#include <KLocalizedString>
+#include <KSqueezedTextLabel>
 
 #include <QApplication>
-#include <QClipboard>
 #include <QHBoxLayout>
-#include <QLabel>
+#include <QHelpEvent>
+#include <QIcon>
+#include <QMenu>
 #include <QProgressBar>
-#include <QToolButton>
+#include <QSlider>
 #include <QTimer>
+#include <QToolButton>
 
-#include <views/dolphinview.h>
-#include <views/zoomlevelinfo.h>
-
-DolphinStatusBar::DolphinStatusBar(QWidget* parent, DolphinView* view) :
-    QWidget(parent),
-    m_view(view),
-    m_messageLabel(0),
-    m_spaceInfo(0),
-    m_zoomWidget(0),
-    m_zoomOut(0),
-    m_zoomSlider(0),
-    m_zoomIn(0),
-    m_progressBar(0),
-    m_stopButton(0),
-    m_progress(100),
-    m_messageTimeStamp()
+namespace
 {
-    connect(m_view, SIGNAL(urlChanged(const KUrl&)),
-            this, SLOT(updateSpaceInfoContent(const KUrl&)));
-
-    // Initialize message label
-    m_messageLabel = new KonqStatusBarMessageLabel(this);
-
-    // Initialize zoom slider
-    m_zoomWidget = new QWidget(this);
-
-    m_zoomOut = new QToolButton(m_zoomWidget);
-    m_zoomOut->setIcon(KIcon("zoom-out"));
-    m_zoomOut->setAutoRaise(true);
+const int UpdateDelay = 50;
+}
 
-    m_zoomSlider = new QSlider(Qt::Horizontal, m_zoomWidget);
+DolphinStatusBar::DolphinStatusBar(QWidget *parent)
+    : QWidget(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()
+{
+    // Initialize text label
+    m_label = new KSqueezedTextLabel(m_text, this);
+    m_label->setWordWrap(true);
+    m_label->setTextFormat(Qt::PlainText);
+
+    // Initialize zoom slider's explanatory label
+    m_zoomLabel = new QLabel(i18nc("Used as a noun, i.e. 'Here is the zoom level:'", "Zoom:"), this);
+
+    // Initialize zoom widget
+    m_zoomSlider = new QSlider(Qt::Horizontal, this);
+    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);
+    m_zoomSlider->setRange(ZoomLevelInfo::minimumLevel(), ZoomLevelInfo::maximumLevel());
 
-    const int min = ZoomLevelInfo::minimumLevel();
-    const int max = ZoomLevelInfo::maximumLevel();
-    m_zoomSlider->setRange(min, max);
-    m_zoomSlider->setValue(view->zoomLevel());
-    updateZoomSliderToolTip(view->zoomLevel());
-
-    m_zoomIn = new QToolButton(m_zoomWidget);
-    m_zoomIn->setIcon(KIcon("zoom-in"));
-    m_zoomIn->setAutoRaise(true);
-
-    // Initialize zoom widget layout
-    QHBoxLayout* zoomWidgetLayout = new QHBoxLayout(m_zoomWidget);
-    zoomWidgetLayout->setSpacing(0);
-    zoomWidgetLayout->setMargin(0);
-    zoomWidgetLayout->addWidget(m_zoomOut);
-    zoomWidgetLayout->addWidget(m_zoomSlider);
-    zoomWidgetLayout->addWidget(m_zoomIn);
-
-    connect(m_zoomSlider, SIGNAL(valueChanged(int)), this, SLOT(setZoomLevel(int)));
-    connect(m_zoomSlider, SIGNAL(sliderMoved(int)), this, SLOT(showZoomSliderToolTip(int)));
-    connect(m_view, SIGNAL(zoomLevelChanged(int)), m_zoomSlider, SLOT(setValue(int)));
-    connect(m_zoomOut, SIGNAL(clicked()), this, SLOT(zoomOut()));
-    connect(m_zoomIn, SIGNAL(clicked()), this, SLOT(zoomIn()));
+    connect(m_zoomSlider, &QSlider::valueChanged, this, &DolphinStatusBar::zoomLevelChanged);
+    connect(m_zoomSlider, &QSlider::valueChanged, this, &DolphinStatusBar::updateZoomSliderToolTip);
+    connect(m_zoomSlider, &QSlider::sliderMoved, this, &DolphinStatusBar::showZoomSliderToolTip);
 
     // Initialize space information
     m_spaceInfo = new StatusBarSpaceInfo(this);
-    m_spaceInfo->setUrl(m_view->url());
 
     // Initialize progress information
     m_stopButton = new QToolButton(this);
-    m_stopButton->setIcon(KIcon("process-stop"));
-    // TODO: Add tooltip for KDE SC 4.7.0, if new strings are allowed again
+    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, SIGNAL(clicked()), this, SIGNAL(stopPressed()));
+    connect(m_stopButton, &QToolButton::clicked, this, &DolphinStatusBar::stopPressed);
 
-    m_progressText = new QLabel(this);
-    m_progressText->hide();
+    m_progressTextLabel = new QLabel(this);
+    m_progressTextLabel->hide();
 
     m_progressBar = new QProgressBar(this);
     m_progressBar->hide();
 
+    m_showProgressBarTimer = new QTimer(this);
+    m_showProgressBarTimer->setInterval(500);
+    m_showProgressBarTimer->setSingleShot(true);
+    connect(m_showProgressBarTimer, &QTimer::timeout, this, &DolphinStatusBar::updateProgressInfo);
+
+    // 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_messageLabel->font()).height();
-    const int zoomWidgetHeight = m_zoomWidget->minimumSizeHint().height();
-    const int contentHeight = qMax(fontHeight, zoomWidgetHeight);
+    const int fontHeight = QFontMetrics(m_label->font()).height();
+    const int zoomSliderHeight = m_zoomSlider->minimumSizeHint().height();
+    const int buttonHeight = m_stopButton->height();
+    const int contentHeight = qMax(qMax(fontHeight, zoomSliderHeight), buttonHeight);
+
+    QFontMetrics fontMetrics(m_label->font());
 
-    m_messageLabel->setMinimumTextHeight(contentHeight);
+    m_label->setFixedHeight(contentHeight);
+    m_label->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
 
-    m_spaceInfo->setMaximumSize(200, contentHeight - 5);
+    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->setMaximumSize(200, contentHeight);
-    m_zoomWidget->setMaximumSize(150, contentHeight);
-    m_zoomSlider->setMinimumWidth(30);
+    m_progressBar->setFixedHeight(zoomSliderHeight);
+    m_progressBar->setMaximumWidth(fontMetrics.averageCharWidth() * 20);
 
-    QHBoxLayouttopLayout = new QHBoxLayout(this);
-    topLayout->setMargin(0);
+    QHBoxLayout *topLayout = new QHBoxLayout(this);
+    topLayout->setContentsMargins(2, 0, 2, 0);
     topLayout->setSpacing(4);
-    topLayout->addWidget(m_messageLabel);
-    topLayout->addWidget(m_zoomWidget);
-    topLayout->addWidget(m_spaceInfo);
+    topLayout->addWidget(m_label, 1);
+    topLayout->addWidget(m_zoomLabel);
+    topLayout->addWidget(m_zoomSlider, 1);
+    topLayout->addWidget(m_spaceInfo, 1);
     topLayout->addWidget(m_stopButton);
-    topLayout->addWidget(m_progressText);
+    topLayout->addWidget(m_progressTextLabel);
     topLayout->addWidget(m_progressBar);
 
+    setVisible(GeneralSettings::showStatusBar());
     setExtensionsVisible(true);
+    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::setMessage(const QString& msg,
-                                  Type type)
+void DolphinStatusBar::setText(const QString &text)
 {
-    int timeout = 1000; // Timeout in milliseconds until default
-                        // messages may overwrite other messages.
-
-    QString message = msg;
-    if (message.isEmpty()) {
-        // Show the default text as fallback. An empty text indicates
-        // a clearing of the information message.
-        if (m_messageLabel->defaultText().isEmpty()) {
-            return;
-        }
-        message = m_messageLabel->defaultText();
-        type = Default;
-        timeout = 0;
-    }
-
-    KonqStatusBarMessageLabel::Type konqType = static_cast<KonqStatusBarMessageLabel::Type>(type);
-    if ((message == m_messageLabel->text()) && (konqType == m_messageLabel->type())) {
-        // the message is already shown
+    if (m_text == text) {
         return;
     }
 
-    const QTime currentTime = QTime::currentTime();
-    const bool skipMessage = (type == Default) &&
-                             m_messageTimeStamp.isValid() &&
-                             (m_messageTimeStamp.msecsTo(currentTime) < timeout);
-    if (skipMessage) {
-        // A non-default message is shown just for a very short time. Don't hide
-        // the message by a default message, so that the user gets the chance to
-        // read the information.
-        return;
-    }
-
-    m_messageLabel->setMessage(message, konqType);
-    if (type != Default) {
-        m_messageTimeStamp = currentTime;
-    }
-}
-
-DolphinStatusBar::Type DolphinStatusBar::type() const
-{
-    return static_cast<Type>(m_messageLabel->type());
-}
+    m_textTimestamp = QTime::currentTime();
 
-QString DolphinStatusBar::message() const
-{
-    return m_messageLabel->text();
+    m_text = text;
+    // will update status bar text in 50ms
+    m_delayUpdateTimer->start();
 }
 
-void DolphinStatusBar::setProgressText(const QString& text)
+QString DolphinStatusBar::text() const
 {
-    m_progressText->setText(text);
+    return m_text;
 }
 
-int DolphinStatusBar::progress() const
+void DolphinStatusBar::setProgressText(const QString &text)
 {
-    return m_progress;
+    m_progressTextLabel->setText(text);
 }
 
 QString DolphinStatusBar::progressText() const
 {
-    return m_progressText->text();
+    return m_progressTextLabel->text();
 }
 
 void DolphinStatusBar::setProgress(int percent)
@@ -216,121 +174,112 @@ void DolphinStatusBar::setProgress(int percent)
     // Show a busy indicator if a value < 0 is provided:
     m_progressBar->setMaximum((percent < 0) ? 0 : 100);
 
-    if (percent < 0) {
-        percent = 0;
-    } else if (percent > 100) {
-        percent = 100;
-    }
-
+    percent = qBound(0, percent, 100);
+    const bool progressRestarted = (percent < 100) && (percent < m_progress);
     m_progress = percent;
-    if (m_messageLabel->type() == KonqStatusBarMessageLabel::Error) {
-        // Don't update any widget or status bar text if an
-        // error message is shown
-        return;
+    if (progressRestarted && !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();
     }
 
     m_progressBar->setValue(m_progress);
-    if (!m_progressBar->isVisible() || (percent == 100)) {
+    if (percent == 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();
     }
-
-    const QString defaultText = m_messageLabel->defaultText();
-    const QString msg(m_messageLabel->text());
-    if ((percent == 0) && !msg.isEmpty()) {
-        setMessage(QString(), Default);
-    } else if ((percent == 100) && (msg != defaultText)) {
-        setMessage(defaultText, Default);
-    }
 }
 
-void DolphinStatusBar::clear()
+int DolphinStatusBar::progress() const
 {
-    setMessage(m_messageLabel->defaultText(), Default);
+    return m_progress;
 }
 
-void DolphinStatusBar::setDefaultText(const QString& text)
+void DolphinStatusBar::resetToDefaultText()
 {
-    m_messageLabel->setDefaultText(text);
+    m_text.clear();
+
+    QTime currentTime;
+    if (currentTime.msecsTo(m_textTimestamp) < UpdateDelay) {
+        m_delayUpdateTimer->start();
+    } else {
+        updateLabelText();
+    }
 }
 
-QString DolphinStatusBar::defaultText() const
+void DolphinStatusBar::setDefaultText(const QString &text)
 {
-    return m_messageLabel->defaultText();
+    m_defaultText = text;
+    updateLabelText();
 }
 
-void DolphinStatusBar::refresh()
+QString DolphinStatusBar::defaultText() const
 {
-    setExtensionsVisible(true);
+    return m_defaultText;
 }
 
-void DolphinStatusBar::contextMenuEvent(QContextMenuEvent* event)
+void DolphinStatusBar::setUrl(const QUrl &url)
 {
-    Q_UNUSED(event);
-
-    KMenu menu(this);
-
-    QAction* copyAction = 0;
-    switch (type()) {
-    case Default:
-    case OperationCompleted:
-    case Information:
-        copyAction = menu.addAction(i18nc("@action:inmenu", "Copy Information Message"));
-        break;
-    case Error:
-        copyAction = menu.addAction(i18nc("@action:inmenu", "Copy Error Message"));
-        break;
-    default: break;
+    if (GeneralSettings::showSpaceInfo()) {
+        m_spaceInfo->setUrl(url);
     }
+}
 
-    GeneralSettings* settings = DolphinSettings::instance().generalSettings();
-
-    QAction* showZoomSliderAction = menu.addAction(i18nc("@action:inmenu", "Show Zoom Slider"));
-    showZoomSliderAction->setCheckable(true);
-    showZoomSliderAction->setChecked(settings->showZoomSlider());
+QUrl DolphinStatusBar::url() const
+{
+    return m_spaceInfo->url();
+}
 
-    QAction* showSpaceInfoAction = menu.addAction(i18nc("@action:inmenu", "Show Space Information"));
-    showSpaceInfoAction->setCheckable(true);
-    showSpaceInfoAction->setChecked(settings->showSpaceInfo());
-
-    const QAction* action = menu.exec(QCursor::pos());
-    if (action == copyAction) {
-        QMimeData* mimeData = new QMimeData();
-        mimeData->setText(message());
-        QApplication::clipboard()->setMimeData(mimeData);
-    } else if (action == showZoomSliderAction) {
-        const bool visible = showZoomSliderAction->isChecked();
-        settings->setShowZoomSlider(visible);
-        m_zoomWidget->setVisible(visible);
-    } else if (action == showSpaceInfoAction) {
-        const bool visible = showSpaceInfoAction->isChecked();
-        settings->setShowSpaceInfo(visible);
-        m_spaceInfo->setVisible(visible);
+void DolphinStatusBar::setZoomLevel(int zoomLevel)
+{
+    if (zoomLevel != m_zoomSlider->value()) {
+        m_zoomSlider->setValue(zoomLevel);
     }
 }
 
-void DolphinStatusBar::updateSpaceInfoContent(const KUrl& url)
+int DolphinStatusBar::zoomLevel() const
 {
-    m_spaceInfo->setUrl(url);
+    return m_zoomSlider->value();
 }
 
-void DolphinStatusBar::setZoomLevel(int zoomLevel)
+void DolphinStatusBar::readSettings()
 {
-    m_zoomOut->setEnabled(zoomLevel > m_zoomSlider->minimum());
-    m_zoomIn->setEnabled(zoomLevel < m_zoomSlider->maximum());
-    m_view->setZoomLevel(zoomLevel);
-    updateZoomSliderToolTip(zoomLevel);
+    setVisible(GeneralSettings::showStatusBar());
+    setExtensionsVisible(true);
 }
 
-void DolphinStatusBar::zoomOut()
+void DolphinStatusBar::updateSpaceInfo()
 {
-    const int value = m_zoomSlider->value();
-    m_zoomSlider->setValue(value - 1);
+    m_spaceInfo->update();
 }
 
-void DolphinStatusBar::zoomIn()
+void DolphinStatusBar::contextMenuEvent(QContextMenuEvent *event)
 {
-    const int value = m_zoomSlider->value();
-    m_zoomSlider->setValue(value + 1);
+    Q_UNUSED(event)
+
+    QMenu menu(this);
+
+    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());
+    if (action == showZoomSliderAction) {
+        const bool visible = showZoomSliderAction->isChecked();
+        GeneralSettings::setShowZoomSlider(visible);
+        m_zoomSlider->setVisible(visible);
+        m_zoomLabel->setVisible(visible);
+    } else if (action == showSpaceInfoAction) {
+        const bool visible = showSpaceInfoAction->isChecked();
+        GeneralSettings::setShowSpaceInfo(visible);
+        m_spaceInfo->setVisible(visible);
+    }
 }
 
 void DolphinStatusBar::showZoomSliderToolTip(int zoomLevel)
@@ -345,35 +294,25 @@ void DolphinStatusBar::showZoomSliderToolTip(int zoomLevel)
 
 void DolphinStatusBar::updateProgressInfo()
 {
-    const bool isErrorShown = (m_messageLabel->type() == KonqStatusBarMessageLabel::Error);
     if (m_progress < 100) {
         // Show the progress information and hide the extensions
+        m_stopButton->show();
+        m_progressTextLabel->show();
+        m_progressBar->show();
         setExtensionsVisible(false);
-        if (!isErrorShown) {
-            m_stopButton->show();
-            m_progressText->show();
-            m_progressBar->show();
-        }
     } else {
         // Hide the progress information and show the extensions
         m_stopButton->hide();
-        m_progressText->hide();
+        m_progressTextLabel->hide();
         m_progressBar->hide();
         setExtensionsVisible(true);
     }
 }
 
-void DolphinStatusBar::setExtensionsVisible(bool visible)
+void DolphinStatusBar::updateLabelText()
 {
-    bool showSpaceInfo = visible;
-    bool showZoomWidget = visible;
-    if (visible) {
-        const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
-        showSpaceInfo = settings->showSpaceInfo();
-        showZoomWidget = settings->showZoomSlider();
-    }
-    m_spaceInfo->setVisible(showSpaceInfo);
-    m_zoomWidget->setVisible(showZoomWidget);
+    const QString text = m_text.isEmpty() ? m_defaultText : m_text;
+    m_label->setText(text);
 }
 
 void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
@@ -382,4 +321,17 @@ void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
     m_zoomSlider->setToolTip(i18ncp("@info:tooltip", "Size: 1 pixel", "Size: %1 pixels", size));
 }
 
-#include "dolphinstatusbar.moc"
+void DolphinStatusBar::setExtensionsVisible(bool visible)
+{
+    bool showSpaceInfo = visible;
+    bool showZoomSlider = visible;
+    if (visible) {
+        showSpaceInfo = GeneralSettings::showSpaceInfo();
+        showZoomSlider = GeneralSettings::showZoomSlider();
+    }
+
+    m_spaceInfo->setShown(showSpaceInfo);
+    m_spaceInfo->setVisible(showSpaceInfo);
+    m_zoomSlider->setVisible(showZoomSlider);
+    m_zoomLabel->setVisible(showZoomSlider);
+}