KStatusBarJobTracker

Search for usage in LXR

KStatusBarJobTracker Class Reference

#include <KStatusBarJobTracker>

Inheritance diagram for KStatusBarJobTracker:

Public Types

enum  StatusBarMode { NoInformation = 0x0000, LabelOnly = 0x0001, ProgressOnly = 0x0002 }
 
typedef QFlags< StatusBarModeStatusBarModes
 

Public Slots

virtual void description (KJob *job, const QString &title, const QPair< QString, QString > &field1, const QPair< QString, QString > &field2) override
 
void percent (KJob *job, unsigned long percent) override
 
void slotClean (KJob *job) override
 
void speed (KJob *job, unsigned long value) override
 
void totalAmount (KJob *job, KJob::Unit unit, qulonglong amount) override
 
- Public Slots inherited from KAbstractWidgetJobTracker
void registerJob (KJob *job) override
 
void unregisterJob (KJob *job) override
 
- Public Slots inherited from KJobTrackerInterface

Public Member Functions

 KStatusBarJobTracker (QWidget *parent=nullptr, bool button=true)
 
 ~KStatusBarJobTracker () override
 
void registerJob (KJob *job) override
 
void setStatusBarMode (StatusBarModes statusBarMode)
 
void unregisterJob (KJob *job) override
 
QWidgetwidget (KJob *job) override
 
- Public Member Functions inherited from KAbstractWidgetJobTracker
 KAbstractWidgetJobTracker (QWidget *parent=nullptr)
 
 ~KAbstractWidgetJobTracker () override
 
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=nullptr)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Signals inherited from KAbstractWidgetJobTracker
void resume (KJob *job)
 
void stopped (KJob *job)
 
void suspend (KJob *job)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Slots inherited from KAbstractWidgetJobTracker
void finished (KJob *job) override
 
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 Member Functions inherited from KAbstractWidgetJobTracker
 KAbstractWidgetJobTracker (KAbstractWidgetJobTrackerPrivate &dd, QWidget *parent=nullptr)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Attributes inherited from KAbstractWidgetJobTracker
std::unique_ptr< KAbstractWidgetJobTrackerPrivate > const d
 

Detailed Description

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

Definition at line 22 of file kstatusbarjobtracker.h.

Member Typedef Documentation

Stores a combination of StatusBarMode values.

Definition at line 39 of file kstatusbarjobtracker.h.

Member Enumeration Documentation

See also
StatusBarModes
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 30 of file kstatusbarjobtracker.h.

Constructor & Destructor Documentation

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

Creates a new KStatusBarJobTracker.

Parameters
parentthe parent of this object and of the widget displaying the job progresses
buttontrue to display a stop button allowing to kill the job, false otherwise

Definition at line 23 of file kstatusbarjobtracker.cpp.

KStatusBarJobTracker::~KStatusBarJobTracker ( )
overridedefault

Destroys a KStatusBarJobTracker.

Member Function Documentation

void KStatusBarJobTracker::description ( KJob job,
const QString title,
const QPair< QString, QString > &  field1,
const QPair< QString, QString > &  field2 
)
overridevirtualslot

The following slots are inherited from KJobTrackerInterface.

Definition at line 89 of file kstatusbarjobtracker.cpp.

void KStatusBarJobTracker::registerJob ( KJob job)
overridevirtual

Register a new job in this tracker.

Parameters
jobthe job to register

Reimplemented from KJobTrackerInterface.

Definition at line 30 of file kstatusbarjobtracker.cpp.

void KStatusBarJobTracker::setStatusBarMode ( StatusBarModes  statusBarMode)

Sets the mode of the status bar.

Parameters
statusBarModewhat information the status bar will show (see StatusBarMode). LabelOnly by default

Definition at line 78 of file kstatusbarjobtracker.cpp.

void KStatusBarJobTracker::unregisterJob ( KJob job)
overridevirtual

Unregister a job from this tracker.

Parameters
jobthe job to unregister

Reimplemented from KJobTrackerInterface.

Definition at line 46 of file kstatusbarjobtracker.cpp.

QWidget * KStatusBarJobTracker::widget ( KJob job)
overridevirtual

The widget associated to this tracker.

Returns
the widget displaying the job progresses

Implements KAbstractWidgetJobTracker.

Definition at line 67 of file kstatusbarjobtracker.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sun Oct 24 2021 22:50:17 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.