KDEUI
KStatusBarJobTracker Class Reference
This class implements a job tracker with a widget suited for embedding in a status bar. More...
#include <kstatusbarjobtracker.h>

Public Types | |
enum | StatusBarMode { NoInformation = 0x0000, LabelOnly = 0x0001, ProgressOnly = 0x0002 } |
Public Slots | |
virtual void | description (KJob *job, const QString &title, const QPair< QString, QString > &field1, const QPair< QString, QString > &field2) |
virtual void | percent (KJob *job, unsigned long percent) |
virtual void | slotClean (KJob *job) |
virtual void | speed (KJob *job, unsigned long value) |
virtual void | totalAmount (KJob *job, KJob::Unit unit, qulonglong amount) |
Public Member Functions | |
KStatusBarJobTracker (QWidget *parent=0, bool button=true) | |
virtual void | registerJob (KJob *job) |
void | setStatusBarMode (StatusBarModes statusBarMode) |
virtual void | unregisterJob (KJob *job) |
virtual QWidget * | widget (KJob *job) |
virtual | ~KStatusBarJobTracker () |
Detailed Description
This class implements a job tracker with a widget suited for embedding in a status bar.
Definition at line 30 of file kstatusbarjobtracker.h.
Member Enumeration Documentation
- Enumerator:
NoInformation Does not show any information.
LabelOnly Shows an informative label for job progress.
ProgressOnly Shows a progress bar with the job completion.
Definition at line 35 of file kstatusbarjobtracker.h.
Constructor & Destructor Documentation
Creates a new KStatusBarJobTracker.
- Parameters:
-
parent the parent of this object and of the widget displaying the job progresses button true to display a stop button allowing to kill the job, false otherwise
Definition at line 36 of file kstatusbarjobtracker.cpp.
KStatusBarJobTracker::~KStatusBarJobTracker | ( | ) | [virtual] |
Destroys a KStatusBarJobTracker.
Definition at line 41 of file kstatusbarjobtracker.cpp.
Member Function Documentation
void KStatusBarJobTracker::description | ( | KJob * | job, | |
const QString & | title, | |||
const QPair< QString, QString > & | field1, | |||
const QPair< QString, QString > & | field2 | |||
) | [virtual, slot] |
The following slots are inherited from KJobTrackerInterface.
Reimplemented from KJobTrackerInterface.
Definition at line 94 of file kstatusbarjobtracker.cpp.
void KStatusBarJobTracker::percent | ( | KJob * | job, | |
unsigned long | percent | |||
) | [virtual, slot] |
Reimplemented from KJobTrackerInterface.
Definition at line 114 of file kstatusbarjobtracker.cpp.
void KStatusBarJobTracker::registerJob | ( | KJob * | job | ) | [virtual] |
Register a new job in this tracker.
- Parameters:
-
job the job to register
Reimplemented from KAbstractWidgetJobTracker.
Definition at line 46 of file kstatusbarjobtracker.cpp.
void KStatusBarJobTracker::setStatusBarMode | ( | StatusBarModes | statusBarMode | ) |
Sets the mode of the status bar.
- Parameters:
-
statusBarMode what information the status bar will show (see StatusBarMode). LabelOnly by default
Definition at line 85 of file kstatusbarjobtracker.cpp.
void KStatusBarJobTracker::slotClean | ( | KJob * | job | ) | [virtual, slot] |
This method is called when the widget should be cleaned (after job is finished).
redefine this for custom behavior.
- Parameters:
-
job The job that is being cleaned
Reimplemented from KAbstractWidgetJobTracker.
Definition at line 132 of file kstatusbarjobtracker.cpp.
void KStatusBarJobTracker::speed | ( | KJob * | job, | |
unsigned long | value | |||
) | [virtual, slot] |
Reimplemented from KJobTrackerInterface.
Definition at line 123 of file kstatusbarjobtracker.cpp.
void KStatusBarJobTracker::totalAmount | ( | KJob * | job, | |
KJob::Unit | unit, | |||
qulonglong | amount | |||
) | [virtual, slot] |
Reimplemented from KJobTrackerInterface.
Definition at line 105 of file kstatusbarjobtracker.cpp.
void KStatusBarJobTracker::unregisterJob | ( | KJob * | job | ) | [virtual] |
Unregister a job from this tracker.
- Parameters:
-
job the job to unregister
Reimplemented from KAbstractWidgetJobTracker.
Definition at line 60 of file kstatusbarjobtracker.cpp.
The widget associated to this tracker.
- Returns:
- the widget displaying the job progresses
Implements KAbstractWidgetJobTracker.
Definition at line 76 of file kstatusbarjobtracker.cpp.
The documentation for this class was generated from the following files: