Changeset 55277 in vbox for trunk/src/VBox

Timestamp:

Apr 15, 2015 11:14:41 AM (10 years ago)

Author:

vboxsync

Message:

FE/Qt: Implementation of UIProgress (QObject wrapper for CProgress).

Location:

trunk/src/VBox/Frontends/VirtualBox/src/widgets

Files:

• UIProgressDialog.cpp (modified) (1 diff)
• UIProgressDialog.h (modified) (1 diff)

trunk/src/VBox/Frontends/VirtualBox/src/widgets/UIProgressDialog.cpp

@@ -328 +328 @@
 }
 
+
+UIProgress::UIProgress(CProgress &progress, QObject *pParent /* = 0 */)
+    : QObject(pParent)
+    , m_progress(progress)
+    , m_cOperations(m_progress.GetOperationCount())
+    , m_fEnded(false)
+{
+}
+
+void UIProgress::run(int iRefreshInterval)
+{
+    /* Make sure the CProgress still valid: */
+    if (!m_progress.isOk())
+        return;
+
+    /* Start the refresh timer: */
+    int id = startTimer(iRefreshInterval);
+
+    /* Create a local event-loop: */
+    {
+        QEventLoop eventLoop;
+        m_pEventLoop = &eventLoop;
+
+        /* Guard ourself for the case
+         * we destroyed ourself in our event-loop: */
+        QPointer<UIProgress> guard = this;
+
+        /* Start the blocking event-loop: */
+        eventLoop.exec();
+
+        /* Are we still valid? */
+        if (guard.isNull())
+            return;
+
+        m_pEventLoop = 0;
+    }
+
+    /* Kill the refresh timer: */
+    killTimer(id);
+}
+
+void UIProgress::timerEvent(QTimerEvent*)
+{
+    /* Make sure the UIProgress still 'running': */
+    if (m_fEnded)
+        return;
+
+    /* If progress had failed or finished: */
+    if (!m_progress.isOk() || m_progress.GetCompleted())
+    {
+        /* Exit from the event-loop if there is any: */
+        if (m_pEventLoop)
+            m_pEventLoop->exit();
+
+        /* Mark UIProgress as 'ended': */
+        m_fEnded = true;
+
+        /* Return early: */
+        return;
+    }
+
+    /* If CProgress was not yet canceled: */
+    if (!m_progress.GetCanceled())
+    {
+        /* Notify listeners about the operation progress update: */
+        emit sigProgressChange(m_cOperations, m_progress.GetOperationDescription(),
+                               m_progress.GetOperation() + 1, m_progress.GetPercent());
+    }
+}
+

trunk/src/VBox/Frontends/VirtualBox/src/widgets/UIProgressDialog.h

@@ -95 +95 @@
 };
 
+/** QObject reimplementation allowing to effectively track the CProgress object completion
+  * (w/o using CProgress::waitForCompletion() and w/o blocking the calling thread in any other way for too long).
+  * @note The CProgress instance is passed as a non-const reference to the constructor
+  *       (to memorize COM errors if they happen), and therefore must not be destroyed
+  *       before the created UIProgress instance is destroyed.
+  * @todo To be moved to separate files. */
+class UIProgress : public QObject
+{
+    Q_OBJECT;
+
+signals:
+
+    /** Notifies listeners about wrapped CProgress change.
+      * @param iOperations  holds the number of operations CProgress have,
+      * @param strOperation holds the description of the current CProgress operation,
+      * @param iOperation   holds the index of the current CProgress operation,
+      * @param iPercent     holds the percentage of the current CProgress operation. */
+    void sigProgressChange(ulong iOperations, QString strOperation,
+                           ulong iOperation, ulong iPercent);
+
+public:
+
+    /** Constructor passing @a pParent to the base-class.
+      * @param progress holds the CProgress to be wrapped. */
+    UIProgress(CProgress &progress, QObject *pParent = 0);
+
+    /** Starts the UIProgress by entering the personal event-loop.
+      * @param iRefreshInterval holds the refresh interval to check
+      *                         for the CProgress updates with. */
+    void run(int iRefreshInterval);
+
+private:
+
+    /** Timer @a pEvent reimplementation. */
+    virtual void timerEvent(QTimerEvent *pEvent);
+
+    /** Holds the wrapped CProgress reference. */
+    CProgress &m_progress;
+    /** Holds the number of operations wrapped CProgress have. */
+    const ulong m_cOperations;
+    /** Holds whether the UIProgress ended. */
+    bool m_fEnded;
+
+    /** Holds the personal event-loop. */
+    QPointer<QEventLoop> m_pEventLoop;
+};
+
 #endif /* __UIProgressDialog_h__ */