src/statusbar/statusbarspaceinfo.h

   1 /*
   2  * SPDX-FileCopyrightText: 2006 Peter Penz (peter.penz@gmx.at) and Patrice Tremblay
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6 #ifndef STATUSBARSPACEINFO_H
   7 #define STATUSBARSPACEINFO_H
   8
   9 #include <KMessageWidget>
  10
  11 #include <QUrl>
  12 #include <QWidget>
  13
  14 class QHideEvent;
  15 class QShowEvent;
  16 class QMenu;
  17 class QMouseEvent;
  18 class QToolButton;
  19 class QWidgetAction;
  20
  21 class KCapacityBar;
  22
  23 class SpaceInfoObserver;
  24
  25 /**
  26  * @short Shows the available space for the volume represented
  27  *        by the given URL as part of the status bar.
  28  */
  29 class StatusBarSpaceInfo : public QWidget
  30 {
  31     Q_OBJECT
  32
  33 public:
  34     explicit StatusBarSpaceInfo(QWidget *parent = nullptr);
  35     ~StatusBarSpaceInfo() override;
  36
  37     /**
  38      * Use this to set the widget visibility as it can hide itself
  39      */
  40     void setShown(bool);
  41     void setUrl(const QUrl &url);
  42     QUrl url() const;
  43
  44     void update();
  45
  46 Q_SIGNALS:
  47     /**
  48      * Requests for @p message with the given @p messageType to be shown to the user in a non-modal way.
  49      */
  50     void showMessage(const QString &message, KMessageWidget::MessageType messageType);
  51
  52     /**
  53      * Requests for a progress update to be shown to the user in a non-modal way.
  54      * @param currentlyRunningTaskTitle     The task that is currently progressing.
  55      * @param installationProgressPercent   The current percentage of completion.
  56      */
  57     void showInstallationProgress(const QString &currentlyRunningTaskTitle, int installationProgressPercent);
  58
  59 protected:
  60     void showEvent(QShowEvent *event) override;
  61     void hideEvent(QHideEvent *event) override;
  62     QSize minimumSizeHint() const override;
  63
  64     void updateMenu();
  65
  66 private Q_SLOTS:
  67     /**
  68      * Asynchronously starts a Filelight installation using DolphinPackageInstaller. @see DolphinPackageInstaller.
  69      * Installation success or failure is reported through showMessage(). @see StatusBarSpaceInfo::showMessage().
  70      * Installation progress is reported through showInstallationProgress(). @see StatusBarSpaceInfo::showInstallationProgress().
  71      */
  72     void slotInstallFilelightButtonClicked();
  73
  74     void slotValuesChanged();
  75
  76 private:
  77     /**
  78      * Creates a new QWidgetAction that contains a UI to install Filelight.
  79      * m_installFilelightWidgetAction is initialised after calling this method once.
  80      */
  81     void initialiseInstallFilelightWidgetAction();
  82
  83 private:
  84     QScopedPointer<SpaceInfoObserver> m_observer;
  85     KCapacityBar *m_capacityBar;
  86     QToolButton *m_textInfoButton;
  87     QMenu *m_buttonMenu;
  88     /** An action containing a UI to install Filelight. */
  89     QWidgetAction *m_installFilelightWidgetAction;
  90     QUrl m_url;
  91     bool m_ready;
  92     bool m_shown;
  93 };
  94
  95 #endif