KJobUiDelegate Class Reference

#include <KJobUiDelegate>

Inheritance diagram for KJobUiDelegate:

Public Types
enum	Flag { AutoHandlingDisabled = 0 , AutoErrorHandlingEnabled = 1 , AutoWarningHandlingEnabled = 2 , AutoHandlingEnabled = AutoErrorHandlingEnabled | AutoWarningHandlingEnabled }
typedef QFlags< Flag >	Flags

Public Member Functions
	KJobUiDelegate (Flags flags={KJobUiDelegate::AutoHandlingDisabled})
	~KJobUiDelegate () override
bool	isAutoErrorHandlingEnabled () const
bool	isAutoWarningHandlingEnabled () const
void	setAutoErrorHandlingEnabled (bool enable)
void	setAutoWarningHandlingEnabled (bool enable)
virtual void	showErrorMessage ()
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
virtual void	slotWarning (KJob *job, const QString &message)

Protected Member Functions
KJob *	job () const
virtual bool	setJob (KJob *job)
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)

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 all KJob UI delegate.

A UI delegate is responsible for the events of a job and provides a UI for them (an error message box or warning etc.).

See also

KJob

Definition at line 31 of file kjobuidelegate.h.

Member Typedef Documentation

Flags

typedef QFlags< Flag > KJobUiDelegate::Flags

Stores a combination of Flag values.

Definition at line 50 of file kjobuidelegate.h.

Member Enumeration Documentation

Flag

enum KJobUiDelegate::Flag

Flags for the constructor, to enable automatic handling of errors and/or warnings.

See also

Flags

Since

5.70

Enumerator
AutoHandlingDisabled	No automatic handling (default)
AutoErrorHandlingEnabled	Equivalent to setAutoErrorHandlingEnabled(true)
AutoWarningHandlingEnabled	Equivalent to setAutoWarningHandlingEnabled(true)
AutoHandlingEnabled	Enables both error and warning handling.

Definition at line 41 of file kjobuidelegate.h.

Constructor & Destructor Documentation

KJobUiDelegate()

KJobUiDelegate::KJobUiDelegate ( Flags flags = {KJobUiDelegate::AutoHandlingDisabled} )

explicit

Constructs a new KJobUiDelegate with a flags argument.

Parameters

flags

allows to enable automatic error/warning handling

Since

5.70

Definition at line 37 of file kjobuidelegate.cpp.

~KJobUiDelegate()

KJobUiDelegate::~KJobUiDelegate ( )

overridedefault

Destroys a KJobUiDelegate.

Member Function Documentation

isAutoErrorHandlingEnabled()

bool KJobUiDelegate::isAutoErrorHandlingEnabled

(

)

const

Returns whether automatic error handling is enabled or disabled.

See also setAutoErrorHandlingEnabled .

Returns

true if automatic error handling is enabled

See also

setAutoErrorHandlingEnabled()

Definition at line 82 of file kjobuidelegate.cpp.

isAutoWarningHandlingEnabled()

bool KJobUiDelegate::isAutoWarningHandlingEnabled

(

)

const

Returns whether automatic warning handling is enabled or disabled.

See also setAutoWarningHandlingEnabled .

Returns

true if automatic warning handling is enabled

See also

setAutoWarningHandlingEnabled()

Definition at line 92 of file kjobuidelegate.cpp.

job()

KJob * KJobUiDelegate::job ( ) const

protected

Retrieves the current job this UI delegate is attached to.

Returns

current job this UI delegate is attached to, or nullptr if this UI delegate is not tracking any job

Definition at line 65 of file kjobuidelegate.cpp.

setAutoErrorHandlingEnabled()

void KJobUiDelegate::setAutoErrorHandlingEnabled

(

bool

enable

)

Enable or disable the automatic error handling.

When automatic error handling is enabled and an error occurs, then showErrorDialog() is called, right before the emission of the result signal.

The default is false.

See also isAutoErrorHandlingEnabled , showErrorDialog

Parameters

enable

enable or disable automatic error handling

See also

isAutoErrorHandlingEnabled()

Definition at line 77 of file kjobuidelegate.cpp.

setAutoWarningHandlingEnabled()

void KJobUiDelegate::setAutoWarningHandlingEnabled

(

bool

enable

)

Enable or disable the automatic warning handling.

When automatic warning handling is enabled and an error occurs, then a message box is displayed with the warning message

The default is true.

See also isAutoWarningHandlingEnabled , showErrorDialog

Parameters

enable

enable or disable automatic warning handling

See also

isAutoWarningHandlingEnabled()

Definition at line 87 of file kjobuidelegate.cpp.

setJob()

bool KJobUiDelegate::setJob ( KJob * job )

protectedvirtual

Attach this UI delegate to a job.

Once attached it'll track the job events.

Returns

true if this UI delegate was successfully attached to job, false otherwise

Note

if this UI delegate is already attached to a job, calling this method will return false.

Reimplemented in KDialogJobUiDelegate.

Definition at line 51 of file kjobuidelegate.cpp.

showErrorMessage()

void KJobUiDelegate::showErrorMessage ( )

virtual

Display to the user the error given by this job.

The default implementation uses qWarning(). Subclasses reimplement this to use something more user-visible such as a message box.

Only call this method if error is not 0, and only in the slot connected to result.

Reimplemented in KNotificationJobUiDelegate.

Definition at line 70 of file kjobuidelegate.cpp.

slotWarning

void KJobUiDelegate::slotWarning ( KJob * job, const QString & message )

protectedvirtualslot

Definition at line 97 of file kjobuidelegate.cpp.

---

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

• kjobuidelegate.h
• kjobuidelegate.cpp