git.maemo.org Git - buliscores/blob - qjson/src/serializerrunnable.h

   1 /* This file is part of qjson
   2  *
   3  * Copyright (C) 2009 Frank Osterfeld <osterfeld@kde.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public License
  16  * along with this library; see the file COPYING.LIB.  If not, write to
  17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef SERIALIZERRUNNABLE_H
  22 #define SERIALIZERRUNNABLE_H
  23
  24 #include "qjson_export.h"
  25
  26 #include <QtCore/QObject>
  27 #include <QtCore/QRunnable>
  28
  29 class QByteArray;
  30 class QString;
  31 class QVariant;
  32
  33 namespace QJson {
  34   /**
  35   * @brief Convenience class for converting JSON data to QVariant objects using a dedicated thread
  36   */
  37   class QJSON_EXPORT SerializerRunnable  : public QObject, public QRunnable
  38   {
  39     Q_OBJECT
  40     public:
  41       /**
  42       * This signal is emitted when the conversion process has been completed
  43       * @param data contains the JSON data that has to be converted
  44       * @param parent parent of the object
  45       **/
  46       explicit SerializerRunnable(QObject* parent = 0);
  47       ~SerializerRunnable();
  48
  49       /**
  50        * Sets the json object to serialize.
  51        *
  52        * @param json QVariant containing the json representation to be serialized
  53        */
  54       void setJsonObject( const QVariant& json );
  55
  56       /* reimp */ void run();
  57
  58     Q_SIGNALS:
  59       /**
  60       * This signal is emitted when the serialization process has been completed
  61       * @param serialized contains the result of the serialization
  62       * @param ok if a serialization error occurs ok is set to false, otherwise it's set to true.
  63       * @param error_msg contains a string explaining the failure reason
  64       **/
  65       void parsingFinished(const QByteArray& serialized, bool ok, const QString& error_msg);
  66
  67     private:
  68       Q_DISABLE_COPY(SerializerRunnable)
  69       class Private;
  70       Private* const d;
  71   };
  72 }
  73
  74 #endif // SERIALIZERRUNNABLE_H