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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/
#ifndef IDEVICE_H
#define IDEVICE_H
#include "../projectexplorer_export.h"
#include <coreplugin/id.h>
#include <QList>
#include <QSharedPointer>
#include <QVariantMap>
QT_BEGIN_NAMESPACE
class QWidget;
QT_END_NAMESPACE
namespace QSsh { class SshConnectionParameters; }
namespace Utils { class PortList; }
namespace ProjectExplorer {
namespace Internal { class IDevicePrivate; }
class IDeviceWidget;
// See cpp file for documentation.
class PROJECTEXPLORER_EXPORT IDevice
{
public:
typedef QSharedPointer<IDevice> Ptr;
typedef QSharedPointer<const IDevice> ConstPtr;
enum Origin { ManuallyAdded, AutoDetected };
virtual ~IDevice();
QString displayName() const;
void setDisplayName(const QString &name);
// Provide some information on the device suitable for formated
// output, e.g. in tool tips. Get a list of name value pairs.
class DeviceInfoItem {
public:
DeviceInfoItem(const QString &k, const QString &v) : key(k), value(v) { }
QString key;
QString value;
};
typedef QList<DeviceInfoItem> DeviceInfo;
virtual DeviceInfo deviceInformation() const;
Core::Id type() const;
bool isAutoDetected() const;
Core::Id id() const;
virtual QString displayType() const = 0;
virtual IDeviceWidget *createWidget() = 0;
virtual QList<Core::Id> actionIds() const = 0;
virtual QString displayNameForActionId(Core::Id actionId) const = 0;
virtual void executeAction(Core::Id actionId, QWidget *parent = 0) const = 0;
enum DeviceState { DeviceReadyToUse, DeviceConnected, DeviceDisconnected, DeviceStateUnknown };
DeviceState deviceState() const;
void setDeviceState(const DeviceState state);
QString deviceStateToString() const;
virtual void fromMap(const QVariantMap &map);
virtual QVariantMap toMap() const;
virtual Ptr clone() const = 0;
static Core::Id invalidId();
static Core::Id typeFromMap(const QVariantMap &map);
static Core::Id idFromMap(const QVariantMap &map);
static QString defaultPrivateKeyFilePath();
static QString defaultPublicKeyFilePath();
QSsh::SshConnectionParameters sshParameters() const;
void setSshParameters(const QSsh::SshConnectionParameters &sshParameters);
Utils::PortList freePorts() const;
void setFreePorts(const Utils::PortList &freePorts);
protected:
IDevice();
IDevice(Core::Id type, Origin origin, Core::Id id = Core::Id());
IDevice(const IDevice &other);
Ptr sharedFromThis();
ConstPtr sharedFromThis() const;
private:
IDevice &operator=(const IDevice &); // Unimplemented.
Internal::IDevicePrivate *d;
};
} // namespace ProjectExplorer
#endif // IDEVICE_H
|