QProgressIndicator Class Reference

#include <QProgressIndicator.h>

Inheritance diagram for QProgressIndicator:

Public Slots
void	setAnimationDelay (int delay)
void	setColor (const QColor &color)
void	setDisplayedWhenStopped (bool state)
void	startAnimation ()
void	stopAnimation ()

Public Member Functions
	QProgressIndicator (QWidget *parent=0)
int	animationDelay () const
const QColor &	color () const
int	heightForWidth (int w) const
bool	isAnimated () const
bool	isDisplayedWhenStopped () const
virtual QSize	sizeHint () const

Protected Member Functions
virtual void	paintEvent (QPaintEvent *event)
virtual void	timerEvent (QTimerEvent *event)

Properties
QColor	color
int	delay
bool	displayedWhenStopped

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 35 of file QProgressIndicator.h.

Constructor & Destructor Documentation

QProgressIndicator::QProgressIndicator ( QWidget *  parent = 0 )

explicit

Definition at line 26 of file QProgressIndicator.cpp.

Member Function Documentation

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 48 of file QProgressIndicator.h.

const QColor& QProgressIndicator::color ( ) const

inline

Returns the color of the component.

See also

setColor

Definition at line 65 of file QProgressIndicator.h.

int QProgressIndicator::heightForWidth

(

int

w

)

const

Definition at line 96 of file QProgressIndicator.cpp.

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 38 of file QProgressIndicator.cpp.

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 50 of file QProgressIndicator.cpp.

void QProgressIndicator::paintEvent ( QPaintEvent *  event )

protectedvirtual

Definition at line 108 of file QProgressIndicator.cpp.

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 73 of file QProgressIndicator.cpp.

void QProgressIndicator::setColor ( const QColor &  color )

slot

Sets the color of the components to the given color.

See also

color

Definition at line 84 of file QProgressIndicator.cpp.

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.

QSize QProgressIndicator::sizeHint ( ) const

virtual

Definition at line 91 of file QProgressIndicator.cpp.

void QProgressIndicator::startAnimation ( )

slot

Starts the spin animation.

See also

stopAnimation isAnimated

Definition at line 55 of file QProgressIndicator.cpp.

void QProgressIndicator::stopAnimation ( )

slot

Stops the spin animation.

See also

startAnimation isAnimated

Definition at line 63 of file QProgressIndicator.cpp.

void QProgressIndicator::timerEvent ( QTimerEvent *  event )

protectedvirtual

Definition at line 101 of file QProgressIndicator.cpp.

Property Documentation

QColor QProgressIndicator::color

readwrite

Definition at line 40 of file QProgressIndicator.h.

int QProgressIndicator::delay

readwrite

Definition at line 38 of file QProgressIndicator.h.

bool QProgressIndicator::displayedWhenStopped

readwrite

Definition at line 39 of file QProgressIndicator.h.

---

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

• QProgressIndicator.h
• QProgressIndicator.cpp