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