src/plugins/coreplugin/ifilewizardextension.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 IFILEWIZARDEXTENSION_H
  34 #define IFILEWIZARDEXTENSION_H
  35
  36 #include <coreplugin/core_global.h>
  37
  38 #include <QtCore/QObject>
  39 #include <QtCore/QList>
  40
  41 QT_BEGIN_NAMESPACE
  42 class QWizardPage;
  43 QT_END_NAMESPACE
  44
  45 namespace Core {
  46
  47 class IWizard;
  48 class GeneratedFile;
  49
  50 /*!
  51   Hook to add generic wizard pages to implementations of IWizard.
  52   Used e.g. to add "Add to Project File/Add to version control" page
  53   */
  54 class CORE_EXPORT IFileWizardExtension : public QObject
  55 {
  56     Q_OBJECT
  57 public:
  58     /* Return a list of pages to be added to the Wizard (empty list if not
  59      * applicable). */
  60     virtual QList<QWizardPage *> extensionPages(const IWizard *wizard) = 0;
  61
  62     /* Process the files using the extension parameters */
  63     virtual bool process(const QList<GeneratedFile> &files,
  64                          bool *removeOpenProjectAttribute,
  65                          QString *errorMessage) = 0;
  66
  67 public slots:
  68     /* Notification about the first extension page being shown. */
  69     virtual void firstExtensionPageShown(const QList<GeneratedFile> &files) {
  70         Q_UNUSED(files)
  71         }
  72 };
  73
  74 } // namespace Core
  75
  76 #endif // IFILEWIZARDEXTENSION_H