pqProgressManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqProgressManager_h
#define pqProgressManager_h

#include "pqCoreModule.h"
#include <QList>
#include <QObject>
#include <QPointer>

class vtkObject;
class pqServer;
class PQCORE_EXPORT pqProgressManager : public QObject
{
  Q_OBJECT
public:
  pqProgressManager(QObject* parent = nullptr);
  ~pqProgressManager() override;

  void lockProgress(QObject* object);

  void unlockProgress(QObject* object);

  bool isLocked() const;

  void addNonBlockableObject(QObject* o) { this->NonBlockableObjects.push_back(o); }
  void removeNonBlockableObject(QObject* o) { this->NonBlockableObjects.removeAll(o); }

  const QList<QPointer<QObject>>& nonBlockableObjects() const { return this->NonBlockableObjects; }

protected:
  bool eventFilter(QObject* obj, QEvent* event) override;

public Q_SLOTS:
  void setProgress(const QString& message, int progress, bool processEvents = false);

  void setEnableProgress(bool);

  void beginProgress() { this->setEnableProgress(true); }
  void endProgress() { this->setEnableProgress(false); }

  void setEnableAbort(bool);

  void triggerAbort();

  bool unblockEvents(bool val);

Q_SIGNALS:

  void progress(const QString& message, int progress);

  void enableProgress(bool);

  void enableAbort(bool);

  void progressStartEvent();
  void progressEndEvent();

protected Q_SLOTS:
  void onStartProgress();
  void onEndProgress();
  void onProgress(vtkObject*);
  void onServerAdded(pqServer*);

protected: // NOLINT(readability-redundant-access-specifiers)
  QPointer<QObject> Lock;
  QList<QPointer<QObject>> NonBlockableObjects;
  int ProgressCount;
  bool InUpdate; // used to avoid recursive updates.

  bool EnableProgress;
  bool ReadyEnableProgress;
  bool UnblockEvents;

private:
  Q_DISABLE_COPY(pqProgressManager)

  QList<QWidget*> EnabledWidgetsForAbort;
  bool AbortEnabled = false;
};

#endif