RunConfiguration Class

(ProjectExplorer::RunConfiguration)

The RunConfiguration class is the base class for a run configuration. More...

Header: #include <RunConfiguration>
Inherits: ProjectExplorer::ProjectConfiguration

Public Types

enum ConfigurationState { Configured, UnConfigured, Waiting }

Public Functions

virtual Abi abi() const
void addExtraAspect(IRunConfigurationAspect *aspect)
virtual QString buildSystemTarget() const
virtual QWidget *createConfigurationWidget() = 0
virtual Utils::OutputFormatter *createOutputFormatter() const
virtual QString disabledReason() const
virtual ConfigurationState ensureConfigured(QString *errorMessage = nullptr)
IRunConfigurationAspect *extraAspect(Core::Id id) const
T *extraAspect() const
QList<IRunConfigurationAspect *> extraAspects() const
virtual bool isConfigured() const
virtual bool isEnabled() const
Target *target() const

Signals

Protected Functions

RunConfiguration(Target *parent, Core::Id id)
RunConfiguration(Target *parent, RunConfiguration *source)
BuildConfiguration *activeBuildConfiguration() const

Detailed Description

The RunConfiguration class is the base class for a run configuration.

A run configuration specifies how a target should be run, while a runner does the actual running.

All RunControls and the target hold a shared pointer to the run configuration. That is, the lifetime of the run configuration might exceed the life of the target. The user might still have a RunControl running (or output tab of that RunControl open) and yet unloaded the target.

Also, a run configuration might be already removed from the list of run configurations for a target, but still be runnable via the output tab.

Member Type Documentation

enum RunConfiguration::ConfigurationState

Member Function Documentation

[protected] RunConfiguration::RunConfiguration(Target *parent, Core::Id id)

Default constructs an instance of RunConfiguration.

[protected] RunConfiguration::RunConfiguration(Target *parent, RunConfiguration *source)

Default constructs an instance of RunConfiguration.

[virtual] Abi RunConfiguration::abi() const

[protected] BuildConfiguration *RunConfiguration::activeBuildConfiguration() const

void RunConfiguration::addExtraAspect(IRunConfigurationAspect *aspect)

[virtual] QString RunConfiguration::buildSystemTarget() const

[signal] void RunConfiguration::configurationFinished()

[pure virtual] QWidget *RunConfiguration::createConfigurationWidget()

[virtual] Utils::OutputFormatter *RunConfiguration::createOutputFormatter() const

[virtual] QString RunConfiguration::disabledReason() const

[signal] void RunConfiguration::enabledChanged()

[virtual] ConfigurationState RunConfiguration::ensureConfigured(QString *errorMessage = nullptr)

IRunConfigurationAspect *RunConfiguration::extraAspect(Core::Id id) const

T *RunConfiguration::extraAspect() const

QList<IRunConfigurationAspect *> RunConfiguration::extraAspects() const

Returns extra aspects.

See also ProjectExplorer::IRunConfigurationAspect.

[virtual] bool RunConfiguration::isConfigured() const

[virtual] bool RunConfiguration::isEnabled() const

Checks whether a run configuration is enabled.

[signal] void RunConfiguration::requestRunActionsUpdate()

Target *RunConfiguration::target() const