Skip to content
Snippets Groups Projects
deployconfiguration.h 3.88 KiB
Newer Older
Tobias Hunger's avatar
Tobias Hunger committed
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
Tobias Hunger's avatar
Tobias Hunger committed
**
** Contact: Nokia Corporation (qt-info@nokia.com)
Tobias Hunger's avatar
Tobias Hunger committed
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
** 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.
Tobias Hunger's avatar
Tobias Hunger committed
**
con's avatar
con committed
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
** 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.
**
con's avatar
con committed
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
Tobias Hunger's avatar
Tobias Hunger committed
**
**************************************************************************/

#ifndef PROJECTEXPLORER_DEPLOYCONFIGURATION_H
#define PROJECTEXPLORER_DEPLOYCONFIGURATION_H

#include "projectexplorer_export.h"

#include "projectconfiguration.h"
Tobias Hunger's avatar
Tobias Hunger committed
#include "namedwidget.h"

#include <QString>

QT_FORWARD_DECLARE_CLASS(QStringList)
Tobias Hunger's avatar
Tobias Hunger committed

namespace ProjectExplorer {

class BuildStepList;
class Target;
class DeployConfigurationFactory;
class DeployConfigurationWidget;

class PROJECTEXPLORER_EXPORT DeployConfiguration : public ProjectConfiguration
{
    Q_OBJECT

public:
    // ctors are protected
    virtual ~DeployConfiguration();

    BuildStepList *stepList() const;

    virtual QVariantMap toMap() const;

    virtual DeployConfigurationWidget *configurationWidget() const;

    virtual bool isEnabled() const;
    virtual QString disabledReason() const;

Tobias Hunger's avatar
Tobias Hunger committed
    Target *target() const;

Tobias Hunger's avatar
Tobias Hunger committed
protected:
    DeployConfiguration(Target *target, const Core::Id id);
Tobias Hunger's avatar
Tobias Hunger committed
    DeployConfiguration(Target *target, DeployConfiguration *source);

    void cloneSteps(DeployConfiguration *source);

    virtual bool fromMap(const QVariantMap &map);

private:
    friend class DeployConfigurationFactory;

    BuildStepList *m_stepList;
};

class PROJECTEXPLORER_EXPORT DeployConfigurationFactory :
    public QObject
{
    Q_OBJECT

public:
    explicit DeployConfigurationFactory(QObject *parent = 0);
    virtual ~DeployConfigurationFactory();

    // used to show the list of possible additons to a target, returns a list of types
    virtual QList<Core::Id> availableCreationIds(Target *parent) const;
Tobias Hunger's avatar
Tobias Hunger committed
    // used to translate the types to names to display to the user
Tobias Hunger's avatar
Tobias Hunger committed
    virtual QString displayNameForId(const Core::Id id) const;
Tobias Hunger's avatar
Tobias Hunger committed

Tobias Hunger's avatar
Tobias Hunger committed
    virtual bool canCreate(Target *parent, const Core::Id id) const;
    virtual DeployConfiguration *create(Target *parent, const Core::Id id);
Tobias Hunger's avatar
Tobias Hunger committed
    // used to recreate the runConfigurations when restoring settings
    virtual bool canRestore(Target *parent, const QVariantMap &map) const;
    virtual DeployConfiguration *restore(Target *parent, const QVariantMap &map);
    virtual bool canClone(Target *parent, DeployConfiguration *product) const;
    virtual DeployConfiguration *clone(Target *parent, DeployConfiguration *product);

signals:
    void availableCreationIdsChanged();
};

class PROJECTEXPLORER_EXPORT DeployConfigurationWidget : public NamedWidget
{
    Q_OBJECT

public:
    explicit DeployConfigurationWidget(QWidget *parent = 0);

    // This is called to set up the config widget before showing it
    virtual void init(DeployConfiguration *dc) = 0;
};

} // namespace ProjectExplorer

Q_DECLARE_METATYPE(ProjectExplorer::DeployConfiguration *)
Tobias Hunger's avatar
Tobias Hunger committed

#endif // PROJECTEXPLORER_DEPLOYCONFIGURATION_H