The ProgressIndicator class lets an application display a progress indicator to show that a lengthy task is under way. More...

#include <ProgressIndicator.h>

Inherits QWidget.

Public Slots
void	startAnimation ()

void	stopAnimation ()

void	setAnimationDelay (int delay)

void	setDisplayedWhenStopped (bool state)

void	setColor (const QColor &color)

void	setPenColor (const QColor &color)

Public Member Functions
	ProgressIndicator (QWidget *parent=0)

int	animationDelay () const

bool	isAnimated () const

bool	isDisplayedWhenStopped () const

const QColor &	color () const

const QColor &	penColor () const

virtual QSize	sizeHint () const

int	heightForWidth (int w) const

Protected Member Functions
virtual void	timerEvent (QTimerEvent *event)

virtual void	paintEvent (QPaintEvent *event)

Properties
int	delay

bool	displayedWhenStopped

QColor	color

QColor	penColor

Detailed Description

The ProgressIndicator 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.

Based on QProgressIndicator 1.0.2 (http://qt-apps.org/content/show.php/QProgressIndicator?content=115762) by Morgan Leborgne (mojo2000)

See Also: QProgressBar

Definition at line 16 of file ProgressIndicator.h.

Constructor & Destructor Documentation

ProgressIndicator::ProgressIndicator ( QWidget * parent = 0 )

Definition at line 5 of file ProgressIndicator.cc.

         : QWidget(parent),
         m_angle(0),
         m_timerId(-1),
         m_delay(40),
         m_displayedWhenStopped(false),
         m_color(Qt::black),
         m_penColor(Qt::lightGray)
 {
     setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
     setFocusPolicy(Qt::NoFocus);
 }

Member Function Documentation

int ProgressIndicator::animationDelay ( ) const

inline

Returns the delay between animation steps.

Returns: The number of milliseconds between animation steps. By default, the animation delay is set to 40 milliseconds.

See Also: setAnimationDelay

Definition at line 30 of file ProgressIndicator.h.

30 { return m_delay; }

const QColor& ProgressIndicator::color ( ) const

inline

Returns the color of the component.

See Also: setColor

Definition at line 47 of file ProgressIndicator.h.

47 { return m_color; }

int ProgressIndicator::heightForWidth ( int w ) const

Definition at line 83 of file ProgressIndicator.cc.

 {
     return w;
 }

bool ProgressIndicator::isAnimated ( ) const

Returns a Boolean value indicating whether the component is currently animated.

Returns: Animation state.

See Also: startAnimation stopAnimation

Definition at line 18 of file ProgressIndicator.cc.

 {
     return (m_timerId != -1);
 }

bool ProgressIndicator::isDisplayedWhenStopped ( ) const

Returns a Boolean value indicating whether the receiver shows itself even when it is not animating.

Returns: Return true if the progress indicator shows itself even when it is not animating. By default, it returns false.

See Also: setDisplayedWhenStopped

Definition at line 30 of file ProgressIndicator.cc.

 {
     return m_displayedWhenStopped;
 }

void ProgressIndicator::paintEvent ( QPaintEvent * event )

protectedvirtual

Definition at line 95 of file ProgressIndicator.cc.

 {
     if (!m_displayedWhenStopped && !isAnimated())
         return;
 
     int width = qMin(this->width(), this->height());
     
     QPainter p(this);
     p.setRenderHint(QPainter::Antialiasing);
     
     int outerRadius = (width-1)*0.5;
     int innerRadius = (width-1)*0.5*0.38;
 
     int capsuleHeight = outerRadius - innerRadius;
     int capsuleWidth  = (width > 32 ) ? capsuleHeight *.23 : capsuleHeight *.35;
     int capsuleRadius = capsuleWidth/2;
 
     for (int i=0; i<12; i++)
     {
         QColor color = m_color;
         qreal alpha = 1.0f - (i/12.0f);
         color.setAlphaF(alpha);
         
         QColor penColor = m_penColor;
         penColor.setAlphaF(alpha);
         QPen pen;
         pen.setWidth(1);
         pen.setColor(penColor);
         p.setPen(pen);
         
         p.setBrush(color);       
         p.save();
         p.translate(rect().center());
         p.rotate(m_angle - i*30.0f);
         p.drawRoundedRect(-capsuleWidth*0.5, -(innerRadius+capsuleHeight), capsuleWidth, capsuleHeight, capsuleRadius, capsuleRadius);
         p.restore();
     }
 }

const QColor& ProgressIndicator::penColor ( ) const

inline

Returns the color of the outline of the component.

See Also: setColor

Definition at line 52 of file ProgressIndicator.h.

52 { return m_penColor; }

void ProgressIndicator::setAnimationDelay ( int delay )

slot

Sets the delay between animation steps. Setting the delay to a value larger than 40 slows the animation, while setting the delay to a smaller value speeds it up.

Parameters

delay The delay, in milliseconds.

See Also: animationDelay

Definition at line 53 of file ProgressIndicator.cc.

 {
     if (m_timerId != -1)
         killTimer(m_timerId);
 
     m_delay = delay;
 
     if (m_timerId != -1)
         m_timerId = startTimer(m_delay);
 }

void ProgressIndicator::setColor ( const QColor & color )

slot

Sets the color of the components to the given color.

See Also: color

Definition at line 64 of file ProgressIndicator.cc.

 {
     m_color = color;
 
     update();
 }

void ProgressIndicator::setDisplayedWhenStopped ( bool state )

slot

Sets whether the component hides itself when it is not animating.

Parameters

state The animation state. Set false to hide the progress indicator when it is not animating; otherwise true.

See Also: isDisplayedWhenStopped

Definition at line 23 of file ProgressIndicator.cc.

 {
     m_displayedWhenStopped = state;
 
     update();
 }

void ProgressIndicator::setPenColor ( const QColor & color )

slot

Sets the color of the pen (responsible for the outline of the components) to the given color.

See Also: color

Definition at line 71 of file ProgressIndicator.cc.

 {
     m_penColor = color;
 
     update();
 }

QSize ProgressIndicator::sizeHint ( ) const

virtual

Definition at line 78 of file ProgressIndicator.cc.

 {
     return QSize(20,20);
 }

void ProgressIndicator::startAnimation ( )

slot

Starts the spin animation.

See Also: stopAnimation isAnimated

Definition at line 35 of file ProgressIndicator.cc.

 {
     m_angle = 0;
 
     if (m_timerId == -1)
         m_timerId = startTimer(m_delay);
 }

void ProgressIndicator::stopAnimation ( )

slot

Stops the spin animation.

See Also: startAnimation isAnimated

Definition at line 43 of file ProgressIndicator.cc.

 {
     if (m_timerId != -1)
         killTimer(m_timerId);
 
     m_timerId = -1;
 
     update();
 }

void ProgressIndicator::timerEvent ( QTimerEvent * event )

protectedvirtual

Definition at line 88 of file ProgressIndicator.cc.

 {
     m_angle = (m_angle+30)%360;
 
     update();
 }

Property Documentation

QColor ProgressIndicator::color

readwrite

Definition at line 21 of file ProgressIndicator.h.

int ProgressIndicator::delay

readwrite

Definition at line 19 of file ProgressIndicator.h.

bool ProgressIndicator::displayedWhenStopped

readwrite

Definition at line 20 of file ProgressIndicator.h.

QColor ProgressIndicator::penColor

readwrite

Definition at line 22 of file ProgressIndicator.h.

The documentation for this class was generated from the following files:

/build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/progress_indicator/ProgressIndicator.h
/build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/progress_indicator/ProgressIndicator.cc

Public Slots

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation