You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
409 lines
11 KiB
409 lines
11 KiB
/****************************************************************************
|
|
**
|
|
** Implementation of QProgressBar class
|
|
**
|
|
** Created : 970521
|
|
**
|
|
** Copyright (C) 1992-2008 Trolltech ASA. All rights reserved.
|
|
**
|
|
** This file is part of the widgets module of the Qt GUI Toolkit.
|
|
**
|
|
** This file may be used under the terms of the GNU General
|
|
** Public License versions 2.0 or 3.0 as published by the Free
|
|
** Software Foundation and appearing in the files LICENSE.GPL2
|
|
** and LICENSE.GPL3 included in the packaging of this file.
|
|
** Alternatively you may (at your option) use any later version
|
|
** of the GNU General Public License if such license has been
|
|
** publicly approved by Trolltech ASA (or its successors, if any)
|
|
** and the KDE Free Qt Foundation.
|
|
**
|
|
** Please review the following information to ensure GNU General
|
|
** Public Licensing requirements will be met:
|
|
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
|
|
** If you are unsure which license is appropriate for your use, please
|
|
** review the following information:
|
|
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
|
|
** or contact the sales department at sales@trolltech.com.
|
|
**
|
|
** This file may be used under the terms of the Q Public License as
|
|
** defined by Trolltech ASA and appearing in the file LICENSE.QPL
|
|
** included in the packaging of this file. Licensees holding valid Qt
|
|
** Commercial licenses may use this file in accordance with the Qt
|
|
** Commercial License Agreement provided with the Software.
|
|
**
|
|
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
|
|
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
|
|
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
|
|
** herein.
|
|
**
|
|
**********************************************************************/
|
|
|
|
#include "qprogressbar.h"
|
|
#ifndef QT_NO_PROGRESSBAR
|
|
#include "qpainter.h"
|
|
#include "qdrawutil.h"
|
|
#include "qpixmap.h"
|
|
#include "qstyle.h"
|
|
#include "../kernel/qinternal_p.h"
|
|
#if defined(QT_ACCESSIBILITY_SUPPORT)
|
|
#include "qaccessible.h"
|
|
#endif
|
|
#include <limits.h>
|
|
|
|
/*!
|
|
\class QProgressBar qprogressbar.h
|
|
\brief The QProgressBar widget provides a horizontal progress bar.
|
|
|
|
\ingroup advanced
|
|
\mainclass
|
|
|
|
A progress bar is used to give the user an indication of the
|
|
progress of an operation and to reassure them that the application
|
|
is still running.
|
|
|
|
The progress bar uses the concept of \e steps; you give it the
|
|
total number of steps and the number of steps completed so far and
|
|
it will display the percentage of steps that have been completed.
|
|
You can specify the total number of steps in the constructor or
|
|
later with setTotalSteps(). The current number of steps is set
|
|
with setProgress(). The progress bar can be rewound to the
|
|
beginning with reset().
|
|
|
|
If the total is given as 0 the progress bar shows a busy indicator
|
|
instead of a percentage of steps. This is useful, for example,
|
|
when using QFtp or QHttp to download items when they are unable to
|
|
determine the size of the item being downloaded.
|
|
|
|
\sa QProgressDialog
|
|
|
|
<img src=qprogbar-m.png> <img src=qprogbar-w.png>
|
|
|
|
\sa QProgressDialog
|
|
\link guibooks.html#fowler GUI Design Handbook: Progress Indicator\endlink
|
|
*/
|
|
|
|
|
|
/*!
|
|
Constructs a progress bar.
|
|
|
|
The total number of steps is set to 100 by default.
|
|
|
|
The \a parent, \a name and widget flags, \a f, are passed on to
|
|
the QFrame::QFrame() constructor.
|
|
|
|
\sa setTotalSteps()
|
|
*/
|
|
|
|
QProgressBar::QProgressBar( QWidget *parent, const char *name, WFlags f )
|
|
: QFrame( parent, name, f | WNoAutoErase ),
|
|
total_steps( 100 ),
|
|
progress_val( -1 ),
|
|
percentage( -1 ),
|
|
center_indicator( TRUE ),
|
|
auto_indicator( TRUE ),
|
|
percentage_visible( TRUE ),
|
|
d( 0 )
|
|
{
|
|
setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) );
|
|
initFrame();
|
|
}
|
|
|
|
|
|
/*!
|
|
Constructs a progress bar.
|
|
|
|
The \a totalSteps is the total number of steps that need to be
|
|
completed for the operation which this progress bar represents.
|
|
For example, if the operation is to examine 50 files, this value
|
|
would be 50. Before examining the first file, call setProgress(0);
|
|
call setProgress(50) after examining the last file.
|
|
|
|
The \a parent, \a name and widget flags, \a f, are passed to the
|
|
QFrame::QFrame() constructor.
|
|
|
|
\sa setTotalSteps(), setProgress()
|
|
*/
|
|
|
|
QProgressBar::QProgressBar( int totalSteps,
|
|
QWidget *parent, const char *name, WFlags f )
|
|
: QFrame( parent, name, f | WNoAutoErase ),
|
|
total_steps( totalSteps ),
|
|
progress_val( -1 ),
|
|
percentage( -1 ),
|
|
center_indicator( TRUE ),
|
|
auto_indicator( TRUE ),
|
|
percentage_visible( TRUE ),
|
|
d( 0 )
|
|
{
|
|
setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) );
|
|
initFrame();
|
|
}
|
|
|
|
|
|
/*!
|
|
Reset the progress bar. The progress bar "rewinds" and shows no
|
|
progress.
|
|
*/
|
|
|
|
void QProgressBar::reset()
|
|
{
|
|
progress_val = -1;
|
|
percentage = -1;
|
|
setIndicator(progress_str, progress_val, total_steps);
|
|
repaint( FALSE );
|
|
}
|
|
|
|
|
|
/*!
|
|
\property QProgressBar::totalSteps
|
|
\brief The total number of steps.
|
|
|
|
If totalSteps is 0, the progress bar will display a busy
|
|
indicator.
|
|
|
|
\sa totalSteps()
|
|
*/
|
|
|
|
void QProgressBar::setTotalSteps( int totalSteps )
|
|
{
|
|
total_steps = totalSteps;
|
|
|
|
// Current progress is invalid if larger than total
|
|
if ( total_steps < progress_val )
|
|
progress_val = -1;
|
|
|
|
if ( isVisible() &&
|
|
( setIndicator(progress_str, progress_val, total_steps) || !total_steps ) )
|
|
repaint( FALSE );
|
|
}
|
|
|
|
|
|
/*!
|
|
\property QProgressBar::progress
|
|
\brief The current amount of progress
|
|
|
|
This property is -1 if progress counting has not started.
|
|
*/
|
|
|
|
void QProgressBar::setProgress( int progress )
|
|
{
|
|
if ( progress == progress_val ||
|
|
progress < 0 || ( ( progress > total_steps ) && total_steps ) )
|
|
return;
|
|
|
|
progress_val = progress;
|
|
|
|
setIndicator( progress_str, progress_val, total_steps );
|
|
|
|
repaint( FALSE );
|
|
|
|
#if defined(QT_ACCESSIBILITY_SUPPORT)
|
|
QAccessible::updateAccessibility( this, 0, QAccessible::ValueChanged );
|
|
#endif
|
|
}
|
|
|
|
/*!
|
|
\overload
|
|
|
|
Sets the amount of progress to \a progress and the total number of
|
|
steps to \a totalSteps.
|
|
|
|
\sa setTotalSteps()
|
|
*/
|
|
|
|
void QProgressBar::setProgress( int progress, int totalSteps )
|
|
{
|
|
if ( total_steps != totalSteps )
|
|
setTotalSteps( totalSteps );
|
|
setProgress( progress );
|
|
}
|
|
|
|
/*!
|
|
\property QProgressBar::progressString
|
|
\brief the amount of progress as a string
|
|
|
|
This property is QString::null if progress counting has not started.
|
|
*/
|
|
|
|
|
|
/*!
|
|
\reimp
|
|
*/
|
|
QSize QProgressBar::sizeHint() const
|
|
{
|
|
constPolish();
|
|
QFontMetrics fm = fontMetrics();
|
|
int cw = style().pixelMetric(QStyle::PM_ProgressBarChunkWidth, this);
|
|
return style().sizeFromContents(QStyle::CT_ProgressBar, this,
|
|
QSize( cw * 7 + fm.width( '0' ) * 4,
|
|
fm.height() + 8));
|
|
}
|
|
|
|
|
|
/*!
|
|
\reimp
|
|
*/
|
|
QSize QProgressBar::minimumSizeHint() const
|
|
{
|
|
return sizeHint();
|
|
}
|
|
|
|
/*!
|
|
\property QProgressBar::centerIndicator
|
|
\brief whether the indicator string should be centered
|
|
|
|
Changing this property sets \l QProgressBar::indicatorFollowsStyle
|
|
to FALSE. The default is TRUE.
|
|
*/
|
|
|
|
void QProgressBar::setCenterIndicator( bool on )
|
|
{
|
|
if ( !auto_indicator && on == center_indicator )
|
|
return;
|
|
auto_indicator = FALSE;
|
|
center_indicator = on;
|
|
repaint( FALSE );
|
|
}
|
|
|
|
/*!
|
|
\property QProgressBar::indicatorFollowsStyle
|
|
\brief whether the display of the indicator string should follow the GUI style
|
|
|
|
The default is TRUE.
|
|
|
|
\sa centerIndicator
|
|
*/
|
|
|
|
void QProgressBar::setIndicatorFollowsStyle( bool on )
|
|
{
|
|
if ( on == auto_indicator )
|
|
return;
|
|
auto_indicator = on;
|
|
repaint( FALSE );
|
|
}
|
|
|
|
/*!
|
|
\property QProgressBar::percentageVisible
|
|
\brief whether the current progress value is displayed
|
|
|
|
The default is TRUE.
|
|
|
|
\sa centerIndicator, indicatorFollowsStyle
|
|
*/
|
|
void QProgressBar::setPercentageVisible( bool on )
|
|
{
|
|
if ( on == percentage_visible )
|
|
return;
|
|
percentage_visible = on;
|
|
repaint( FALSE );
|
|
}
|
|
|
|
/*!
|
|
\reimp
|
|
*/
|
|
void QProgressBar::show()
|
|
{
|
|
setIndicator( progress_str, progress_val, total_steps );
|
|
QFrame::show();
|
|
}
|
|
|
|
void QProgressBar::initFrame()
|
|
{
|
|
setFrameStyle(QFrame::NoFrame);
|
|
}
|
|
|
|
/*!
|
|
\reimp
|
|
*/
|
|
void QProgressBar::styleChange( QStyle& old )
|
|
{
|
|
initFrame();
|
|
QFrame::styleChange( old );
|
|
}
|
|
|
|
|
|
/*!
|
|
This method is called to generate the text displayed in the center
|
|
(or in some styles, to the left) of the progress bar.
|
|
|
|
The \a progress may be negative, indicating that the progress bar
|
|
is in the "reset" state before any progress is set.
|
|
|
|
The default implementation is the percentage of completion or
|
|
blank in the reset state. The percentage is calculated based on
|
|
the \a progress and \a totalSteps. You can set the \a indicator
|
|
text if you wish.
|
|
|
|
To allow efficient repainting of the progress bar, this method
|
|
should return FALSE if the string is unchanged from the last call
|
|
to this function.
|
|
*/
|
|
|
|
bool QProgressBar::setIndicator( QString & indicator, int progress,
|
|
int totalSteps )
|
|
{
|
|
if ( !totalSteps )
|
|
return FALSE;
|
|
if ( progress < 0 ) {
|
|
indicator = QString::fromLatin1("");
|
|
return TRUE;
|
|
} else {
|
|
// Get the values down to something usable.
|
|
if ( totalSteps > INT_MAX/1000 ) {
|
|
progress /= 1000;
|
|
totalSteps /= 1000;
|
|
}
|
|
|
|
int np = progress * 100 / totalSteps;
|
|
if ( np != percentage ) {
|
|
percentage = np;
|
|
indicator.sprintf( "%d%%", np );
|
|
return TRUE;
|
|
} else {
|
|
return FALSE;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/*!
|
|
\reimp
|
|
*/
|
|
void QProgressBar::drawContents( QPainter *p )
|
|
{
|
|
const QRect bar = contentsRect();
|
|
|
|
QSharedDoubleBuffer buffer( p, bar.x(), bar.y(), bar.width(), bar.height() );
|
|
|
|
QPoint pn = backgroundOffset();
|
|
buffer.painter()->setBrushOrigin( -pn.x(), -pn.y() );
|
|
|
|
const QPixmap *bpm = paletteBackgroundPixmap();
|
|
if ( bpm )
|
|
buffer.painter()->fillRect( bar, QBrush( paletteBackgroundColor(), *bpm ) );
|
|
else
|
|
buffer.painter()->fillRect( bar, paletteBackgroundColor() );
|
|
buffer.painter()->setFont( p->font() );
|
|
|
|
QStyle::SFlags flags = QStyle::Style_Default;
|
|
if (isEnabled())
|
|
flags |= QStyle::Style_Enabled;
|
|
if (hasFocus())
|
|
flags |= QStyle::Style_HasFocus;
|
|
|
|
style().drawControl(QStyle::CE_ProgressBarGroove, buffer.painter(), this,
|
|
QStyle::visualRect(style().subRect(QStyle::SR_ProgressBarGroove, this), this ),
|
|
colorGroup(), flags);
|
|
|
|
style().drawControl(QStyle::CE_ProgressBarContents, buffer.painter(), this,
|
|
QStyle::visualRect(style().subRect(QStyle::SR_ProgressBarContents, this), this ),
|
|
colorGroup(), flags);
|
|
|
|
if (percentageVisible())
|
|
style().drawControl(QStyle::CE_ProgressBarLabel, buffer.painter(), this,
|
|
QStyle::visualRect(style().subRect(QStyle::SR_ProgressBarLabel, this), this ),
|
|
colorGroup(), flags);
|
|
}
|
|
|
|
#endif
|