KAbstractWidgetJobTracker Class Reference

#include <KAbstractWidgetJobTracker>

Inheritance diagram for KAbstractWidgetJobTracker:

Signals
void	resume (KJob *job)
void	stopped (KJob *job)
void	suspend (KJob *job)

Public Slots
void	registerJob (KJob *job) override
void	unregisterJob (KJob *job) override
Public Slots inherited from KJobTrackerInterface
virtual void	registerJob (KJob *job)
virtual void	unregisterJob (KJob *job)

Public Member Functions
	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
virtual QWidget *	widget (KJob *job)=0
Public Member Functions inherited from KJobTrackerInterface
	KJobTrackerInterface (QObject *parent=nullptr)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Slots
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 &message)
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 &message)

Protected Member Functions
KJOBWIDGETS_NO_EXPORT	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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
std::unique_ptr< KAbstractWidgetJobTrackerPrivate > const	d_ptr

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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

The base class for widget based job trackers.

Definition at line 27 of file kabstractwidgetjobtracker.h.

Constructor & Destructor Documentation

KAbstractWidgetJobTracker() [1/2]

KAbstractWidgetJobTracker::KAbstractWidgetJobTracker ( QWidget * parent = nullptr )

explicit

Creates a new KAbstractWidgetJobTracker.

Parameters

parent

the parent of this object and of the widget displaying the job progresses

Definition at line 15 of file kabstractwidgetjobtracker.cpp.

~KAbstractWidgetJobTracker()

KAbstractWidgetJobTracker::~KAbstractWidgetJobTracker ( )

overridedefault

Destroys a KAbstractWidgetJobTracker.

KAbstractWidgetJobTracker() [2/2]

KAbstractWidgetJobTracker::KAbstractWidgetJobTracker ( KAbstractWidgetJobTrackerPrivate & dd, QWidget * parent = nullptr )

explicitprotected

Definition at line 20 of file kabstractwidgetjobtracker.cpp.

Member Function Documentation

autoDelete()

bool KAbstractWidgetJobTracker::autoDelete

(

KJob *

job

)

const

Checks whether the dialog should be deleted or cleaned.

Parameters

job	the job's widget that will be auto-deleted

Returns

false if the dialog only calls slotClean, true if it will be deleted

See also

setAutoDelete()

Definition at line 59 of file kabstractwidgetjobtracker.cpp.

finished

void KAbstractWidgetJobTracker::finished ( KJob * job )

overrideprotectedslot

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

job	the job that emitted this signal

Definition at line 66 of file kabstractwidgetjobtracker.cpp.

registerJob

void KAbstractWidgetJobTracker::registerJob ( KJob * job )

overrideslot

Register a new job in this tracker.

Note that job trackers inheriting from this class can have only one job registered at a time.

Parameters

job	the job to register

Definition at line 28 of file kabstractwidgetjobtracker.cpp.

resume

void KAbstractWidgetJobTracker::resume ( KJob * job )

signal

Emitted when the user resumed the operation.

Parameters

job	The job that has been resumed

setAutoDelete()

void KAbstractWidgetJobTracker::setAutoDelete	(	KJob *	job,
		bool	autoDelete )

This controls whether the dialog should be deleted or only cleaned when the KJob is finished (or canceled).

If your dialog is an embedded widget and not a separate window, you should setAutoDelete(false) in the constructor of your custom dialog.

Parameters

job	the job's widget that is going to be auto-deleted
autoDelete	If false the dialog will only call method slotClean. If true the dialog will be deleted.

See also

autoDelete()

Definition at line 52 of file kabstractwidgetjobtracker.cpp.

setStopOnClose()

void KAbstractWidgetJobTracker::setStopOnClose	(	KJob *	job,
		bool	stopOnClose )

This controls whether the job should be canceled if the dialog is closed.

Parameters

job	the job's widget that will be stopped when closing
stopOnClose	If true the job will be stopped if the dialog is closed, otherwise the job will continue even on close.

See also

stopOnClose()

Definition at line 38 of file kabstractwidgetjobtracker.cpp.

slotClean

void KAbstractWidgetJobTracker::slotClean ( KJob * job )

protectedvirtualslot

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

Definition at line 95 of file kabstractwidgetjobtracker.cpp.

slotResume

void KAbstractWidgetJobTracker::slotResume ( KJob * job )

protectedvirtualslot

This method should be called for pause/resume Connect this to the progress widgets buttons etc.

Parameters

job	The job that is being resumed

Definition at line 87 of file kabstractwidgetjobtracker.cpp.

slotStop

void KAbstractWidgetJobTracker::slotStop ( KJob * job )

protectedvirtualslot

This method should be called for correct cancellation of IO operation Connect this to the progress widgets buttons etc.

Parameters

job	The job that is being stopped

Definition at line 71 of file kabstractwidgetjobtracker.cpp.

slotSuspend

void KAbstractWidgetJobTracker::slotSuspend ( KJob * job )

protectedvirtualslot

This method should be called for pause/resume Connect this to the progress widgets buttons etc.

Parameters

job	The job that is being suspended

Definition at line 79 of file kabstractwidgetjobtracker.cpp.

stopOnClose()

bool KAbstractWidgetJobTracker::stopOnClose

(

KJob *

job

)

const

Checks whether the job will be killed when the dialog is closed.

Parameters

job	the job's widget that will be stopped when closing

Returns

true if the job is killed on close event, false otherwise.

See also

setStopOnClose()

Definition at line 45 of file kabstractwidgetjobtracker.cpp.

stopped

void KAbstractWidgetJobTracker::stopped ( KJob * job )

signal

Emitted when the user aborted the operation.

Parameters

job	The job that has been stopped

suspend

void KAbstractWidgetJobTracker::suspend ( KJob * job )

signal

Emitted when the user suspended the operation.

Parameters

job	The job that has been suspended

unregisterJob

void KAbstractWidgetJobTracker::unregisterJob ( KJob * job )

overrideslot

Unregister a job from this tracker.

Parameters

job	the job to unregister

Definition at line 33 of file kabstractwidgetjobtracker.cpp.

widget()

virtual QWidget * KAbstractWidgetJobTracker::widget ( KJob * job )

pure virtual

The widget associated to this tracker.

Parameters

job	the job that is assigned the widget we want to return

Returns

the widget displaying the job progresses

Implemented in KStatusBarJobTracker, and KWidgetJobTracker.

Member Data Documentation

d_ptr

std::unique_ptr<KAbstractWidgetJobTrackerPrivate> const KAbstractWidgetJobTracker::d_ptr

protected

Definition at line 181 of file kabstractwidgetjobtracker.h.

---

The documentation for this class was generated from the following files:

• kabstractwidgetjobtracker.h
• kabstractwidgetjobtracker.cpp