diff options
| author | KyleMiles <krm504@nyu.edu> | 2022-01-27 22:43:28 -0500 |
|---|---|---|
| committer | KyleMiles <krm504@nyu.edu> | 2022-01-28 00:24:06 -0500 |
| commit | 6812c973c9fa9b4ad642ab81856c05f87bd6fcc4 (patch) | |
| tree | dace4156d03148bcaf02df138ab4e0d93e61bc6f /ui/progressindicator.h | |
| parent | 519c9db22367f2659d1a54599fab47e6313be06e (diff) | |
Format All Files
Diffstat (limited to 'ui/progressindicator.h')
| -rw-r--r-- | ui/progressindicator.h | 148 |
1 files changed, 76 insertions, 72 deletions
diff --git a/ui/progressindicator.h b/ui/progressindicator.h index 56976f31..2e2829e9 100644 --- a/ui/progressindicator.h +++ b/ui/progressindicator.h @@ -27,104 +27,108 @@ /*! \class QProgressIndicator - \brief The QProgressIndicator class lets an application display a progress indicator to show that a lengthy task is under way. + \brief The QProgressIndicator class lets an application display a progress indicator to show that a lengthy task is + under way. Progress indicators are indeterminate and do nothing more than spin to show that the application is busy. \sa QProgressBar */ class BINARYNINJAUIAPI QProgressIndicator : public QWidget { - Q_OBJECT - Q_PROPERTY(int delay READ animationDelay WRITE setAnimationDelay) - Q_PROPERTY(bool displayedWhenStopped READ isDisplayedWhenStopped WRITE setDisplayedWhenStopped) - Q_PROPERTY(QColor color READ color WRITE setColor) - int m_width = 18; + Q_OBJECT + Q_PROPERTY(int delay READ animationDelay WRITE setAnimationDelay) + Q_PROPERTY(bool displayedWhenStopped READ isDisplayedWhenStopped WRITE setDisplayedWhenStopped) + Q_PROPERTY(QColor color READ color WRITE setColor) + int m_width = 18; -public: - QProgressIndicator(QWidget* parent = 0); + public: + QProgressIndicator(QWidget* parent = 0); - /*! Returns the delay between animation steps. - \return The number of milliseconds between animation steps. By default, the animation delay is set to 40 milliseconds. - \sa setAnimationDelay - */ - int animationDelay() const { return m_delay; } + /*! Returns the delay between animation steps. + \return The number of milliseconds between animation steps. By default, the animation delay is set to 40 + milliseconds. \sa setAnimationDelay + */ + int animationDelay() const { return m_delay; } - /*! Returns a Boolean value indicating whether the component is currently animated. - \return Animation state. - \sa startAnimation stopAnimation - */ - bool isAnimated () const; + /*! Returns a Boolean value indicating whether the component is currently animated. + \return Animation state. + \sa startAnimation stopAnimation + */ + bool isAnimated() const; - /*! Returns a Boolean value indicating whether the receiver shows itself even when it is not animating. - \return Return true if the progress indicator shows itself even when it is not animating. By default, it returns false. - \sa setDisplayedWhenStopped - */ - bool isDisplayedWhenStopped() const; + /*! Returns a Boolean value indicating whether the receiver shows itself even when it is not animating. + \return Return true if the progress indicator shows itself even when it is not animating. By default, it returns + false. \sa setDisplayedWhenStopped + */ + bool isDisplayedWhenStopped() const; - /*! Returns the color of the component. - \sa setColor - */ - const QColor & color() const { return m_color; } + /*! Returns the color of the component. + \sa setColor + */ + const QColor& color() const { return m_color; } - QSize sizeHint() const override { return QSize(m_width, m_width); }; - void setWidth(int width) { m_width = width; }; - int heightForWidth(int w) const override; -public Q_SLOTS: - /*! Starts the spin animation. - \sa stopAnimation isAnimated - */ - void startAnimation(); + QSize sizeHint() const override { return QSize(m_width, m_width); }; + void setWidth(int width) { m_width = width; }; + int heightForWidth(int w) const override; + public Q_SLOTS: + /*! Starts the spin animation. + \sa stopAnimation isAnimated + */ + void startAnimation(); - /*! Stops the spin animation. - \sa startAnimation isAnimated - */ - void stopAnimation(); + /*! Stops the spin animation. + \sa startAnimation isAnimated + */ + void stopAnimation(); - /*! Sets the delay between animation steps. - Setting the \a delay to a value larger than 40 slows the animation, while setting the \a delay to a smaller value speeds it up. - \param delay The delay, in milliseconds. - \sa animationDelay - */ - void setAnimationDelay(int delay); + /*! Sets the delay between animation steps. + Setting the \a delay to a value larger than 40 slows the animation, while setting the \a delay to a smaller + value speeds it up. \param delay The delay, in milliseconds. \sa animationDelay + */ + void setAnimationDelay(int delay); - /*! Sets whether the component hides itself when it is not animating. - \param state The animation state. Set false to hide the progress indicator when it is not animating; otherwise true. - \sa isDisplayedWhenStopped - */ - void setDisplayedWhenStopped(bool state, const QString& staticDisplay = ""); + /*! Sets whether the component hides itself when it is not animating. + \param state The animation state. Set false to hide the progress indicator when it is not animating; otherwise + true. \sa isDisplayedWhenStopped + */ + void setDisplayedWhenStopped(bool state, const QString& staticDisplay = ""); - void setToolTips(const QString& staticToolTip, const QString& animatedToolTip); + void setToolTips(const QString& staticToolTip, const QString& animatedToolTip); - /*! Sets the color of the components to the given color. - \sa color - */ - void setColor(const QColor & color); + /*! Sets the color of the components to the given color. + \sa color + */ + void setColor(const QColor& color); -Q_SIGNALS: + Q_SIGNALS: void clicked(); -protected: + protected: #if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) void enterEvent(QEvent* event) override; #else void enterEvent(QEnterEvent* event) override; #endif void leaveEvent(QEvent* event) override; - void mouseReleaseEvent(QMouseEvent* event) override { if (event->button() == Qt::LeftButton) Q_EMIT clicked(); } - void timerEvent(QTimerEvent * event) override; - void paintEvent(QPaintEvent * event) override; + void mouseReleaseEvent(QMouseEvent* event) override + { + if (event->button() == Qt::LeftButton) + Q_EMIT clicked(); + } + void timerEvent(QTimerEvent* event) override; + void paintEvent(QPaintEvent* event) override; -private: - int m_angle; - int m_timerId; - int m_delay; - bool m_displayedWhenStopped; - QString m_staticDisplay; - bool m_useAutoToolTips = false; - QString m_staticToolTip; - QString m_animatedToolTip; - QColor m_color; - bool m_activeHover = false; + private: + int m_angle; + int m_timerId; + int m_delay; + bool m_displayedWhenStopped; + QString m_staticDisplay; + bool m_useAutoToolTips = false; + QString m_staticToolTip; + QString m_animatedToolTip; + QColor m_color; + bool m_activeHover = false; }; -#endif // QPROGRESSINDICATOR_H +#endif // QPROGRESSINDICATOR_H |
