src/plugins/projectexplorer/publishing/ipublishingwizardfactory.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 #ifndef IPUBLISHING_WIZARD_FACTORY_H
  33 #define IPUBLISHING_WIZARD_FACTORY_H
  34
  35 #include <projectexplorer/projectexplorer_export.h>
  36
  37 #include <extensionsystem/pluginmanager.h>
  38
  39 #include <QtCore/QList>
  40 #include <QtGui/QWizard>
  41
  42 namespace ProjectExplorer {
  43 class Project;
  44
  45 /*!
  46   \class ProjectExplorer::IPublishingWizardFactory
  47
  48   \brief Provides an interface for creating wizards to publish a project.
  49
  50   A class implementing this interface is used to create an associated wizard
  51   that allows users to publish their project to a remote facility, e.g. an
  52   app store.
  53   Such a wizard would typically transform the project's content into
  54   a form expected by that facility ("packaging") and also upload it, if possible.
  55
  56   The factory objects have to be added to the global object pool via
  57   \c ExtensionSystem::PluginManager::addObject().
  58   \sa ExtensionSystem::PluginManager::addObject()
  59 */
  60
  61 class PROJECTEXPLORER_EXPORT IPublishingWizardFactory : public QObject
  62 {
  63     Q_OBJECT
  64     Q_DISABLE_COPY(IPublishingWizardFactory)
  65 public:
  66     /*!
  67       A short, one-line description of the type of wizard that this
  68       factory can create.
  69     */
  70     virtual QString displayName() const=0;
  71
  72     /*!
  73       A longer description explaining the exact purpose of the wizard
  74       created by this factory.
  75     */
  76     virtual QString description() const=0;
  77
  78     /*!
  79       Returns true iff the type of wizard that this factory can create
  80       is available for the given project.
  81     */
  82     virtual bool canCreateWizard(const Project *project) const=0;
  83
  84     /*!
  85       Creates a wizard that can publish the given project.
  86       Behavior is undefined if canCreateWizard() returns false for
  87       that project.
  88       \return The newly created publishing wizard
  89       \sa canCreateWizard()
  90     */
  91     virtual QWizard *createWizard(const Project *project) const=0;
  92
  93 protected:
  94     IPublishingWizardFactory(QObject *parent = 0) : QObject(parent) {}
  95 };
  96
  97 } // namespace ProjectExplorer
  98
  99 #endif // IPUBLISHING_WIZARD_FACTORY_H