kio/kio/kfilewriteplugin.h

   1 /* This file is part of the KDE libraries
   2
   3    Copyright (c) 2007 Jos van den Oever <jos@vandenoever.info>
   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 (LGPL) 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 #ifndef KFILEWRITEPLUGIN_H
  21 #define KFILEWRITEPLUGIN_H
  22
  23 #include <kio/kio_export.h>
  24 #include <QtCore/QVariant>
  25
  26 class KUrl;
  27
  28 class KIO_EXPORT KFileWritePlugin : public QObject {
  29     Q_OBJECT
  30     friend class KFileWriterProvider;
  31 public:
  32     /**
  33      * @brief Constructor that initializes the object as a QObject.
  34      **/
  35     KFileWritePlugin(QObject* parent, const QStringList& args);
  36     /**
  37      * @brief Destructor
  38      **/
  39     virtual ~KFileWritePlugin();
  40     /**
  41      * @brief determine if this plugin can write a value into a particular
  42      * resource.
  43      **/
  44     virtual bool canWrite(const KUrl& file, const QString& key) = 0;
  45     /**
  46      * @brief Write a set of values into a resource pointed to by @p file.
  47      **/
  48     virtual bool write(const KUrl& file, const QVariantMap& data) = 0;
  49
  50 private:
  51     class Private;
  52     Private* const d;
  53 };
  54
  55 #endif