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.
234 lines
8.9 KiB
234 lines
8.9 KiB
/***************************************************************************
|
|
* Copyright (C) 2005 by Max Howell <max.howell@methylblue.com> *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program; if not, write to the *
|
|
* Free Software Foundation, Inc., *
|
|
* 51 Franklin Steet, Fifth Floor, Boston, MA 02110-1301, USA. *
|
|
***************************************************************************/
|
|
|
|
#ifndef KDE_STATUSBAR_H
|
|
#define KDE_STATUSBAR_H
|
|
|
|
#include "progressBar.h" //convenience
|
|
#include "amarok_export.h"
|
|
#include <qwidget.h> //baseclass
|
|
#include <qmap.h> //stack allocated
|
|
#include <qvaluelist.h> //stack allocated
|
|
|
|
class QLabel;
|
|
class QTimer;
|
|
|
|
namespace KIO { class Job; }
|
|
|
|
//TODO
|
|
// * concept of a temporary message that is removed when a qobject parent is deleted
|
|
|
|
namespace KDE
|
|
{
|
|
class OverlayWidget;
|
|
typedef QMap<const QObject*, ProgressBar*> ProgressMap;
|
|
|
|
/**
|
|
* @class KDE::StatusBar
|
|
* @short advanced statusBar
|
|
* @author Max Howell <max.howell@methylblue.com>
|
|
*
|
|
* Like a normal QStatusBar, but add widgets directly:
|
|
*
|
|
* new QLabel( text, statusbar );
|
|
*
|
|
* The statusbar has some handy progress monitoring behaviour, use like so:
|
|
*
|
|
* statusbar->newProgressOperation( myObject )
|
|
* .setDescription( i18n("MyProgressOperation") )
|
|
* .setStatus( i18n("Stage1") )
|
|
* .setAbortSlot( myObject, SLOT(abort()) )
|
|
* .setTotalSteps( 100 );
|
|
*
|
|
* The newProgressOperation function returns a KDE::ProgressBar, which is
|
|
* a QProgressBar with some additional functions that return ProgressBar&,
|
|
* so you can chain the mutators like above. @see KDE::ProgressBar
|
|
*
|
|
* After this point you can use setProgress( QObject*, int steps ) to update
|
|
* the progress for this progress operation. Only one progress operation per
|
|
* QObject!
|
|
*
|
|
* You can also follow KIO::Jobs, with built in error handling, and
|
|
* ThreadManager::Jobs have built in thread-safe progress handling.
|
|
*
|
|
* You can show long status/error messages using longMessage(), these are
|
|
* meant to be instead of showing an irritating, interuptory KMessageBox.
|
|
*
|
|
* Caveats:
|
|
* This only looks sensible if the statusbar is at the bottom of the screen
|
|
*
|
|
* @see KDE::ProgressBar
|
|
*/
|
|
|
|
class StatusBar : public QWidget
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
StatusBar( QWidget *parent, const char *name = "mainStatusBar" );
|
|
|
|
enum MessageType { Information, Question, Sorry, Warning, Error, ShowAgainCheckBox, None };
|
|
|
|
/**
|
|
* Start a progress operation, if owner is 0, the return value is
|
|
* undefined - the application will probably crash.
|
|
* @param owner controls progress for this operation
|
|
* @return the progressBar so you can configure its parameters
|
|
* @see setProgress( QObject*, int )
|
|
* @see incrementProgress( QObject* )
|
|
* @see setProgressStatus( const QObject*, const QString& )
|
|
*/
|
|
ProgressBar &newProgressOperation( QObject *owner );
|
|
|
|
/**
|
|
* Monitor progress for a KIO::Job, very handy.
|
|
*/
|
|
ProgressBar &newProgressOperation( KIO::Job* );
|
|
|
|
void incrementProgressTotalSteps( const QObject *owner, int inc = 1 );
|
|
void incrementProgress( const QObject *owner );
|
|
void setProgressStatus( const QObject *owner, const QString &text );
|
|
|
|
public slots:
|
|
/**
|
|
* The statusbar has a region where you can display a mainMessage.
|
|
* It persists after all other message-types are displayed
|
|
*/
|
|
void setMainText( const QString &text );
|
|
|
|
/// resets mainText if you've done a shortMessage
|
|
void resetMainText();
|
|
|
|
/**
|
|
* Shows a non-invasive messgeBox style message that the user has to dismiss
|
|
* but it doesn't interupt whatever he is doing at the current time.
|
|
* Generally you should use these, as it is very easy for a user to not notice
|
|
* statusBar messages.
|
|
*/
|
|
void longMessage( const QString &text, int type = Information ) LIBAMAROK_EXPORT ;
|
|
|
|
void longMessageThreadSafe( const QString &text, int type = Information );
|
|
|
|
|
|
/**
|
|
* Shows a short message, with a button that can be pushed to show a long
|
|
* message
|
|
*/
|
|
void shortLongMessage( const QString &_short, const QString &_long, int type = Information );
|
|
|
|
/**
|
|
* Set a temporary message over the mainText label, for 5 seconds.
|
|
* ONLY USE FOR STATUS MESSAGES! ie "Buffering...", "Connecting to source..."
|
|
*/
|
|
void shortMessage( const QString &text, bool longShort = false );
|
|
|
|
/** Stop anticipating progress from sender() */
|
|
void endProgressOperation();
|
|
|
|
/** Stop anticipating progress from @param owner */
|
|
void endProgressOperation( QObject *owner );
|
|
|
|
/**
|
|
* Convenience function works like setProgress( QObject*, int )
|
|
* Uses the return value from sender() to determine the owner of
|
|
* the progress bar in question
|
|
*/
|
|
void setProgress( int steps );
|
|
void setProgress( const QObject *owner, int steps );
|
|
/**
|
|
* Convenience function works like setTotalSteps( QObject*, int )
|
|
* Uses the return value from sender() to determine the owner of
|
|
* the progress bar in question
|
|
*/
|
|
//void setTotalSteps( int totalSteps );
|
|
|
|
/**
|
|
* Convenience function works like incrementProgress( QObject* )
|
|
* Uses the return value from sender() to determine the owner of
|
|
* the progress bar in question
|
|
*/
|
|
void incrementProgress();
|
|
|
|
public slots:
|
|
void toggleProgressWindow( bool show );
|
|
void abortAllProgressOperations();
|
|
|
|
private slots:
|
|
/** For internal use against KIO::Jobs */
|
|
void setProgress( KIO::Job*, unsigned long percent );
|
|
void showMainProgressBar();
|
|
void hideMainProgressBar();
|
|
void updateProgressAppearance();
|
|
void showShortLongDetails();
|
|
void popupDeleted( QObject* );
|
|
|
|
protected:
|
|
virtual void polish();
|
|
virtual void customEvent( QCustomEvent* );
|
|
virtual void paintEvent( QPaintEvent* );
|
|
virtual bool event( QEvent* );
|
|
|
|
/**
|
|
* You must parent the widget to the statusbar, we won't do that
|
|
* for you! The widget will be added to the right of the layout.
|
|
* Currently you must add widgets before the statusbar gets shown
|
|
* for the first time, because we are not currently very flexible.
|
|
*/
|
|
void addWidget( QWidget *widget );
|
|
|
|
QLabel *m_mainTextLabel;
|
|
|
|
private:
|
|
struct Message
|
|
{
|
|
Message() : type( KDE::StatusBar::None ), offset( 0 ) {}
|
|
Message( const QString &_text, const MessageType _type ) : text( _text ), type( _type ), offset( 0 ) {}
|
|
|
|
QString text;
|
|
MessageType type;
|
|
|
|
int offset;
|
|
};
|
|
|
|
void updateTotalProgress();
|
|
bool allDone(); ///@return true if all progress operations are complete
|
|
void pruneProgressBars(); /// deletes old progress bars
|
|
void writeLogFile( const QString &text );
|
|
|
|
int m_logCounter;
|
|
|
|
QWidget *cancelButton() { return static_cast<QWidget*>( child( "cancelButton" ) ); }
|
|
QWidget *toggleProgressWindowButton() { return static_cast<QWidget*>( child( "showAllProgressDetails" ) ); }
|
|
QWidget *progressBox() { return static_cast<QWidget*>( child( "progressBox" ) ); }
|
|
QWidget *shortLongButton() { return static_cast<QWidget*>( child( "shortLongButton" ) ); }
|
|
|
|
OverlayWidget *m_popupProgress;
|
|
QProgressBar *m_mainProgressBar;
|
|
|
|
ProgressMap m_progressMap;
|
|
QValueList<QWidget*> m_messageQueue;
|
|
QString m_mainText;
|
|
QString m_shortLongText;
|
|
int m_shortLongType;
|
|
|
|
QLayout *m_otherWidgetLayout;
|
|
};
|
|
}
|
|
#endif
|