KJobUiDelegate
#include <KJobUiDelegate>

Public Types | |
enum | Flag { AutoHandlingDisabled = 0, AutoErrorHandlingEnabled = 1, AutoWarningHandlingEnabled = 2, AutoHandlingEnabled = AutoErrorHandlingEnabled | AutoWarningHandlingEnabled } |
typedef QFlags< Flag > | Flags |
Public Member Functions | |
KJobUiDelegate () | |
KJobUiDelegate (Flags flags) | |
~KJobUiDelegate () override | |
bool | isAutoErrorHandlingEnabled () const |
bool | isAutoWarningHandlingEnabled () const |
void | setAutoErrorHandlingEnabled (bool enable) |
void | setAutoWarningHandlingEnabled (bool enable) |
virtual void | showErrorMessage () |
![]() | |
QObject (QObject *parent) | |
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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
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 QRegExp ®Exp, 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 |
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 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_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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
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 | 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) |
QThread * | thread () const const |
Protected Slots | |
virtual void | slotWarning (KJob *job, const QString &plain, const QString &rich) |
Protected Member Functions | |
KJob * | job () const |
virtual bool | setJob (KJob *job) |
![]() | |
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 | |
![]() | |
objectName | |
![]() | |
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) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
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
Definition at line 41 of file kjobuidelegate.h.
Constructor & Destructor Documentation
◆ KJobUiDelegate() [1/2]
KJobUiDelegate::KJobUiDelegate | ( | ) |
Constructs a new KJobUiDelegate.
Definition at line 37 of file kjobuidelegate.cpp.
◆ KJobUiDelegate() [2/2]
|
explicit |
Constructs a new KJobUiDelegate with a flags argument.
- Parameters
-
flags allows to enable automatic error/warning handling
- Since
- 5.70
Definition at line 43 of file kjobuidelegate.cpp.
◆ ~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 88 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 98 of file kjobuidelegate.cpp.
◆ job()
|
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 71 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 83 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 93 of file kjobuidelegate.cpp.
◆ setJob()
|
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 tojob
,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 57 of file kjobuidelegate.cpp.
◆ 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 76 of file kjobuidelegate.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Oct 3 2023 04:01:26 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.