1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/***************************************************************************
* 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 <tqwidget.h> //baseclass
#include <tqmap.h> //stack allocated
#include <tqvaluelist.h> //stack allocated
class TQLabel;
class TQTimer;
namespace KIO { class Job; }
//TODO
// * concept of a temporary message that is removed when a qobject parent is deleted
namespace KDE
{
class OverlayWidget;
typedef TQMap<const TQObject*, ProgressBar*> ProgressMap;
/**
* @class KDE::StatusBar
* @short advanced statusBar
* @author Max Howell <max.howell@methylblue.com>
*
* Like a normal TQStatusBar, but add widgets directly:
*
* new TQLabel( text, statusbar );
*
* The statusbar has some handy progress monitoring behaviour, use like so:
*
* statusbar->newProgressOperation( myObject )
* .setDescription( i18n("MyProgressOperation") )
* .setStatus( i18n("Stage1") )
* .setAbortSlot( myObject, TQT_SLOT(abort()) )
* .setTotalSteps( 100 );
*
* The newProgressOperation function returns a KDE::ProgressBar, which is
* a TQProgressBar 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( TQObject*, int steps ) to update
* the progress for this progress operation. Only one progress operation per
* TQObject!
*
* 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 TQWidget
{
Q_OBJECT
TQ_OBJECT
public:
StatusBar( TQWidget *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( TQObject*, int )
* @see incrementProgress( TQObject* )
* @see setProgressStatus( const TQObject*, const TQString& )
*/
ProgressBar &newProgressOperation( TQObject *owner );
/**
* Monitor progress for a KIO::Job, very handy.
*/
ProgressBar &newProgressOperation( KIO::Job* );
void incrementProgressTotalSteps( const TQObject *owner, int inc = 1 );
void incrementProgress( const TQObject *owner );
void setProgressStatus( const TQObject *owner, const TQString &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 TQString &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 TQString &text, int type = Information ) LIBAMAROK_EXPORT ;
void longMessageThreadSafe( const TQString &text, int type = Information );
/**
* Shows a short message, with a button that can be pushed to show a long
* message
*/
void shortLongMessage( const TQString &_short, const TQString &_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 TQString &text, bool longShort = false );
/** Stop anticipating progress from sender() */
void endProgressOperation();
/** Stop anticipating progress from @param owner */
void endProgressOperation( TQObject *owner );
/**
* Convenience function works like setProgress( TQObject*, int )
* Uses the return value from sender() to determine the owner of
* the progress bar in question
*/
void setProgress( int steps );
void setProgress( const TQObject *owner, int steps );
/**
* Convenience function works like setTotalSteps( TQObject*, 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( TQObject* )
* 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( TQObject* );
protected:
virtual void polish();
virtual void customEvent( TQCustomEvent* );
virtual void paintEvent( TQPaintEvent* );
virtual bool event( TQEvent* );
/**
* 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 tqlayout.
* Currently you must add widgets before the statusbar gets shown
* for the first time, because we are not currently very flexible.
*/
void addWidget( TQWidget *widget );
TQLabel *m_mainTextLabel;
private:
struct Message
{
Message() : type( KDE::StatusBar::None ), offset( 0 ) {}
Message( const TQString &_text, const MessageType _type ) : text( _text ), type( _type ), offset( 0 ) {}
TQString 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 TQString &text );
int m_logCounter;
TQWidget *cancelButton() { return TQT_TQWIDGET( child( "cancelButton" ) ); }
TQWidget *toggleProgressWindowButton() { return TQT_TQWIDGET( child( "showAllProgressDetails" ) ); }
TQWidget *progressBox() { return TQT_TQWIDGET( child( "progressBox" ) ); }
TQWidget *shortLongButton() { return TQT_TQWIDGET( child( "shortLongButton" ) ); }
OverlayWidget *m_popupProgress;
TQProgressBar *m_mainProgressBar;
ProgressMap m_progressMap;
TQValueList<TQWidget*> m_messageQueue;
TQString m_mainText;
TQString m_shortLongText;
int m_shortLongType;
TQLayout *m_otherWidgetLayout;
};
}
#endif
|
