Extending Qt Creator Manual | ProjectExplorerPlugin

Extending Qt Creator Manual 4.7.1

# ProjectExplorerPlugin Class

(Debugger::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>

- List of all members, including inherited members

## Public Types

class | OpenProjectResult

## Public Functions

| ProjectExplorerPlugin()
| ~ProjectExplorerPlugin()
int | aboutToShutdown() override
bool | delayedInitialize()
void | extensionsInitialized()
void | fileListChanged()
bool | initialize(const int &arguments, Debugger::QString *errorMessage) override
void | recentProjectsChanged()
void | settingsChanged()
void | updateRunActions()

## Static Public Members

void | addExistingFiles(Debugger::ProjectExplorer::FolderNode *folderNode, const int &filePaths)
void | buildProject(Debugger::ProjectExplorer::Project *p)
bool | canRunStartupProject(Core::Id runMode, Debugger::QString *whyNot = nullptr)
Debugger::QString | directoryFor(Debugger::ProjectExplorer::Node *node)
Debugger::QString | displayNameForStepId(Core::Id stepId)
void | initiateInlineRenaming()
Debugger::ProjectExplorer::ProjectExplorerPlugin * | instance()
bool | isProjectFile(const Utils::FileName &filePath)
void | openNewProjectDialog()
void | openOpenProjectDialog()
Debugger::ProjectExplorer::ProjectExplorerPlugin::OpenProjectResult | openProject(const Debugger::QString &fileName)
void | openProjectWelcomePage(const Debugger::QString &fileName)
Debugger::ProjectExplorer::ProjectExplorerPlugin::OpenProjectResult | openProjects(const int &fileNames)
const Internal::ProjectExplorerSettings & | projectExplorerSettings()
int | projectFileGlobs()
int | projectFilePatterns()
void | renameFile(Debugger::ProjectExplorer::Node *node, const Debugger::QString &newFilePath)
void | runProject(Debugger::ProjectExplorer::Project *pro, Core::Id, const bool forceSkipDeploy = false)
void | runRunConfiguration(Debugger::ProjectExplorer::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)
Debugger::QThreadPool * | sharedThreadPool()
void | showContextMenu(Debugger::QWidget *view, const Debugger::QPoint &globalPos, Debugger::ProjectExplorer::Node *node)
void | showOpenProjectError(const Debugger::ProjectExplorer::ProjectExplorerPlugin::OpenProjectResult &result)
void | showRunErrorMessage(const Debugger::QString &errorMessage)
void | startRunControl(Debugger::ProjectExplorer::RunControl *runControl)
void | unloadProject(Debugger::ProjectExplorer::Project *project)
void | updateContextMenuActions()

## 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.

### int ProjectExplorerPlugin::aboutToShutdown()

### `[static]` void ProjectExplorerPlugin::addExistingFiles(Debugger::ProjectExplorer::FolderNode *folderNode, const int &filePaths)

### `[static]` void ProjectExplorerPlugin::buildProject(Debugger::ProjectExplorer::Project *p)

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

### bool ProjectExplorerPlugin::delayedInitialize()

### `[static]` Debugger::QString ProjectExplorerPlugin::directoryFor(Debugger::ProjectExplorer::Node *node)

### `[static]` Debugger::QString ProjectExplorerPlugin::displayNameForStepId(Core::Id stepId)

### void ProjectExplorerPlugin::extensionsInitialized()

### void ProjectExplorerPlugin::fileListChanged()

### bool ProjectExplorerPlugin::initialize(const int &arguments, Debugger::QString *errorMessage)

### `[static]` void ProjectExplorerPlugin::initiateInlineRenaming()

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

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

### `[static]` void ProjectExplorerPlugin::openNewProjectDialog()

### `[static]` void ProjectExplorerPlugin::openOpenProjectDialog()

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

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

### `[static]` Debugger::ProjectExplorer::ProjectExplorerPlugin::OpenProjectResult ProjectExplorerPlugin::openProjects(const int &fileNames)

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

See also setProjectExplorerSettings().

### `[static]` int ProjectExplorerPlugin::projectFileGlobs()

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

### void ProjectExplorerPlugin::recentProjectsChanged()

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

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

### `[static]` void ProjectExplorerPlugin::runRunConfiguration(Debugger::ProjectExplorer::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().

### void ProjectExplorerPlugin::settingsChanged()

### `[static]` Debugger::QThreadPool *ProjectExplorerPlugin::sharedThreadPool()

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

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

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

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

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

### `[static]` void ProjectExplorerPlugin::updateContextMenuActions()

### void ProjectExplorerPlugin::updateRunActions()