RunConfiguration Class
(ProjectExplorer::RunConfiguration)The RunConfiguration class is the base class for a run configuration. More...
| Header: | #include <RunConfiguration> |
| Inherits: | StatefulProjectConfiguration |
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 ConfigurationState | ensureConfigured(QString *errorMessage = nullptr) |
| IRunConfigurationAspect * | extraAspect(Core::Id id) const |
| T * | extraAspect() const |
| QList<IRunConfigurationAspect *> | extraAspects() const |
| virtual bool | isConfigured() const |
| Target * | target() const |
- 2 public functions inherited from ProjectExplorer::StatefulProjectConfiguration
- 14 public functions inherited from ProjectExplorer::ProjectConfiguration
- 31 public functions inherited from QObject
Signals
| void | configurationFinished() |
| void | requestRunActionsUpdate() |
- 1 signal inherited from ProjectExplorer::StatefulProjectConfiguration
- 2 signals inherited from ProjectExplorer::ProjectConfiguration
- 2 signals inherited from QObject
Static Public Members
| void | registerAspect() |
| RunConfiguration * | startupRunConfiguration() |
- 1 static public member inherited from ProjectExplorer::ProjectConfiguration
- 10 static public members inherited from QObject
Protected Functions
| RunConfiguration(Target *target, Core::Id id) | |
| BuildConfiguration * | activeBuildConfiguration() const |
| virtual void | updateEnabledState() |
- 1 protected function inherited from ProjectExplorer::StatefulProjectConfiguration
- 9 protected functions inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 1 public variable inherited from QObject
- 2 protected variables inherited from QObject
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 Function Documentation
[protected] RunConfiguration::RunConfiguration(Target *target, Core::Id id)
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] 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
[static] void RunConfiguration::registerAspect()
[signal] void RunConfiguration::requestRunActionsUpdate()
[static] RunConfiguration *RunConfiguration::startupRunConfiguration()
Returns the RunConfiguration of the currently active target of the startup project, if such exists, or nullptr otherwise.