KJobTrackerInterface

Search for usage in LXR

KJobTrackerInterface Class Reference

#include <KJobTrackerInterface>

Inheritance diagram for KJobTrackerInterface:

Public Slots

virtual void registerJob (KJob *job)
 
virtual void unregisterJob (KJob *job)
 

Public Member Functions

 KJobTrackerInterface (QObject *parent=nullptr)
 
 ~KJobTrackerInterface () override
 
- 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
 

Protected Slots

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)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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 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)
 

Detailed Description

The interface to implement to track the progresses of a job.

Definition at line 25 of file kjobtrackerinterface.h.

Constructor & Destructor Documentation

KJobTrackerInterface::KJobTrackerInterface ( QObject parent = nullptr)
explicit

Creates a new KJobTrackerInterface.

Parameters
parentthe parent object

Definition at line 24 of file kjobtrackerinterface.cpp.

KJobTrackerInterface::~KJobTrackerInterface ( )
overridedefault

Destroys a KJobTrackerInterface.

Member Function Documentation

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

Called to display general description of a job.

A description has a title and two optional fields which can be used to complete the description.

Examples of titles are "Copying", "Creating resource", etc. The fields of the description can be "Source" with an URL, and, "Destination" with an URL for a "Copying" description.

Parameters
jobthe job that emitted this signal
titlethe general description of the job
field1first field (localized name and value)
field2second field (localized name and value)

Definition at line 69 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::finished ( KJob job)
protectedvirtualslot

Called when a job is finished, in any case.

It is used to notify that the job is terminated and that progress UI (if any) can be hidden.

Parameters
jobthe job that emitted this signal

Definition at line 54 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::infoMessage ( KJob job,
const QString plain,
const QString rich 
)
protectedvirtualslot

Called to display state information about a job.

Examples of message are "Resolving host", "Connecting to host...", etc.

Parameters
jobthe job that emitted this signal
plainthe info message
richthe rich text version of the message, or QString() is none is available

Definition at line 77 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::percent ( KJob job,
unsigned long  percent 
)
protectedvirtualslot

Called to show the overall progress of the job.

Note that this is not called for finished jobs.

Parameters
jobthe job that emitted this signal
percentthe percentage

Definition at line 105 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::processedAmount ( KJob job,
KJob::Unit  unit,
qulonglong  amount 
)
protectedvirtualslot

Regularly called to show the progress of a job by giving the current amount.

The unit of this amount is provided too. It can be called several times for a given job if the job manages several different units.

Parameters
jobthe job that emitted this signal
unitthe unit of the processed amount
amountthe processed amount

Definition at line 98 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::registerJob ( KJob job)
virtualslot

Register a new job in this tracker.

The default implementation connects the following KJob signals to the respective protected slots of this class:

If you re-implement this method, you may want to call the default implementation or add at least:

connect(job, &KJob::finished, this, &MyJobTracker::unregisterJob);

so that you won't have to manually call unregisterJob().

Parameters
jobthe job to register
See also
unregisterJob()

Reimplemented in KStatusBarJobTracker, KUiServerJobTracker, and KUiServerV2JobTracker.

Definition at line 33 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::resumed ( KJob job)
protectedvirtualslot

Called when a job is resumed.

Parameters
jobthe job that emitted this signal

Definition at line 64 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::speed ( KJob job,
unsigned long  value 
)
protectedvirtualslot

Called to show the speed of the job.

Parameters
jobthe job that emitted this signal
valuethe current speed of the job

Definition at line 111 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::suspended ( KJob job)
protectedvirtualslot

Called when a job is suspended.

Parameters
jobthe job that emitted this signal

Definition at line 59 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::totalAmount ( KJob job,
KJob::Unit  unit,
qulonglong  amount 
)
protectedvirtualslot

Called when we know the amount a job will have to process.

The unit of this amount is provided too. It can be called several times for a given job if the job manages several different units.

Parameters
jobthe job that emitted this signal
unitthe unit of the total amount
amountthe total amount

Definition at line 91 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::unregisterJob ( KJob job)
virtualslot

Unregister a job from this tracker.

Note
You need to manually call this method only if you re-implemented registerJob() without connecting KJob::finished to this slot.
Parameters
jobthe job to unregister
See also
registerJob()

Reimplemented in KStatusBarJobTracker, KUiServerJobTracker, and KUiServerV2JobTracker.

Definition at line 49 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::warning ( KJob job,
const QString plain,
const QString rich 
)
protectedvirtualslot

Emitted to display a warning about a job.

Parameters
jobthe job that emitted this signal
plainthe warning message
richthe rich text version of the message, or QString() is none is available

Definition at line 84 of file kjobtrackerinterface.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 Wed May 12 2021 23:01:33 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.