Progress indicators are used to visualize graphically the current status of an operation. More...

Inheritance diagram for MProgressIndicator:

Collaboration diagram for MProgressIndicator:

Public Slots
void	reset ()
void	setMaximum (int maximum)
void	setMinimum (int minimum)
void	setRange (int minimum, int maximum)
void	setValue (int value)
void	setUnknownDuration (bool unknownDuration)
Signals
void	valueChanged (int value)
Public Member Functions
	MProgressIndicator (QGraphicsItem *parent=0, const QString &viewType=QString())
virtual	~MProgressIndicator ()
int	maximum () const
int	minimum () const
int	value () const
bool	unknownDuration () const
Static Public Attributes
static const MTheme::ViewType	spinnerType = "spinner"
static const MTheme::ViewType	barType = "bar"
Properties
int	minimum
int	maximum
int	value
bool	unknownDuration

Detailed Description

Progress indicators are used to visualize graphically the current status of an operation.

Overview

Progress indicator can have known or unknown duration.

Usage guidelines

For operations with known duration use progress indicator with known duration.
For operations with unknown duration use progress indicator with unknown duration.
Application design can decide whether to show progress indicator for the whole view (e.g. a web page in web browser) or for single items in the view separately (e.g. downloading online photos from Flickr web feed in Gallery).
Application can decide to display label indicating the state of the operation next to indicator such as "124 / 345 kt received." or "75%".
If the wait operation applies to the whole view, a spinner should be used to temporarily replace the view's application menu icon.

Variants

Examples

Here's how to create progress bar with fixed range. It also shows how to listen the value changed signal:

            MProgressIndicator* progressbar = new MProgressIndicator(parent, MProgressIndicator::barType);
            progressbar->setRange(0, 9);
            connect(progressbar, SIGNAL(valueChanged(int)), SLOT(valueChangedSlot(int)));

This is how to create spinner with unknown duration:

            MProgressIndicator* spinner = new MProgressIndicator(parent, MProgressIndicator::spinnerType);
            spinner->setUnknownDuration(true);

Open issues

How we can utilize device sensors together with progress indicators to create small WOW effects?
Progress indicator visualization can be generated procedurally using the device sensors, for example by tilting the device liquid/sand inside the progress indicator moves while the indicator still shows the current status of the operation. How to? Depends on the selected type of the indicator.
Operation duration + haptic feedback: after the indicator has been shown for long enough (current assumption: 8 seconds), a tacticon (=small vibra indicator) should be presented when the indicator goes away. This enables the user to turn his/her attention back on the device when it becomes usable again.

See also:: MProgressIndicatorModel MProgressIndicatorStyle

Definition at line 81 of file corelib/widgets/mprogressindicator.h.

Constructor & Destructor Documentation

MProgressIndicator::MProgressIndicator	(	QGraphicsItem *	parent = `0`,
		const QString &	viewType = `QString()`
	)			`[explicit]`

Constructs a progress indicator with a parent.

Parameters:

	parent	Parent widget
	viewType	Optional Associated view

Definition at line 52 of file mprogressindicator.cpp.

    : MWidgetController(new MProgressIndicatorPrivate, new MProgressIndicatorModel, parent)
{
    setViewType(viewType);
    Q_D(MProgressIndicator);

    d->init();
}

Here is the call graph for this function:

MProgressIndicator::~MProgressIndicator ( ) [virtual]

Destructor.

Definition at line 61 of file mprogressindicator.cpp.

{
}

Member Function Documentation

int MProgressIndicator::maximum ( ) const

Returns the maximum value of the progress indicator.

Returns:: Maximum value of the progress indicator

int MProgressIndicator::minimum ( ) const

Returns the minimum value of the progress indicator.

Returns:: Minimum value of the progress indicator

void MProgressIndicator::reset ( ) [slot]

Rewinds the indicator and stops unknown duration indicator.

Definition at line 66 of file mprogressindicator.cpp.

{
    setValue(minimum());
    setUnknownDuration(false);
}

Here is the call graph for this function:

void MProgressIndicator::setMaximum ( int maximum ) [slot]

Set the maximum value of the indicator.

Definition at line 111 of file mprogressindicator.cpp.

{
    setRange(qMin(minimum(), maximum), maximum);
}

Here is the call graph for this function:

void MProgressIndicator::setMinimum ( int minimum ) [slot]

Set the minimum value of the indicator.

Definition at line 99 of file mprogressindicator.cpp.

{
    setRange(minimum, qMax(maximum(), minimum));
}

Here is the call graph for this function:

void MProgressIndicator::setRange	(	int	minimum,
		int	maximum
	)			`[slot]`

Sets the progress bar's minimum and maximum values to minimum and maximum respectively. If maximum is smaller than minimum, minimum becomes the only legal value. If the current value falls outside the new range, the progress bar is reset with reset().

Definition at line 73 of file mprogressindicator.cpp.

{
    model()->setMinimum(minimum);
    model()->setMaximum(qMax(minimum, maximum));
    if (model()->value() < model()->minimum() || model()->value() > model()->maximum())
        reset();
}

Here is the call graph for this function:

void MProgressIndicator::setUnknownDuration ( bool unknownDuration ) [slot]

Sets whether the indicator is working in known duration / unknown duration mode.

Parameters:

run

True, to set the progress indicator to unknown duration mode

Definition at line 123 of file mprogressindicator.cpp.

{
    model()->setUnknownDuration(unknownDuration);
}

Here is the call graph for this function:

void MProgressIndicator::setValue ( int value ) [slot]

Set the value of the indicator. Attempting to change the current value to one outside the minimum-maximum range has no effect on the current value.

Parameters:

value

indicator value

Definition at line 81 of file mprogressindicator.cpp.

{
    if (model()->value() == value)
        return;

    if ((value > model()->maximum()) || (value < model()->minimum()))
        return;

    model()->setValue(value);
    emit valueChanged(value);
}

Here is the call graph for this function:

bool MProgressIndicator::unknownDuration ( ) const

Status of indicating progress with unknown duration.

Returns:: True, if indicator is running in unknown duration mode

int MProgressIndicator::value ( ) const

Returns the value of the progress indicator.

Returns:: Value of the progress indicator

void MProgressIndicator::valueChanged ( int value ) [signal]

Signal is emitted when the value of the indicator changes.

Member Data Documentation

MProgressIndicator::barType = "bar" [static]

View type for progress bar.

Definition at line 130 of file corelib/widgets/mprogressindicator.h.

MProgressIndicator::spinnerType = "spinner" [static]

View type for spinner.

Definition at line 125 of file corelib/widgets/mprogressindicator.h.

Property Documentation

MProgressIndicator::maximum [read, write]

This property holds the progress indicator's maximum value.

When setting this property, the minimum is adjusted if necessary to ensure that the range remains valid. If the current value falls outside the new range, the progress bar is reset with reset().

Definition at line 102 of file corelib/widgets/mprogressindicator.h.

MProgressIndicator::minimum [read, write]

This property holds the progress indicator's minimum value.

When setting this property, the maximum is adjusted if necessary to ensure that the range remains valid. If the current value falls outside the new range, the progress bar is reset with reset().

Definition at line 93 of file corelib/widgets/mprogressindicator.h.

MProgressIndicator::unknownDuration [read, write]

This property holds whether the progress indicator is type of known duration / unknown duration.

Definition at line 117 of file corelib/widgets/mprogressindicator.h.

MProgressIndicator::value [read, write]

This property holds the progress indicator's current value.

Attempting to change the current value to one outside the minimum-maximum range has no effect on the current value.

Definition at line 111 of file corelib/widgets/mprogressindicator.h.

MProgressIndicator Class Reference

Public Slots

Signals

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Overview

Usage guidelines

Variants

Examples

Open issues

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation