KStatusBarJobTracker

#include <KStatusBarJobTracker>

Inheritance diagram for KStatusBarJobTracker:

[legend]

Public Types
enum	StatusBarMode { NoInformation = 0x0000 , LabelOnly = 0x0001 , ProgressOnly = 0x0002 }

typedef QFlags< StatusBarMode >	StatusBarModes

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

QWidget *	widget (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)

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

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 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

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 &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 inherited from KAbstractWidgetJobTracker
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 inherited from KAbstractWidgetJobTracker
std::unique_ptr< KAbstractWidgetJobTrackerPrivate > const	d_ptr

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

◆ StatusBarModes

typedef QFlags< StatusBarMode > KStatusBarJobTracker::StatusBarModes

Stores a combination of StatusBarMode values.

Definition at line 39 of file kstatusbarjobtracker.h.

Member Enumeration Documentation

◆ StatusBarMode

enum KStatusBarJobTracker::StatusBarMode

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::KStatusBarJobTracker	(	QWidget *	parent = nullptr,
		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 23 of file kstatusbarjobtracker.cpp.

◆ ~KStatusBarJobTracker()

KStatusBarJobTracker::~KStatusBarJobTracker ( )

overridedefault

Destroys a KStatusBarJobTracker.

Member Function Documentation

◆ description

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.

◆ percent

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

overrideslot

Definition at line 111 of file kstatusbarjobtracker.cpp.

◆ registerJob()

void KStatusBarJobTracker::registerJob ( KJob * job )

overridevirtual

Parameters

job	the job to register

Reimplemented from KJobTrackerInterface.

Definition at line 30 of file kstatusbarjobtracker.cpp.

◆ setStatusBarMode()

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 78 of file kstatusbarjobtracker.cpp.

◆ slotClean

void KStatusBarJobTracker::slotClean ( KJob * job )

overrideslot

Definition at line 133 of file kstatusbarjobtracker.cpp.

◆ speed

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

overrideslot

Definition at line 122 of file kstatusbarjobtracker.cpp.

◆ totalAmount

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

overrideslot

Definition at line 100 of file kstatusbarjobtracker.cpp.

◆ unregisterJob()

void KStatusBarJobTracker::unregisterJob ( KJob * job )

overridevirtual

Unregister a job from this tracker.

Parameters

job	the job to unregister

Reimplemented from KJobTrackerInterface.

Definition at line 46 of file kstatusbarjobtracker.cpp.

◆ widget()

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:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KJobWidgets

KStatusBarJobTracker

Public Types

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ StatusBarModes

Member Enumeration Documentation

◆ StatusBarMode

Constructor & Destructor Documentation

◆ KStatusBarJobTracker()

◆ ~KStatusBarJobTracker()

Member Function Documentation

◆ description

◆ percent

◆ registerJob()

◆ setStatusBarMode()

◆ slotClean

◆ speed

◆ totalAmount

◆ unregisterJob()

◆ widget()