src/statusbar/dolphinstatusbar.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006-2012 by Peter Penz <peter.penz19@gmail.com>        *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef DOLPHINSTATUSBAR_H
  21 #define DOLPHINSTATUSBAR_H
  22
  23 #include <QTime>
  24 #include <QWidget>
  25
  26 class QUrl;
  27 class StatusBarSpaceInfo;
  28 class QLabel;
  29 class QProgressBar;
  30 class QToolButton;
  31 class QSlider;
  32 class QTimer;
  33 class KSqueezedTextLabel;
  34
  35 /**
  36  * @brief Represents the statusbar of a Dolphin view.
  37  *
  38  * The statusbar allows to show messages, progress
  39  * information and space-information of a disk.
  40  */
  41 class DolphinStatusBar : public QWidget
  42 {
  43     Q_OBJECT
  44
  45 public:
  46     DolphinStatusBar(QWidget* parent);
  47     ~DolphinStatusBar() override;
  48
  49     QString text() const;
  50
  51     /**
  52      * Sets the text for the progress information.
  53      * DolphinStatusBar::setProgress() should be invoked
  54      * afterwards each time the progress changes.
  55      */
  56     void setProgressText(const QString& text);
  57     QString progressText() const;
  58
  59     /**
  60      * Sets the progress in percent (0 - 100). The
  61      * progress is shown delayed by 500 milliseconds:
  62      * If the progress does reach 100 % within 500 milliseconds,
  63      * the progress is not shown at all.
  64      */
  65     void setProgress(int percent);
  66     int progress() const;
  67
  68     /**
  69      * Replaces the text set by setText() by the text that
  70      * has been set by setDefaultText(). It is assured that the previous
  71      * text will be shown for at least 1 second. DolphinStatusBar::text()
  72      * will return an empty string after the reset has been done.
  73      */
  74     void resetToDefaultText();
  75
  76     /**
  77      * Sets the default text, which is shown if the status bar
  78      * is rest by DolphinStatusBar::resetToDefaultText().
  79      */
  80     void setDefaultText(const QString& text);
  81     QString defaultText() const;
  82
  83     QUrl url() const;
  84     int zoomLevel() const;
  85
  86     /**
  87      * Refreshes the status bar to get synchronized with the (updated) Dolphin settings.
  88      */
  89     void readSettings();
  90
  91 public slots:
  92     void setText(const QString& text);
  93     void setUrl(const QUrl& url);
  94     void setZoomLevel(int zoomLevel);
  95
  96 signals:
  97     /**
  98      * Is emitted if the stop-button has been pressed during showing a progress.
  99      */
 100     void stopPressed();
 101
 102     void zoomLevelChanged(int zoomLevel);
 103
 104 protected:
 105     void contextMenuEvent(QContextMenuEvent* event) override;
 106
 107 private slots:
 108     void showZoomSliderToolTip(int zoomLevel);
 109     void updateProgressInfo();
 110
 111     /**
 112      * Updates the text for m_label and does an eliding in
 113      * case if the text does not fit into the available width.
 114      */
 115     void updateLabelText();
 116
 117     /**
 118      * Is invoked by m_resetToDefaultTextTimer and clears
 119      * m_text so that the default text will be shown. This
 120      * prevents that information-messages will be cleared
 121      * too fast.
 122      */
 123     void slotResetToDefaultText();
 124
 125     /**
 126      * Updates the text of the zoom slider tooltip to show
 127      * the currently used size.
 128      */
 129     void updateZoomSliderToolTip(int zoomLevel);
 130
 131 private:
 132     /**
 133      * Makes the space information widget and zoom slider widget
 134      * visible, if \a visible is true and the settings allow to show
 135      * the widgets. showUnknownProgressIf \a visible is false, it is assured that both
 136      * widgets are hidden.
 137      */
 138     void setExtensionsVisible(bool visible);
 139
 140 private:
 141     QString m_text;
 142     QString m_defaultText;
 143     KSqueezedTextLabel* m_label;
 144     StatusBarSpaceInfo* m_spaceInfo;
 145
 146     QSlider* m_zoomSlider;
 147
 148     QLabel* m_progressTextLabel;
 149     QProgressBar* m_progressBar;
 150     QToolButton* m_stopButton;
 151     int m_progress;
 152     QTimer* m_showProgressBarTimer;
 153
 154     QTimer* m_resetToDefaultTextTimer;
 155     QTime m_textTimestamp;
 156 };
 157
 158 #endif