blob: 25b35c805faae328dbb771ca2e5348de39439c12 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef IPUBLISHING_WIZARD_FACTORY_H
#define IPUBLISHING_WIZARD_FACTORY_H
#include <projectexplorer/projectexplorer_export.h>
#include <extensionsystem/pluginmanager.h>
#include <QList>
#include <QWizard>
namespace ProjectExplorer {
class Project;
/*!
\class ProjectExplorer::IPublishingWizardFactory
\brief Provides an interface for creating wizards to publish a project.
A class implementing this interface is used to create an associated wizard
that allows users to publish their project to a remote facility, e.g. an
app store.
Such a wizard would typically transform the project's content into
a form expected by that facility ("packaging") and also upload it, if possible.
The factory objects have to be added to the global object pool via
\c ExtensionSystem::PluginManager::addObject().
\sa ExtensionSystem::PluginManager::addObject()
*/
class PROJECTEXPLORER_EXPORT IPublishingWizardFactory : public QObject
{
Q_OBJECT
public:
/*!
A short, one-line description of the type of wizard that this
factory can create.
*/
virtual QString displayName() const = 0;
/*!
A longer description explaining the exact purpose of the wizard
created by this factory.
*/
virtual QString description() const = 0;
/*!
Returns true iff the type of wizard that this factory can create
is available for the given project.
*/
virtual bool canCreateWizard(const Project *project) const = 0;
/*!
Creates a wizard that can publish the given project.
Behavior is undefined if canCreateWizard() returns false for
that project.
\return The newly created publishing wizard
\sa canCreateWizard()
*/
virtual QWizard *createWizard(const Project *project) const = 0;
protected:
IPublishingWizardFactory(QObject *parent = 0) : QObject(parent) {}
};
} // namespace ProjectExplorer
#endif // IPUBLISHING_WIZARD_FACTORY_H
|