QProgressIndicator Class Reference

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

#include <qprogressindicator.h>

Inheritance diagram for QProgressIndicator:

Collaboration diagram for QProgressIndicator:

Public Slots
void	startAnimation ()
	Starts the spin animation.
void	stopAnimation ()
	Stops the spin animation.
void	setAnimationDelay (int delay)
	Sets the delay between animation steps.
void	setDisplayedWhenStopped (bool state)
	Sets whether the component hides itself when it is not animating.
void	setColor (const QColor &color)
	Sets the color of the components to the given color.

Public Member Functions
	QProgressIndicator (QWidget *parent=0)
	QProgressIndicator::QProgressIndicator constructor.
int	animationDelay () const
	Returns the delay between animation steps.
bool	isAnimated () const
	Returns a Boolean value indicating whether the component is currently animated.
bool	isDisplayedWhenStopped () const
	Returns a Boolean value indicating whether the receiver shows itself even when it is not animating.
const QColor &	color () const
	Returns the color of the component.
virtual QSize	sizeHint () const
	QProgressIndicator::sizeHint default minimum size.
int	heightForWidth (int w) const
	QProgressIndicator::heightForWidth square ratio.

Protected Member Functions
virtual void	timerEvent (QTimerEvent *event)
	QProgressIndicator::timerEvent do the actual animation.
virtual void	paintEvent (QPaintEvent *event)
	QProgressIndicator::paintEvent draw the spinner.

Detailed Description

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.

See also

QProgressBar

Definition at line 43 of file qprogressindicator.h.

Constructor & Destructor Documentation

QProgressIndicator()

QProgressIndicator::QProgressIndicator ( QWidget *  parent = 0 )

explicit

QProgressIndicator::QProgressIndicator constructor.

Parameters

parent

widget the indicator is placed in.

Definition at line 34 of file qprogressindicator.cpp.

Member Function Documentation

animationDelay()

int QProgressIndicator::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 53 of file qprogressindicator.h.

color()

const QColor & QProgressIndicator::color ( ) const

inline

Returns the color of the component.

See also

setColor

Definition at line 73 of file qprogressindicator.h.

Here is the caller graph for this function:

heightForWidth()

int QProgressIndicator::heightForWidth

(

int

w

)

const

QProgressIndicator::heightForWidth square ratio.

Parameters

w	requested width

Returns

w returned height

Definition at line 96 of file qprogressindicator.cpp.

isAnimated()

bool QProgressIndicator::isAnimated

(

)

const

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

Returns

Animation state.

See also

startAnimation stopAnimation

Definition at line 41 of file qprogressindicator.cpp.

Here is the caller graph for this function:

isDisplayedWhenStopped()

bool QProgressIndicator::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 49 of file qprogressindicator.cpp.

paintEvent()

void QProgressIndicator::paintEvent ( QPaintEvent *  event )

protectedvirtual

QProgressIndicator::paintEvent draw the spinner.

Definition at line 110 of file qprogressindicator.cpp.

Here is the call graph for this function:

setAnimationDelay

void QProgressIndicator::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 69 of file qprogressindicator.cpp.

setColor

void QProgressIndicator::setColor ( const QColor &  color )

slot

Sets the color of the components to the given color.

See also

color

Definition at line 79 of file qprogressindicator.cpp.

Here is the call graph for this function:

setDisplayedWhenStopped

void QProgressIndicator::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 43 of file qprogressindicator.cpp.

sizeHint()

QSize QProgressIndicator::sizeHint ( ) const

virtual

QProgressIndicator::sizeHint default minimum size.

Returns

QSize(20, 20)

Definition at line 89 of file qprogressindicator.cpp.

startAnimation

void QProgressIndicator::startAnimation ( )

slot

Starts the spin animation.

See also

stopAnimation isAnimated

Definition at line 53 of file qprogressindicator.cpp.

stopAnimation

void QProgressIndicator::stopAnimation ( )

slot

Stops the spin animation.

See also

startAnimation isAnimated

Definition at line 60 of file qprogressindicator.cpp.

timerEvent()

void QProgressIndicator::timerEvent ( QTimerEvent *  event )

protectedvirtual

QProgressIndicator::timerEvent do the actual animation.

Definition at line 101 of file qprogressindicator.cpp.

---

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

• src/qprogressindicator.h
• src/qprogressindicator.cpp