diff Utils/ProgressEvent.h @ 1:0b3630a29ad8

Initial version based on previous repository. Project was ported to QT6 and in now cmake based.
author Ideenmodellierer <tiefenrauscher@web.de>
date Thu, 27 Nov 2025 18:40:28 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Utils/ProgressEvent.h	Thu Nov 27 18:40:28 2025 +0100
@@ -0,0 +1,87 @@
+/////////////////////////////////////////////////////////////////////////////
+/// \file   ProgressEvent.h
+/// \brief  User event to pass async progress-bar updates to the main window.
+/// \author JD Gascuel.
+/// \copyright (c) 2015 JD Gascuel. All rights reserved.
+/// $Id$
+///////////////////////////////////////////////////////////////////////////////
+//
+// BSD 2-Clause License:
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions
+// are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+//    this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+//    this list of conditions and the following disclaimer in the documentation
+//    and/or other materials provided with the distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+// THE POSSIBILITY OF SUCH DAMAGE.
+//
+//////////////////////////////////////////////////////////////////////////////
+// HISTORY
+//  2015-07-14  jDG: Creation.
+//  2016-05-24  jDG: BSD-2 version.
+
+#ifndef PROGRESS_EVENT_H
+#define PROGRESS_EVENT_H
+
+#include <QEvent>
+
+///////////////////////////////////////////////////////////////////////////////
+
+class ProgressEvent : public QEvent
+{
+    static QEvent::Type _logEventType;
+
+    ProgressEvent(int current, int maximum);
+
+public:
+    const int current;
+    const int maximum;
+
+    static ProgressEvent* make(int current, int maximum);
+};
+
+///////////////////////////////////////////////////////////////////////////////
+
+class  ProgressManager
+{
+    QObject* _main;
+
+public:
+    static ProgressManager* getInstance();
+
+    ProgressManager();
+
+    /// \brief Define who manage ProgressEvent events.
+    void setMainWindow(QObject* main);
+
+    /// \brief Send (async) progress updates to the main progress bar.
+    /// Use ProgressEvent class to post updates and resets to the progress
+    /// bar, displayed by the main thread.
+    /// When \a current > \a range, this is a reset...
+    void post(int current = 101, int range = 100);
+};
+
+#define PROGRESS(current, range) \
+    ProgressManager::getInstance()->post(current, range)
+#define PROGRESS_THROTTLE() \
+    ProgressManager::getInstance()->post(0, 0)
+#define PROGRESS_RESET() \
+    ProgressManager::getInstance()->post()
+
+#endif // PROGRESS_EVENT_H