src/plugins/cpaster/fileshareprotocol.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef FILESHAREPROTOCOL_H
  34 #define FILESHAREPROTOCOL_H
  35
  36 #include "protocol.h"
  37
  38 #include <QtCore/QSharedPointer>
  39
  40 namespace CodePaster {
  41
  42 class FileShareProtocolSettingsPage;
  43 struct FileShareProtocolSettings;
  44
  45 /* FileShareProtocol: Allows for pasting via a shared network
  46  * drive by writing XML files. */
  47
  48 class FileShareProtocol : public Protocol
  49 {
  50     Q_OBJECT
  51     Q_DISABLE_COPY(FileShareProtocol)
  52 public:
  53     FileShareProtocol();
  54     virtual ~FileShareProtocol();
  55
  56     virtual QString name() const;
  57     virtual unsigned capabilities() const;
  58     virtual bool hasSettings() const;
  59     virtual Core::IOptionsPage *settingsPage() const;
  60
  61     virtual bool checkConfiguration(QString *errorMessage = 0) const;
  62     virtual void fetch(const QString &id);
  63     virtual void list();
  64     virtual void paste(const QString &text,
  65                        ContentType ct = Text,
  66                        const QString &username = QString(),
  67                        const QString &comment = QString(),
  68                        const QString &description = QString());
  69 private:
  70     const QSharedPointer<FileShareProtocolSettings> m_settings;
  71     FileShareProtocolSettingsPage *m_settingsPage;
  72 };
  73 } // namespace CodePaster
  74
  75 #endif // FILESHAREPROTOCOL_H