kit.h 2.76 KB
Newer Older
Tobias Hunger's avatar
Tobias Hunger committed
1 2 3 4 5 6
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
Tobias Hunger's avatar
Tobias Hunger committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
**
**
** 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.
**
**
**************************************************************************/

Tobias Hunger's avatar
Tobias Hunger committed
31 32
#ifndef KIT_H
#define KIT_H
Tobias Hunger's avatar
Tobias Hunger committed
33 34 35 36 37 38 39 40 41 42 43 44 45

#include "projectexplorer_export.h"
#include "task.h"

#include <coreplugin/id.h>

#include <QVariant>

namespace Utils { class Environment; }

namespace ProjectExplorer {

namespace Internal {
Tobias Hunger's avatar
Tobias Hunger committed
46 47
class KitManagerPrivate;
class KitPrivate;
Tobias Hunger's avatar
Tobias Hunger committed
48 49 50
} // namespace Internal

/**
Tobias Hunger's avatar
Tobias Hunger committed
51
 * @brief The Kit class
Tobias Hunger's avatar
Tobias Hunger committed
52
 *
Tobias Hunger's avatar
Tobias Hunger committed
53
 * The kit holds a set of values defining a system targeted by the software
Tobias Hunger's avatar
Tobias Hunger committed
54 55
 * under development.
 */
Tobias Hunger's avatar
Tobias Hunger committed
56
class PROJECTEXPLORER_EXPORT Kit
Tobias Hunger's avatar
Tobias Hunger committed
57 58
{
public:
Tobias Hunger's avatar
Tobias Hunger committed
59 60
    Kit();
    ~Kit();
Tobias Hunger's avatar
Tobias Hunger committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79

    bool isValid() const;
    QList<Task> validate();

    QString displayName() const;
    void setDisplayName(const QString &name);

    bool isAutoDetected() const;
    Core::Id id() const;

    QIcon icon() const;
    QString iconPath() const;
    void setIconPath(const QString &path);

    QVariant value(const Core::Id &key, const QVariant &unset = QVariant()) const;
    bool hasValue(const Core::Id &key) const;
    void setValue(const Core::Id &key, const QVariant &value);
    void removeKey(const Core::Id &key);

Tobias Hunger's avatar
Tobias Hunger committed
80
    bool operator==(const Kit &other) const;
Tobias Hunger's avatar
Tobias Hunger committed
81 82 83 84

    void addToEnvironment(Utils::Environment &env) const;

    QString toHtml();
Tobias Hunger's avatar
Tobias Hunger committed
85
    Kit *clone(bool keepName = false) const;
Tobias Hunger's avatar
Tobias Hunger committed
86 87

private:
88
    // Unimplemented.
Tobias Hunger's avatar
Tobias Hunger committed
89 90
    Kit(const Kit &other);
    void operator=(const Kit &other);
91

Tobias Hunger's avatar
Tobias Hunger committed
92 93 94
    void setAutoDetected(bool detected);
    void setValid(bool valid);

Tobias Hunger's avatar
Tobias Hunger committed
95
    void kitUpdated();
Tobias Hunger's avatar
Tobias Hunger committed
96 97 98 99

    QVariantMap toMap() const;
    bool fromMap(const QVariantMap &value);

Tobias Hunger's avatar
Tobias Hunger committed
100
    Internal::KitPrivate *d;
Tobias Hunger's avatar
Tobias Hunger committed
101

Tobias Hunger's avatar
Tobias Hunger committed
102 103
    friend class KitManager;
    friend class Internal::KitManagerPrivate;
Tobias Hunger's avatar
Tobias Hunger committed
104 105 106 107
};

} // namespace ProjectExplorer

Tobias Hunger's avatar
Tobias Hunger committed
108
Q_DECLARE_METATYPE(ProjectExplorer::Kit *)
Tobias Hunger's avatar
Tobias Hunger committed
109

Tobias Hunger's avatar
Tobias Hunger committed
110
#endif // KIT_H