feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Fix and complete documentation for ICore

Browse Source 
Change-Id: Id7517ced928e7b4eefb1822f5e9381187169486a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Eike Ziller
2020-05-28 16:26:01 +02:00
parent 26c26c0dad
commit f1720910d4
2 changed files with 228 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/plugins/coreplugin/icore.h
View File

@@ -67,9 +67,6 @@ public:
Low
};
// This should only be used to acccess the signals, so it could
// theoretically return an QObject *. For source compatibility
// it returns a ICore.
static ICore *instance();
static bool isNewItemDialogRunning();
@@ -79,7 +76,7 @@ public:
const QString &defaultLocation = QString(),
const QVariantMap &extraVariables = QVariantMap());
static bool showOptionsDialog(Id page, QWidget *parent = nullptr);
static bool showOptionsDialog(const Id page, QWidget *parent = nullptr);
static QString msgShowOptionsDialog();
static QString msgShowOptionsDialogToolTip();
@@ -97,31 +94,19 @@ public:
static QString userResourcePath();
static QString cacheResourcePath();
static QString installerResourcePath();
static QString pluginPath();
static QString userPluginPath();
static QString libexecPath();
static QString clangExecutable(const QString &clangBinDirectory);
static QString clangTidyExecutable(const QString &clangBinDirectory);
static QString clazyStandaloneExecutable(const QString &clangBinDirectory);
static QString clangIncludeDirectory(const QString &clangVersion,
const QString &clangResourceDirectory);
static QString versionString();
static QString buildCompatibilityString();
static QMainWindow *mainWindow();
static QWidget *dialogParent();
static QStatusBar *statusBar();
static InfoBar *infoBar();
/* Raises and activates the window for the widget. This contains workarounds for X11. */
static void raiseWindow(QWidget *widget);
static IContext *currentContextObject();
static QWidget *currentContextWidget();
static IContext *contextObject(QWidget *widget);
// Adds and removes additional active contexts, these contexts are appended
// to the currently active contexts.
static void updateAdditionalContexts(const Context &remove, const Context &add,
ContextPriority priority = ContextPriority::Low);
static void addAdditionalContext(const Context &context,
@@ -130,7 +115,6 @@ public:
static void addContextObject(IContext *context);
static void removeContextObject(IContext *context);
// manages the minimize, zoom and fullscreen actions for the window
static void registerWindow(QWidget *window, const Context &context);
enum OpenFilesFlags {
@@ -145,8 +129,7 @@ public:
static void addPreCloseListener(const std::function<bool()> &listener);
static QString systemInformation();
static void setupScreenShooter(const QString &name, QWidget *w, const QRect &rc = QRect());
static void restart();
enum SaveSettingsReason {
InitializationDone,
@@ -155,11 +138,6 @@ public:
MainWindowClosing,
};
static void restart();
public slots:
static void saveSettings(SaveSettingsReason reason);
signals:
void coreAboutToOpen();
void coreOpened();
@@ -173,6 +151,19 @@ public:
/* internal use */
static QStringList additionalAboutInformation();
static void appendAboutInformation(const QString &line);
static QString systemInformation();
static void setupScreenShooter(const QString &name, QWidget *w, const QRect &rc = QRect());
static QString pluginPath();
static QString userPluginPath();
static QString clangExecutable(const QString &clangBinDirectory);
static QString clangTidyExecutable(const QString &clangBinDirectory);
static QString clazyStandaloneExecutable(const QString &clangBinDirectory);
static QString clangIncludeDirectory(const QString &clangVersion,
const QString &clangResourceDirectory);
static QString buildCompatibilityString();
static QStatusBar *statusBar();
static void saveSettings(SaveSettingsReason reason);
private:
static void updateNewItemDialogState();