qprogressindicator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2016 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
/*
 * This code is based on https://github.com/mojocorp/QProgressIndicator
 * and published under
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2011 Morgan Leborgne
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef SRC_QPROGRESSINDICATOR_H_
#define SRC_QPROGRESSINDICATOR_H_
 
#include <QColor>
#include <QWidget>
 
class QProgressIndicator : public QWidget {
  Q_OBJECT
public:
  explicit QProgressIndicator(QWidget *parent = 0);
 
  [[nodiscard]] auto animationDelay() const -> int { return m_delay; }
 
  [[nodiscard]] auto isAnimated() const -> bool;
 
  [[nodiscard]] auto isDisplayedWhenStopped() const -> bool;
 
  [[nodiscard]] auto color() const -> const QColor & { return m_color; }
 
  [[nodiscard]] virtual auto sizeHint() const -> QSize;
  [[nodiscard]] auto heightForWidth(int w) const -> int;
 
public slots:
  void startAnimation();
 
  void stopAnimation();
 
  void setAnimationDelay(int delay);
 
  void setDisplayedWhenStopped(bool state);
 
  void setColor(const QColor &color);
 
protected:
  virtual void timerEvent(QTimerEvent *event);
  virtual void paintEvent(QPaintEvent *event);
 
private:
  int m_angle;
  int m_timerId;
  int m_delay;
  bool m_displayedWhenStopped;
  QColor m_color;
};
 
#endif // SRC_QPROGRESSINDICATOR_H_