RunConfiguration Class

(ProjectExplorer::RunConfiguration)

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

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

Public Types

enum ConfigurationState { Configured, UnConfigured, Waiting }

Public Functions

~RunConfiguration() override
QString buildKey() const
BuildTargetInfo buildTargetInfo() const
virtual bool canRunForNode(const ProjectExplorer::Node *) const
virtual QWidget *createConfigurationWidget()
Utils::OutputFormatter *createOutputFormatter() const
T *currentSettings(Core::Id id) const
virtual ConfigurationState ensureConfigured(QString *errorMessage = nullptr)
virtual bool isConfigured() const
Target *target() const

Reimplemented Public Functions

virtual QString disabledReason() const override
virtual bool fromMap(const QVariantMap &map) override
virtual bool isActive() const override
virtual Project *project() const override
virtual QVariantMap toMap() const override

Signals

Static Public Members

void registerAspect()
RunConfiguration *startupRunConfiguration()

Protected Functions

RunConfiguration(Target *target, Core::Id id)
BuildConfiguration *activeBuildConfiguration() const
virtual void doAdditionalSetup(const RunConfigurationCreationInfo &)
void setOutputFormatter()
virtual void updateEnabledState()

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.

The target owns the RunConfiguraitons and a RunControl will need to copy all necessary data as the RunControl may continue to exist after the RunConfiguration has been destroyed.

A RunConfiguration disables itself when the project is parsing or has no parsing data available. The disabledReason() method can be used to get a user-facing string describing why the RunConfiguration considers itself unfit for use.

Override updateEnabledState() to change the enabled state handling. Override disabledReasons() to provide better/more descriptions to the user.

Connect signals that may change enabled state of your RunConfiguration to updateEnabledState.

Member Type Documentation

enum RunConfiguration::ConfigurationState

Member Function Documentation

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

Default constructs an instance of RunConfiguration.

RunConfiguration::~RunConfiguration()

Destroys the instance of RunConfiguration.

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

QString RunConfiguration::buildKey() const

BuildTargetInfo RunConfiguration::buildTargetInfo() const

[virtual] bool RunConfiguration::canRunForNode(const ProjectExplorer::Node *) const

[signal] void RunConfiguration::configurationFinished()

[virtual] QWidget *RunConfiguration::createConfigurationWidget()

Utils::OutputFormatter *RunConfiguration::createOutputFormatter() const

T *RunConfiguration::currentSettings(Core::Id id) const

[override virtual] QString RunConfiguration::disabledReason() const

[virtual protected] void RunConfiguration::doAdditionalSetup(const RunConfigurationCreationInfo &)

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

[override virtual] bool RunConfiguration::fromMap(const QVariantMap &map)

[override virtual] bool RunConfiguration::isActive() const

[virtual] bool RunConfiguration::isConfigured() const

[override virtual] Project *RunConfiguration::project() const

[static] void RunConfiguration::registerAspect()

[signal] void RunConfiguration::requestRunActionsUpdate()

[protected] void RunConfiguration::setOutputFormatter()

[static] RunConfiguration *RunConfiguration::startupRunConfiguration()

Returns the RunConfiguration of the currently active target of the startup project, if such exists, or nullptr otherwise.

Target *RunConfiguration::target() const

[override virtual] QVariantMap RunConfiguration::toMap() const

[virtual protected] void RunConfiguration::updateEnabledState()