ProcessParameters Class
(ProjectExplorer::ProcessParameters)The ProcessParameters class aggregates all parameters needed to start a process. More...
Header: | #include <ProcessParameters> |
Public Functions
ProcessParameters() | |
QString | arguments() const |
QString | command() const |
bool | commandMissing() const |
QString | effectiveArguments() const |
QString | effectiveCommand() const |
QString | effectiveWorkingDirectory() const |
Utils::Environment | environment() const |
Utils::MacroExpander * | macroExpander() const |
QString | prettyArguments() const |
QString | prettyCommand() const |
void | resolveAll() |
void | setArguments(const QString &arguments) |
void | setCommand(const QString &cmd) |
void | setEnvironment(const Utils::Environment &env) |
void | setMacroExpander(Utils::MacroExpander *mx) |
void | setWorkingDirectory(const QString &workingDirectory) |
QString | summary(const QString &displayName) const |
QString | summaryInWorkdir(const QString &displayName) const |
QString | workingDirectory() const |
Detailed Description
The ProcessParameters class aggregates all parameters needed to start a process.
It offers a set of functions which expand macros and environment variables inside the raw parameters to obtain final values for starting a process or for display purposes.
See also ProjectExplorer::AbstractProcessStep.
Member Function Documentation
ProcessParameters::ProcessParameters()
Default constructs an instance of ProcessParameters.
QString ProcessParameters::arguments() const
See also setArguments().
QString ProcessParameters::command() const
See also setCommand().
bool ProcessParameters::commandMissing() const
Returns true
if effectiveCommand() would return only a fallback.
QString ProcessParameters::effectiveArguments() const
QString ProcessParameters::effectiveCommand() const
Gets the fully expanded command name to run.
QString ProcessParameters::effectiveWorkingDirectory() const
Gets the fully expanded working directory.
Utils::Environment ProcessParameters::environment() const
See also setEnvironment().
Utils::MacroExpander *ProcessParameters::macroExpander() const
See also setMacroExpander().
QString ProcessParameters::prettyArguments() const
QString ProcessParameters::prettyCommand() const
void ProcessParameters::resolveAll()
void ProcessParameters::setArguments(const QString &arguments)
Sets the command line arguments used by the process.
See also arguments().
void ProcessParameters::setCommand(const QString &cmd)
Sets the executable to run.
See also command().
void ProcessParameters::setEnvironment(const Utils::Environment &env)
Sets the environment env for running the command.
Should be called from init().
See also environment().
void ProcessParameters::setMacroExpander(Utils::MacroExpander *mx)
Sets the macro expander mx to use on the command, arguments, and working dir.
Note: The caller retains ownership of the object.
See also macroExpander().
void ProcessParameters::setWorkingDirectory(const QString &workingDirectory)
Sets the workingDirectory for the process for a build configuration.
Should be called from init().
See also workingDirectory().
QString ProcessParameters::summary(const QString &displayName) const
QString ProcessParameters::summaryInWorkdir(const QString &displayName) const
QString ProcessParameters::workingDirectory() const
See also setWorkingDirectory().