File indexing completed on 2024-04-28 05:45:18

 /*
  * 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 <KLocalizedString>
 #include <KSqueezedTextLabel>
 
 #include <QApplication>
 #include <QHBoxLayout>
 #include <QHelpEvent>
 #include <QIcon>
 #include <QMenu>
 #include <QPainter>
 #include <QProgressBar>
 #include <QSlider>
 #include <QStyleOption>
 #include <QTimer>
 #include <QToolButton>
 
 namespace
 {
 const int UpdateDelay = 50;
 }
 
 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()
 {
     setProperty("_breeze_statusbar_separator", true);
     // 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 KSqueezedTextLabel(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());
 
     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);
 
     // Initialize progress information
     m_stopButton = new QToolButton(this);
     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->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_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_label->setFixedHeight(contentHeight);
     m_label->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
 
     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(zoomSliderHeight);
     m_progressBar->setMaximumWidth(fontMetrics.averageCharWidth() * 20);
 
     QHBoxLayout *topLayout = new QHBoxLayout(this);
     updateContentsMargins();
     topLayout->setSpacing(4);
     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_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::setText(const QString &text)
 {
     if (m_text == text) {
         return;
     }
 
     m_textTimestamp = QTime::currentTime();
 
     m_text = text;
     // will update status bar text in 50ms
     m_delayUpdateTimer->start();
 }
 
 QString DolphinStatusBar::text() const
 {
     return m_text;
 }
 
 void DolphinStatusBar::setProgressText(const QString &text)
 {
     m_progressTextLabel->setText(text);
 }
 
 QString DolphinStatusBar::progressText() const
 {
     return m_progressTextLabel->text();
 }
 
 void DolphinStatusBar::setProgress(int percent)
 {
     // Show a busy indicator if a value < 0 is provided:
     m_progressBar->setMaximum((percent < 0) ? 0 : 100);
 
     percent = qBound(0, percent, 100);
     const bool progressRestarted = (percent < 100) && (percent < m_progress);
     m_progress = percent;
     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 (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();
     }
 }
 
 int DolphinStatusBar::progress() const
 {
     return m_progress;
 }
 
 void DolphinStatusBar::resetToDefaultText()
 {
     m_text.clear();
 
     QTime currentTime;
     if (currentTime.msecsTo(m_textTimestamp) < UpdateDelay) {
         m_delayUpdateTimer->start();
     } else {
         updateLabelText();
     }
 }
 
 void DolphinStatusBar::setDefaultText(const QString &text)
 {
     m_defaultText = text;
     updateLabelText();
 }
 
 QString DolphinStatusBar::defaultText() const
 {
     return m_defaultText;
 }
 
 void DolphinStatusBar::setUrl(const QUrl &url)
 {
     if (GeneralSettings::showSpaceInfo()) {
         m_spaceInfo->setUrl(url);
     }
 }
 
 QUrl DolphinStatusBar::url() const
 {
     return m_spaceInfo->url();
 }
 
 void DolphinStatusBar::setZoomLevel(int zoomLevel)
 {
     if (zoomLevel != m_zoomSlider->value()) {
         m_zoomSlider->setValue(zoomLevel);
     }
 }
 
 int DolphinStatusBar::zoomLevel() const
 {
     return m_zoomSlider->value();
 }
 
 void DolphinStatusBar::readSettings()
 {
     setVisible(GeneralSettings::showStatusBar());
     setExtensionsVisible(true);
 }
 
 void DolphinStatusBar::updateSpaceInfo()
 {
     m_spaceInfo->update();
 }
 
 void DolphinStatusBar::contextMenuEvent(QContextMenuEvent *event)
 {
     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(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);
         m_zoomLabel->setVisible(visible);
     } else if (action == showSpaceInfoAction) {
         const bool visible = showSpaceInfoAction->isChecked();
         GeneralSettings::setShowSpaceInfo(visible);
         m_spaceInfo->setVisible(visible);
     }
     updateContentsMargins();
 }
 
 void DolphinStatusBar::showZoomSliderToolTip(int zoomLevel)
 {
     updateZoomSliderToolTip(zoomLevel);
 
     QPoint global = m_zoomSlider->rect().topLeft();
     global.ry() += m_zoomSlider->height() / 2;
     QHelpEvent toolTipEvent(QEvent::ToolTip, QPoint(0, 0), m_zoomSlider->mapToGlobal(global));
     QApplication::sendEvent(m_zoomSlider, &toolTipEvent);
 }
 
 void DolphinStatusBar::updateProgressInfo()
 {
     if (m_progress < 100) {
         // Show the progress information and hide the extensions
         m_stopButton->show();
         m_progressTextLabel->show();
         m_progressBar->show();
         setExtensionsVisible(false);
     } else {
         // Hide the progress information and show the extensions
         m_stopButton->hide();
         m_progressTextLabel->hide();
         m_progressBar->hide();
         setExtensionsVisible(true);
     }
 }
 
 void DolphinStatusBar::updateLabelText()
 {
     const QString text = m_text.isEmpty() ? m_defaultText : m_text;
     m_label->setText(text);
 }
 
 void DolphinStatusBar::updateZoomSliderToolTip(int zoomLevel)
 {
     const int size = ZoomLevelInfo::iconSizeForZoomLevel(zoomLevel);
     m_zoomSlider->setToolTip(i18ncp("@info:tooltip", "Size: 1 pixel", "Size: %1 pixels", size));
 }
 
 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);
     updateContentsMargins();
 }
 
 void DolphinStatusBar::updateContentsMargins()
 {
     if (GeneralSettings::showSpaceInfo()) {
         // 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.
         layout()->setContentsMargins(6, 0, 2, 0);
     } else {
         layout()->setContentsMargins(6, 0, 6, 0);
     }
 }
 
 void DolphinStatusBar::paintEvent(QPaintEvent *paintEvent)
 {
     Q_UNUSED(paintEvent)
     QPainter p(this);
     QStyleOption opt;
     opt.initFrom(this);
     style()->drawPrimitive(QStyle::PE_PanelStatusBar, &opt, &p, this);
 }
 
 #include "moc_dolphinstatusbar.cpp"