File indexing completed on 2024-05-26 05:28:40

0001 /* Copyright (C) 2013 Pali Rohár <pali.rohar@gmail.com>
0002 
0003    This file is part of the Trojita Qt IMAP e-mail client,
0004    http://trojita.flaska.net/
0005 
0006    This program is free software; you can redistribute it and/or
0007    modify it under the terms of the GNU General Public License as
0008    published by the Free Software Foundation; either version 2 of
0009    the License or (at your option) version 3 or any later version
0010    accepted by the membership of KDE e.V. (or its successor approved
0011    by the membership of KDE e.V.), which shall act as a proxy
0012    defined in Section 14 of version 3 of the license.
0013 
0014    This program is distributed in the hope that it will be useful,
0015    but WITHOUT ANY WARRANTY; without even the implied warranty of
0016    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0017    GNU General Public License for more details.
0018 
0019    You should have received a copy of the GNU General Public License
0020    along with this program.  If not, see <http://www.gnu.org/licenses/>.
0021 */
0022 
0023 #ifndef TROJITA_PLUGIN_JOB
0024 #define TROJITA_PLUGIN_JOB
0025 
0026 #include <QObject>
0027 #include "configure-plugins.cmake.h"
0028 
0029 #if defined(WITH_SHARED_PLUGINS)
0030 #  if defined(BUILDING_LIBTROJITA_PLUGINS)
0031 #    define PLUGINMANAGER_EXPORT Q_DECL_EXPORT
0032 #  else
0033 #    define PLUGINMANAGER_EXPORT Q_DECL_IMPORT
0034 #  endif
0035 #else
0036 #  define PLUGINMANAGER_EXPORT
0037 #endif
0038 
0039 
0040 namespace Plugins
0041 {
0042 
0043 class PLUGINMANAGER_EXPORT PluginJob : public QObject
0044 {
0045     Q_OBJECT
0046 
0047 public:
0048     ~PluginJob();
0049 
0050     /** @short Return true if auto delete is set */
0051     bool autoDelete();
0052 
0053     /** @short Set auto delete, when b is true, object is deleted after finish via deleteLater */
0054     void setAutoDelete(bool b);
0055 
0056     /** @short Return true if job running */
0057     bool isRunning();
0058 
0059 public slots:
0060     /** @short Start job - it will call doStart() via event loop */
0061     void start();
0062 
0063     /** @short Stop job */
0064     void stop();
0065 
0066 private:
0067     bool m_running;
0068     bool m_autoDelete;
0069 
0070 protected:
0071     PluginJob(QObject *parent);
0072 
0073 protected slots:
0074     /** @short Reimplement starting job */
0075     virtual void doStart() = 0;
0076 
0077     /** @short Reimplement stopping job */
0078     virtual void doStop() = 0;
0079 
0080     /** @short Call when job finish (successful or unsuccessful) */
0081     void finished();
0082 
0083     friend class PasswordJob;
0084 };
0085 
0086 }
0087 
0088 #endif //TROJITA_PLUGIN_JOB
0089 
0090 // vim: set et ts=4 sts=4 sw=4