blob: ab4815343d29516374cffe57cd1ee562b3bf9b0f (
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
97
98
|
/****************************************************************************
**
** 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 IDEVICEFACTORY_H
#define IDEVICEFACTORY_H
#include "idevice.h"
#include <projectexplorer/projectexplorer_export.h>
#include <QObject>
#include <QVariantMap>
QT_BEGIN_NAMESPACE
class QWidget;
QT_END_NAMESPACE
namespace ProjectExplorer {
class IDeviceWidget;
/*!
\class ProjectExplorer::IDeviceFactory
\brief Provides an interface for classes providing services related to certain type of device.
The factory objects have to be added to the global object pool via
\c ExtensionSystem::PluginManager::addObject().
\sa ExtensionSystem::PluginManager::addObject()
*/
class PROJECTEXPLORER_EXPORT IDeviceFactory : public QObject
{
Q_OBJECT
public:
/*!
A short, one-line description of what the device type.
*/
virtual QString displayNameForId(Core::Id type) const = 0;
/*!
A list of device types this factory can create.
*/
virtual QList<Core::Id> availableCreationIds() const = 0;
/*!
Check whether this factory can create new devices. This is used to hide
auto-detect-only factories from the listing of possible devices to create.
*/
virtual bool canCreate() const;
/*!
Create a new device. This may or may not open a wizard.
*/
virtual IDevice::Ptr create(Core::Id id) const = 0;
/*!
Check whether this factory can restore a device from the given serialized state.
*/
virtual bool canRestore(const QVariantMap &map) const = 0;
/*!
Loads a device from a serialized state. Will only ever be called if canRestore()
returns true for the given map.
*/
virtual IDevice::Ptr restore(const QVariantMap &map) const = 0;
static IDeviceFactory *find(Core::Id type);
protected:
IDeviceFactory(QObject *parent = 0);
};
} // namespace ProjectExplorer
#endif // IDEVICEFACTORY_H
|
