diff --git a/src/lib/jobs/kjobuidelegate.cpp b/src/lib/jobs/kjobuidelegate.cpp index 828492d..a9b891a 100644 --- a/src/lib/jobs/kjobuidelegate.cpp +++ b/src/lib/jobs/kjobuidelegate.cpp @@ -1,105 +1,115 @@ /* This file is part of the KDE libraries SPDX-FileCopyrightText: 2000 Stephan Kulow SPDX-FileCopyrightText: 2000 David Faure SPDX-FileCopyrightText: 2006 Kevin Ottens SPDX-License-Identifier: LGPL-2.0-or-later */ #include "kjobuidelegate.h" #include "kjob.h" class Q_DECL_HIDDEN KJobUiDelegate::Private { public: Private(KJobUiDelegate *delegate) : q(delegate), job(nullptr), autoErrorHandling(false), autoWarningHandling(true) { } KJobUiDelegate *const q; KJob *job; bool autoErrorHandling : 1; bool autoWarningHandling : 1; void connectJob(KJob *job); void _k_result(); }; KJobUiDelegate::KJobUiDelegate() : QObject(), d(new Private(this)) { +} +KJobUiDelegate::KJobUiDelegate(Flags flags) + : QObject(), d(new Private(this)) +{ + if (flags & AutoErrorHandlingEnabled) { + d->autoErrorHandling = true; + } + if (flags & AutoWarningHandlingEnabled) { + d->autoWarningHandling = true; + } } KJobUiDelegate::~KJobUiDelegate() { delete d; } bool KJobUiDelegate::setJob(KJob *job) { if (d->job != nullptr) { return false; } d->job = job; setParent(job); return true; } KJob *KJobUiDelegate::job() const { return d->job; } void KJobUiDelegate::showErrorMessage() { } void KJobUiDelegate::setAutoErrorHandlingEnabled(bool enable) { d->autoErrorHandling = enable; } bool KJobUiDelegate::isAutoErrorHandlingEnabled() const { return d->autoErrorHandling; } void KJobUiDelegate::setAutoWarningHandlingEnabled(bool enable) { d->autoWarningHandling = enable; } bool KJobUiDelegate::isAutoWarningHandlingEnabled() const { return d->autoWarningHandling; } void KJobUiDelegate::slotWarning(KJob *job, const QString &plain, const QString &rich) { Q_UNUSED(job) Q_UNUSED(plain) Q_UNUSED(rich) } void KJobUiDelegate::connectJob(KJob *job) { connect(job, &KJob::result, this, [this](){ d->_k_result();} ); connect(job, &KJob::warning, this, &KJobUiDelegate::slotWarning); } void KJobUiDelegate::Private::_k_result() { if (job->error() && autoErrorHandling) { q->showErrorMessage(); } } #include "moc_kjobuidelegate.cpp" diff --git a/src/lib/jobs/kjobuidelegate.h b/src/lib/jobs/kjobuidelegate.h index 42e8dab..4c88f51 100644 --- a/src/lib/jobs/kjobuidelegate.h +++ b/src/lib/jobs/kjobuidelegate.h @@ -1,127 +1,149 @@ /* This file is part of the KDE libraries SPDX-FileCopyrightText: 2000 Stephan Kulow SPDX-FileCopyrightText: 2000 David Faure SPDX-FileCopyrightText: 2006 Kevin Ottens SPDX-License-Identifier: LGPL-2.0-or-later */ #ifndef KJOBUIDELEGATE_H #define KJOBUIDELEGATE_H #include #include class KJob; /** * @class KJobUiDelegate kjobuidelegate.h KJobUiDelegate * * 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 KJob */ class KCOREADDONS_EXPORT KJobUiDelegate : public QObject { Q_OBJECT public: + + /** + * Flags for the constructor, to enable automatic handling of errors and/or warnings + * @since 5.70 + */ + enum Flag { + AutoHandlingDisabled = 0, ///< No automatic handling (default) + AutoErrorHandlingEnabled = 1, ///< Equivalent to setAutoErrorHandlingEnabled(true) + AutoWarningHandlingEnabled = 2, ///< Equivalent to setAutoWarningHandlingEnabled(true) + AutoHandlingEnabled = AutoErrorHandlingEnabled | AutoWarningHandlingEnabled ///< Enables both error and warning handling + }; + Q_DECLARE_FLAGS(Flags, Flag) + /** * Constructs a new KJobUiDelegate. */ KJobUiDelegate(); + /** + * Constructs a new KJobUiDelegate with a flags argument. + * @param flags allows to enable automatic error/warning handling + * @since 5.70 + */ + KJobUiDelegate(Flags flags); // KF6 TODO merge with default constructor, using AutoHandlingDisabled as default value + /** * Destroys a KJobUiDelegate. */ ~KJobUiDelegate() override; protected: /** * Attach this UI delegate to a job. Once attached it'll track the job events. * * @return true if the job we're correctly attached to the job, false otherwise. */ virtual bool setJob(KJob *job); protected: /** * Retrieves the current job this UI delegate is attached to. * * @return current job this UI delegate is attached to, or @c nullptr if * this UI delegate is not tracking any job */ KJob *job() const; friend class KJob; public: /** * Display a dialog box to inform the user of the error given by * this job. * Only call if error is not 0, and only in the slot connected * to result. */ virtual void showErrorMessage(); /** * 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 * * @param enable enable or disable automatic error handling * @see isAutoErrorHandlingEnabled() */ void setAutoErrorHandlingEnabled(bool enable); /** * Returns whether automatic error handling is enabled or disabled. * See also setAutoErrorHandlingEnabled . * @return true if automatic error handling is enabled * @see setAutoErrorHandlingEnabled() */ bool isAutoErrorHandlingEnabled() const; /** * 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 * * @param enable enable or disable automatic warning handling * @see isAutoWarningHandlingEnabled() */ void setAutoWarningHandlingEnabled(bool enable); /** * Returns whether automatic warning handling is enabled or disabled. * See also setAutoWarningHandlingEnabled . * @return true if automatic warning handling is enabled * @see setAutoWarningHandlingEnabled() */ bool isAutoWarningHandlingEnabled() const; protected Q_SLOTS: virtual void slotWarning(KJob *job, const QString &plain, const QString &rich); private: void connectJob(KJob *job); class Private; Private *const d; }; +Q_DECLARE_OPERATORS_FOR_FLAGS(KJobUiDelegate::Flags) + #endif // KJOBUIDELEGATE_H