KStatusBarJobTracker Class

This class implements a job tracker with a widget suited for embedding in a status bar. More...

Header: #include <KStatusBarJobTracker>
CMake: find_package(KF6 REQUIRED COMPONENTS JobWidgets)
target_link_libraries(mytarget PRIVATE KF6::JobWidgets)
Inherits: KAbstractWidgetJobTracker

Public Types

enum StatusBarMode { NoInformation, LabelOnly, ProgressOnly }
flags StatusBarModes

Public Functions

KStatusBarJobTracker(QWidget *parent = nullptr, bool button = true)
void setStatusBarMode(KStatusBarJobTracker::StatusBarModes statusBarMode)

Public Slots

virtual void description(KJob *job, const QString &title, const QPair<QString, QString> &field1, const QPair<QString, QString> &field2) override
virtual void percent(KJob *job, unsigned long percent) override
virtual void slotClean(KJob *job) override
virtual void speed(KJob *job, unsigned long value) override
virtual void totalAmount(KJob *job, KJob::Unit unit, qulonglong amount) override

Detailed Description

Member Type Documentation

enum KStatusBarJobTracker::StatusBarMode
flags KStatusBarJobTracker::StatusBarModes

ConstantValueDescription
KStatusBarJobTracker::NoInformation0x0000Does not show any information
KStatusBarJobTracker::LabelOnly0x0001Shows an informative label for job progress
KStatusBarJobTracker::ProgressOnly0x0002Shows a progress bar with the job completion

The StatusBarModes type is a typedef for QFlags<StatusBarMode>. It stores an OR combination of StatusBarMode values.

Member Function Documentation

[explicit] KStatusBarJobTracker::KStatusBarJobTracker(QWidget *parent = nullptr, bool button = true)

Creates a new KStatusBarJobTracker

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

[override virtual slot] void KStatusBarJobTracker::description(KJob *job, const QString &title, const QPair<QString, QString> &field1, const QPair<QString, QString> &field2)

[override virtual slot] void KStatusBarJobTracker::percent(KJob *job, unsigned long percent)

void KStatusBarJobTracker::setStatusBarMode(KStatusBarJobTracker::StatusBarModes statusBarMode)

Sets the mode of the status bar.

statusBarMode what information the status bar will show (see StatusBarMode). LabelOnly by default

[override virtual slot] void KStatusBarJobTracker::slotClean(KJob *job)

[override virtual slot] void KStatusBarJobTracker::speed(KJob *job, unsigned long value)

[override virtual slot] void KStatusBarJobTracker::totalAmount(KJob *job, KJob::Unit unit, qulonglong amount)