ProjectExplorerPlugin Class | Extending Qt Creator Manual

Extending Qt Creator Manual | ProjectExplorerPlugin

Extending Qt Creator Manual 4.5.0

# ProjectExplorerPlugin Class

(ProjectExplorer::ProjectExplorerPlugin)

The ProjectExplorerPlugin class contains static accessor and utility functions to obtain the current project, open projects, and so on. More...

Header: | #include <ProjectExplorerPlugin>
Inherits: | ExtensionSystem::IPlugin

- List of all members, including inherited members

## Public Types

class | OpenProjectResult

## Public Functions

| ProjectExplorerPlugin()
| ~ProjectExplorerPlugin() override

## Reimplemented Public Functions

virtual ShutdownFlag | aboutToShutdown() override
virtual bool | delayedInitialize() override
virtual void | extensionsInitialized() override
virtual bool | initialize(const QStringList &arguments, QString *errorMessage) override

- 10 public functions inherited from ExtensionSystem::IPlugin

## Static Public Members

bool | canRunStartupProject(Core::Id runMode, QString *whyNot = nullptr)
ProjectExplorerPlugin * | instance()
bool | isProjectFile(const Utils::FileName &filePath)
OpenProjectResult | openProject(const QString &fileName)
void | openProjectWelcomePage(const QString &fileName)
OpenProjectResult | openProjects(const QStringList &fileNames)
Internal::ProjectExplorerSettings | projectExplorerSettings()
QStringList | projectFilePatterns()
QList<QPair<QString, QString> > | recentProjects()
void | renameFile(Node *node, const QString &newFilePath)
void | runProject(Project *pro, Core::Id, const bool forceSkipDeploy = false)
void | runRunConfiguration(RunConfiguration *rc, Core::Id runMode, const bool forceSkipDeploy = false)
void | runStartupProject(Core::Id runMode, bool forceSkipDeploy = false)
bool | saveModifiedFiles()
void | setProjectExplorerSettings(const Internal::ProjectExplorerSettings &pes)
void | showContextMenu(QWidget *view, const QPoint &globalPos, Node *node)
void | showOpenProjectError(const OpenProjectResult &result)
void | showRunErrorMessage(const QString &errorMessage)
void | startRunControl(RunControl *runControl)
void | unloadProject(Project *project)

### Additional Inherited Members

- 1 signal inherited from ExtensionSystem::IPlugin

## Detailed Description

The ProjectExplorerPlugin class contains static accessor and utility functions to obtain the current project, open projects, and so on.

## Member Function Documentation

### ProjectExplorerPlugin::ProjectExplorerPlugin()

Default constructs an instance of ProjectExplorerPlugin.

### ProjectExplorerPlugin::~ProjectExplorerPlugin()

Destroys the instance of ProjectExplorerPlugin.

### `[override virtual]` ShutdownFlag ProjectExplorerPlugin::aboutToShutdown()

### `[static]` bool ProjectExplorerPlugin::canRunStartupProject(Core::Id runMode, QString *whyNot = nullptr)

### `[override virtual]` bool ProjectExplorerPlugin::delayedInitialize()

### `[override virtual]` void ProjectExplorerPlugin::extensionsInitialized()

### `[override virtual]` bool ProjectExplorerPlugin::initialize(const QStringList &arguments, QString *errorMessage)

### `[static]` ProjectExplorerPlugin *ProjectExplorerPlugin::instance()

### `[static]` bool ProjectExplorerPlugin::isProjectFile(const Utils::FileName &filePath)

### `[static]` OpenProjectResult ProjectExplorerPlugin::openProject(const QString &fileName)

### `[static]` void ProjectExplorerPlugin::openProjectWelcomePage(const QString &fileName)

### `[static]` OpenProjectResult ProjectExplorerPlugin::openProjects(const QStringList &fileNames)

### `[static]` Internal::ProjectExplorerSettings ProjectExplorerPlugin::projectExplorerSettings()

See also setProjectExplorerSettings().

### `[static]` QStringList ProjectExplorerPlugin::projectFilePatterns()

### `[static]` QList<QPair<QString, QString> > ProjectExplorerPlugin::recentProjects()

### `[static]` void ProjectExplorerPlugin::renameFile(Node *node, const QString &newFilePath)

### `[static]` void ProjectExplorerPlugin::runProject(Project *pro, Core::Id, const bool forceSkipDeploy = false)

### `[static]` void ProjectExplorerPlugin::runRunConfiguration(RunConfiguration *rc, Core::Id runMode, const bool forceSkipDeploy = false)

### `[static]` void ProjectExplorerPlugin::runStartupProject(Core::Id runMode, bool forceSkipDeploy = false)

### `[static]` bool ProjectExplorerPlugin::saveModifiedFiles()

### `[static]` void ProjectExplorerPlugin::setProjectExplorerSettings(const Internal::ProjectExplorerSettings &pes)

See also projectExplorerSettings().

### `[static]` void ProjectExplorerPlugin::showContextMenu(QWidget *view, const QPoint &globalPos, Node *node)

### `[static]` void ProjectExplorerPlugin::showOpenProjectError(const OpenProjectResult &result)

### `[static]` void ProjectExplorerPlugin::showRunErrorMessage(const QString &errorMessage)

### `[static]` void ProjectExplorerPlugin::startRunControl(RunControl *runControl)

### `[static]` void ProjectExplorerPlugin::unloadProject(Project *project)