KStatusBarJobTracker Class Reference

#include <kstatusbarjobtracker.h>

Inheritance diagram for KStatusBarJobTracker:

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 Slots inherited from KAbstractWidgetJobTracker
Public Slots inherited from KJobTrackerInterface

Public Member Functions
	KStatusBarJobTracker (QWidget *parent=0, bool button=true)
virtual	~KStatusBarJobTracker ()
virtual void	registerJob (KJob *job)
void	setStatusBarMode (StatusBarModes statusBarMode)
virtual void	unregisterJob (KJob *job)
virtual QWidget *	widget (KJob *job)
Public Member Functions inherited from KAbstractWidgetJobTracker
	KAbstractWidgetJobTracker (QWidget *parent=0)
virtual	~KAbstractWidgetJobTracker ()
bool	autoDelete (KJob *job) const
void	setAutoDelete (KJob *job, bool autoDelete)
void	setStopOnClose (KJob *job, bool stopOnClose)
bool	stopOnClose (KJob *job) const
Public Member Functions inherited from KJobTrackerInterface
	KJobTrackerInterface (QObject *parent=0)
virtual	~KJobTrackerInterface ()

Additional Inherited Members
Signals inherited from KAbstractWidgetJobTracker
void	resume (KJob *job)
void	stopped (KJob *job)
void	suspend (KJob *job)
Protected Slots inherited from KAbstractWidgetJobTracker
virtual void	finished (KJob *job)
virtual void	slotClean (KJob *job)
virtual void	slotResume (KJob *job)
virtual void	slotStop (KJob *job)
virtual void	slotSuspend (KJob *job)
Protected Slots inherited from KJobTrackerInterface
virtual void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1, const QPair< QString, QString > &field2)
virtual void	finished (KJob *job)
virtual void	infoMessage (KJob *job, const QString &plain, const QString &rich)
virtual void	percent (KJob *job, unsigned long percent)
virtual void	processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
virtual void	resumed (KJob *job)
virtual void	speed (KJob *job, unsigned long value)
virtual void	suspended (KJob *job)
virtual void	totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
virtual void	warning (KJob *job, const QString &plain, const QString &rich)
Protected Attributes inherited from KAbstractWidgetJobTracker
Private *const	d

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

enum KStatusBarJobTracker::StatusBarMode

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

KStatusBarJobTracker::KStatusBarJobTracker ( QWidget *  parent = 0, bool  button = true  )

explicit

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  )

virtualslot

The following slots are inherited from KJobTrackerInterface.

Definition at line 94 of file kstatusbarjobtracker.cpp.

void KStatusBarJobTracker::percent ( KJob *  job, unsigned long  percent  )

virtualslot

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 )

virtualslot

Definition at line 132 of file kstatusbarjobtracker.cpp.

void KStatusBarJobTracker::speed ( KJob *  job, unsigned long  value  )

virtualslot

Definition at line 123 of file kstatusbarjobtracker.cpp.

void KStatusBarJobTracker::totalAmount ( KJob *  job, KJob::Unit  unit, qulonglong  amount  )

virtualslot

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.

QWidget * KStatusBarJobTracker::widget ( KJob *  job )

virtual

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:

• kstatusbarjobtracker.h
• kstatusbarjobtracker.cpp