pqProgressWidget.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 pqProgressWidget_h
#define pqProgressWidget_h

#include <QScopedPointer>
#include <QWidget>

#include "pqWidgetsModule.h"

class QToolButton;
class pqProgressWidgetLabel;

class PQWIDGETS_EXPORT pqProgressWidget : public QWidget
{
  Q_OBJECT;
  typedef QWidget Superclass;
  Q_PROPERTY(QString readyText READ readyText WRITE setReadyText)
  Q_PROPERTY(QString busyText READ busyText WRITE setBusyText)
public:
  pqProgressWidget(QWidget* parent = nullptr);
  ~pqProgressWidget() override;

  QToolButton* getAbortButton() const { return this->AbortButton; }

  QToolButton* abortButton() const { return this->AbortButton; }


  void setReadyText(const QString&);
  const QString& readyText() const { return this->ReadyText; }


  void setBusyText(const QString&);
  const QString& busyText() const { return this->BusyText; }

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void setProgress(const QString& message, int value);

  void enableProgress(bool enabled);

  void enableAbort(bool enabled);

Q_SIGNALS:
  void abortPressed();

protected:
  pqProgressWidgetLabel* ProgressBar;
  QToolButton* AbortButton;

  void updateUI();

private:
  Q_DISABLE_COPY(pqProgressWidget);
  QString ReadyText;
  QString BusyText;
};

#endif