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
|
/***************************************************************************
* Copyright (C) 2006 by Peter Penz *
* [email protected] *
* *
* 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 Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef DOLPHINSTATUSBAR_H
#define DOLPHINSTATUSBAR_H
#include <tqhbox.h>
class KProgress;
class TQLabel;
class TQTimer;
class StatusBarMessageLabel;
class StatusBarSpaceInfo;
class DolphinView;
class KURL;
/**
* @brief Represents the statusbar of a Dolphin view.
*
* The statusbar allows to show messages and progress
* information.
*
* @author Peter Penz
*/
class DolphinStatusBar : public TQHBox {
Q_OBJECT
public:
/**
* Describes the type of the message text. Dependent
* from the type a corresponding icon and color is
* used for the message text.
*/
enum Type {
Default,
OperationCompleted,
Information,
Error
};
DolphinStatusBar(DolphinView* parent = 0);
virtual ~DolphinStatusBar();
/**
* Sets the message text to \a msg. Dependant
* from the given type \a type an icon is shown and
* the color of the text is adjusted. The height of
* the statusbar is automatically adjusted in a way,
* that the full text fits into the available width.
*
* If a progress is ongoing and a message
* with the type Type::Error is set, the progress
* is cleared automatically.
*/
void setMessage(const TQString& msg, Type type);
TQString message() const;
Type type() const;
/**
* Sets the text for the progress information.
* The text is shown with a delay of 300 milliseconds:
* if the progress set by DolphinStatusBar::setProgress()
* does reach 100 % within 300 milliseconds,
* the progress text is not shown at all. This assures that
* no flickering occurs for showing a progress of fast
* operations.
*/
void setProgressText(const TQString& text);
TQString progressText() const;
/**
* Sets the progress in percent (0 - 100). The
* progress is shown with a delay of 300 milliseconds:
* if the progress does reach 100 % within 300 milliseconds,
* the progress is not shown at all. This assures that
* no flickering occurs for showing a progress of fast
* operations.
*/
void setProgress(int percent);
int progress() const { return m_progress; }
/**
* Clears the message text of the status bar by replacing
* the message with the default text, which can be set
* by DolphinStatusBar::setDefaultText(). The progress
* information is not cleared.
*/
void clear();
/**
* Sets the default text, which is shown if the status bar
* is cleared by DolphinStatusBar::clear().
*/
void setDefaultText(const TQString& text);
const TQString& defaultText() const { return m_defaultText; }
private slots:
void slotProgressTimer();
/**
* Is invoked, when the URL of the DolphinView, where the
* statusbar belongs too, has been changed.
*/
void slotURLChanged(const KURL& url);
private:
StatusBarMessageLabel* m_messageLabel;
StatusBarSpaceInfo* m_spaceInfo;
TQLabel* m_progressText;
KProgress* m_progressBar;
TQTimer* m_progressTimer;
int m_progress;
TQString m_defaultText;
};
#endif
|
