Changeset 90556 in vbox

Timestamp:

Aug 6, 2021 4:08:18 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

146162

Message:

FE/Qt: bugref:10067: New notification interfaces for downloader object and item.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/notificationcenter

Files:

• UINotificationObject.cpp (modified) (3 diffs)
• UINotificationObject.h (modified) (3 diffs)
• UINotificationObjectItem.cpp (modified) (2 diffs)
• UINotificationObjectItem.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/notificationcenter/UINotificationObject.cpp

@@ -17 +17 @@
 
 /* GUI includes: */
+#include "UIDownloader.h"
 #include "UINotificationObject.h"
 #include "UINotificationProgressTask.h"
@@ -78 +79 @@
         connect(m_pTask, &UIProgressTask::sigProgressFinished,
                 this, &UINotificationProgress::sltHandleProgressFinished);
+
+        /* And start it finally: */
+        m_pTask->start();
     }
-
-    /* And start it finally: */
-    m_pTask->start();
 }
 
@@ -104 +105 @@
     emit sigProgressFinished();
 }
+
+
+/*********************************************************************************************************************************
+*   Class UINotificationDownloader implementation.                                                                               *
+*********************************************************************************************************************************/
+
+UINotificationDownloader::UINotificationDownloader()
+{
+}
+
+UINotificationDownloader::~UINotificationDownloader()
+{
+    delete m_pDownloader;
+}
+
+ulong UINotificationDownloader::percent() const
+{
+    return m_uPercent;
+}
+
+QString UINotificationDownloader::error() const
+{
+    return m_strError;
+}
+
+void UINotificationDownloader::handle()
+{
+    /* Prepare downloader: */
+    m_pDownloader = createDownloader();
+    if (m_pDownloader)
+    {
+        connect(m_pDownloader, &UIDownloader::sigToStartAcknowledging,
+                this, &UINotificationDownloader::sigProgressStarted);
+        connect(m_pDownloader, &UIDownloader::sigToStartDownloading,
+                this, &UINotificationDownloader::sigProgressStarted);
+        connect(m_pDownloader, &UIDownloader::sigToStartVerifying,
+                this, &UINotificationDownloader::sigProgressStarted);
+        connect(m_pDownloader, &UIDownloader::sigProgressChange,
+                this, &UINotificationDownloader::sltHandleProgressChange);
+        connect(m_pDownloader, &UIDownloader::sigProgressFailed,
+                this, &UINotificationDownloader::sltHandleProgressFailed);
+        connect(m_pDownloader, &UIDownloader::sigProgressCanceled,
+                this, &UINotificationDownloader::sigProgressCanceled);
+        connect(m_pDownloader, &UIDownloader::sigProgressFinished,
+                this, &UINotificationDownloader::sigProgressFinished);
+        connect(m_pDownloader, &UIDownloader::destroyed,
+                this, &UINotificationDownloader::sigDownloaderDestroyed);
+
+        /* And start it finally: */
+        m_pDownloader->start();
+    }
+}
+
+void UINotificationDownloader::close()
+{
+    /* Cancel downloader: */
+    if (m_pDownloader)
+        m_pDownloader->cancel();
+    /* Call to base-class: */
+    UINotificationObject::close();
+}
+
+void UINotificationDownloader::sltHandleProgressChange(ulong uPercent)
+{
+    m_uPercent = uPercent;
+    emit sigProgressChange(uPercent);
+}
+
+void UINotificationDownloader::sltHandleProgressFailed(const QString &strError)
+{
+    m_strError = strError;
+    emit sigProgressFailed();
+}

trunk/src/VBox/Frontends/VirtualBox/src/notificationcenter/UINotificationObject.h

@@ -24 +24 @@
 /* Qt includes: */
 #include <QObject>
+#include <QPointer>
 
 /* GUI includes: */
@@ -32 +33 @@
 
 /* Forward declarations: */
+class UIDownloader;
 class UINotificationProgressTask;
 
@@ -119 +121 @@
 };
 
+/** UINotificationObject extension for notification-downloader. */
+class SHARED_LIBRARY_STUFF UINotificationDownloader : public UINotificationObject
+{
+    Q_OBJECT;
+
+signals:
+
+    /** Notifies listeners about progress started. */
+    void sigProgressStarted();
+    /** Notifies listeners about progress changed.
+      * @param  uPercent  Brings new progress percentage value. */
+    void sigProgressChange(ulong uPercent);
+    /** Notifies listeners about progress failed. */
+    void sigProgressFailed();
+    /** Notifies listeners about progress canceled. */
+    void sigProgressCanceled();
+    /** Notifies listeners about progress finished. */
+    void sigProgressFinished();
+
+    /** Notifies listeners about downloader destroyed. */
+    void sigDownloaderDestroyed();
+
+public:
+
+    /** Constructs notification-downloader. */
+    UINotificationDownloader();
+    /** Destructs notification-downloader. */
+    virtual ~UINotificationDownloader() /* override final */;
+
+    /** Creates and returns started downloader-wrapper. */
+    virtual UIDownloader *createDownloader() = 0;
+
+    /** Returns current progress percentage value. */
+    ulong percent() const;
+    /** Returns error-message if any. */
+    QString error() const;
+
+    /** Handles notification-object being added. */
+    virtual void handle() /* override final */;
+
+public slots:
+
+    /** Stops the downloader and notifies model about closing. */
+    virtual void close() /* override final */;
+
+private slots:
+
+    /** Handles signal about progress changed.
+      * @param  uPercent  Brings new progress percentage value. */
+    void sltHandleProgressChange(ulong uPercent);
+    /** Handles signal about progress failed.
+      * @param  strError  Brings error message if any. */
+    void sltHandleProgressFailed(const QString &strError);
+
+private:
+
+    /** Holds the instance of downloader being wrapped by this notification-downloader. */
+    QPointer<UIDownloader>  m_pDownloader;
+
+    /** Holds the last cached progress percentage value. */
+    ulong    m_uPercent;
+    /** Holds the error message is any. */
+    QString  m_strError;
+};
+
 #endif /* !FEQT_INCLUDED_SRC_notificationcenter_UINotificationObject_h */

trunk/src/VBox/Frontends/VirtualBox/src/notificationcenter/UINotificationObjectItem.cpp

@@ -273 +273 @@
 
 /*********************************************************************************************************************************
+*   Class UINotificationDownloaderItem implementation.                                                                           *
+*********************************************************************************************************************************/
+
+UINotificationDownloaderItem::UINotificationDownloaderItem(QWidget *pParent, UINotificationDownloader *pDownloader /* = 0 */)
+    : UINotificationObjectItem(pParent, pDownloader)
+    , m_pProgressBar(0)
+{
+    /* Main layout was prepared in base-class: */
+    if (m_pLayoutMain)
+    {
+        /* Name label was prepared in base-class: */
+        if (m_pLabelName)
+            m_pLabelName->setText(downloader()->name());
+        /* Details label was prepared in base-class: */
+        if (m_pLabelDetails)
+        {
+            int iHint = m_pLabelName->minimumSizeHint().width()
+                      + m_pLayoutUpper->spacing()
+                      + m_pButtonClose->minimumSizeHint().width();
+            m_pLabelDetails->setMinimumTextWidth(iHint);
+            updateDetails();
+        }
+
+        /* Prepare progress-bar: */
+        m_pProgressBar = new QProgressBar(this);
+        if (m_pProgressBar)
+        {
+            m_pProgressBar->setMinimum(0);
+            m_pProgressBar->setMaximum(100);
+            m_pProgressBar->setValue(downloader()->percent());
+
+            m_pLayoutMain->addWidget(m_pProgressBar);
+        }
+    }
+
+    /* Prepare downloader connections: */
+    connect(downloader(), &UINotificationDownloader::sigProgressStarted,
+            this, &UINotificationDownloaderItem::sltHandleProgressStarted);
+    connect(downloader(), &UINotificationDownloader::sigProgressChange,
+            this, &UINotificationDownloaderItem::sltHandleProgressChange);
+    connect(downloader(), &UINotificationDownloader::sigProgressFailed,
+            this, &UINotificationDownloaderItem::sltHandleProgressFinished);
+    connect(downloader(), &UINotificationDownloader::sigProgressCanceled,
+            this, &UINotificationDownloaderItem::sltHandleProgressFinished);
+    connect(downloader(), &UINotificationDownloader::sigProgressFinished,
+            this, &UINotificationDownloaderItem::sltHandleProgressFinished);
+}
+
+void UINotificationDownloaderItem::sltHandleProgressStarted()
+{
+    /* Init progress-bar state: */
+    if (m_pProgressBar)
+        m_pProgressBar->setValue(0);
+    /* Update details with fetched stuff if any: */
+    if (m_pLabelDetails)
+        updateDetails();
+}
+
+void UINotificationDownloaderItem::sltHandleProgressChange(ulong uPercent)
+{
+    /* Update progress-bar state: */
+    if (m_pProgressBar)
+        m_pProgressBar->setValue(uPercent);
+}
+
+void UINotificationDownloaderItem::sltHandleProgressFinished()
+{
+    /* Finalize progress-bar state: */
+    if (m_pProgressBar)
+        m_pProgressBar->setValue(100);
+    /* Update details with error text if any: */
+    if (m_pLabelDetails)
+        updateDetails();
+}
+
+UINotificationDownloader *UINotificationDownloaderItem::downloader() const
+{
+    return qobject_cast<UINotificationDownloader*>(m_pObject);
+}
+
+void UINotificationDownloaderItem::updateDetails()
+{
+    AssertPtrReturnVoid(m_pLabelDetails);
+    const QString strDetails = downloader()->details();
+    const QString strError = downloader()->error();
+    const QString strFullDetails = strError.isNull()
+                                 ? strDetails
+                                 : QString("%1<br>%2").arg(strDetails, strError);
+    m_pLabelDetails->setText(strFullDetails);
+    if (!strError.isEmpty())
+    {
+        m_fToggled = true;
+        m_pLabelDetails->setVisible(m_fToggled);
+    }
+}
+
+
+/*********************************************************************************************************************************
 *   Namespace UINotificationProgressItem implementation.                                                                         *
 *********************************************************************************************************************************/
@@ -281 +379 @@
     if (pObject->inherits("UINotificationProgress"))
         return new UINotificationProgressItem(pParent, static_cast<UINotificationProgress*>(pObject));
+    if (pObject->inherits("UINotificationDownloader"))
+        return new UINotificationDownloaderItem(pParent, static_cast<UINotificationDownloader*>(pObject));
     /* Handle defaults: */
     return new UINotificationObjectItem(pParent, pObject);

trunk/src/VBox/Frontends/VirtualBox/src/notificationcenter/UINotificationObjectItem.h

@@ -32 +32 @@
 class QIRichTextLabel;
 class QIToolButton;
+class UINotificationDownloader;
 class UINotificationObject;
 class UINotificationProgress;
@@ -109 +110 @@
 };
 
+/** UINotificationObjectItem extension for notification-downloader. */
+class UINotificationDownloaderItem : public UINotificationObjectItem
+{
+    Q_OBJECT;
+
+public:
+
+    /** Constructs notification-downloader item, passing @a pParent to the base-class.
+      * @param  pDownloader  Brings the notification-downloader this item created for. */
+    UINotificationDownloaderItem(QWidget *pParent, UINotificationDownloader *pDownloader = 0);
+
+protected:
+
+    /** Holds the progress-bar instance. */
+    QProgressBar *m_pProgressBar;
+
+private slots:
+
+    /** Handles signal about progress started. */
+    void sltHandleProgressStarted();
+    /** Handles signal about progress changed.
+      * @param  uPercent  Brings new progress percentage value. */
+    void sltHandleProgressChange(ulong uPercent);
+    /** Handles signal about progress finished. */
+    void sltHandleProgressFinished();
+
+private:
+
+    /** Holds the notification-downloader this item created for. */
+    UINotificationDownloader *downloader() const;
+
+    /** Updates details. */
+    void updateDetails();
+};
+
 /** Notification-object factory. */
 namespace UINotificationItem