guiapplication.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2016 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_GUIAPPLICATION_H
#define SWIFT_GUI_GUIAPPLICATION_H
 
#include <QCommandLineOption>
#include <QDialog>
#include <QEvent>
#include <QObject>
#include <QPixmap>
#include <QScopedPointer>
#include <QScreen>
#include <QString>
#include <Qt>
 
#include "core/application.h"
#include "gui/enableforframelesswindow.h"
#include "gui/mainwindowaccess.h"
#include "gui/settings/guisettings.h"
#include "gui/settings/updatenotification.h"
#include "gui/splashscreen.h"
#include "gui/stylesheetutility.h"
#include "gui/swiftguiexport.h"
#include "misc/icons.h"
#include "misc/statusmessage.h"
 
class QMenu;
class QWidget;
class QMainWindow;
 
namespace swift::misc
{
    class CLogCategoryList;
}
namespace swift::gui::components
{
    class CApplicationCloseDialog;
    class CUpdateInfoDialog;
} // namespace swift::gui::components
namespace swift::gui
{
    class SWIFT_GUI_EXPORT CGuiApplication : public swift::core::CApplication, public IMainWindowAccess
    {
        Q_OBJECT
        Q_INTERFACES(swift::gui::IMainWindowAccess)
 
    public:
        static CGuiApplication *instance();
 
        static const QStringList &getLogCategories();
 
        static const QString &settingsOrganization();
 
        static bool removeAllWindowsSwiftRegistryEntries();
 
        explicit CGuiApplication(
            const QString &applicationName = executable(),
            swift::misc::CApplicationInfo::Application application = swift::misc::CApplicationInfo::Unknown,
            const QPixmap &icon = swift::misc::CIcons::swift64());
 
        ~CGuiApplication() override;
 
        void addWindowStateOption();
 
        void addWindowModeOption();
 
        void addWindowResetSizeOption();
 
        void addWindowScaleSizeOption();
 
        Qt::WindowState getWindowState() const;
 
        CEnableForFramelessWindow::WindowMode getWindowMode() const;
 
        void processEventsToRefreshGui() const;
 
        void initMainApplicationWidget(QWidget *mainWidget);
 
        void addWindowFlags(Qt::WindowFlags flags);
 
        QString setExtraWindowTitle(const QString &extraInfo,
                                    QWidget *mainWindowWidget = mainApplicationWidget()) const;
 
        void cmdLineErrorMessage(const QString &text, const QString &informativeText) const override;
        void cmdLineErrorMessage(const swift::misc::CStatusMessageList &msgs) const override;
 
        bool isCmdWindowSizeResetSet() const;
 
        bool displayInStatusBar(const swift::misc::CStatusMessage &message) override;
        bool displayInOverlayWindow(const swift::misc::CStatusMessage &message,
                                    std::chrono::milliseconds timeout = std::chrono::milliseconds(0)) override;
        bool displayInOverlayWindow(const swift::misc::CStatusMessageList &messages,
                                    std::chrono::milliseconds timeout = std::chrono::milliseconds(0)) override;
        bool displayInOverlayWindow(const QString &html,
                                    std::chrono::milliseconds timeout = std::chrono::milliseconds(0)) override;
 
        // -------- Splash screen related ---------
        void splashScreen(const QPixmap &pixmap);
 
        // -------- Splash screen related ---------
 
        void addMenuForSettingsAndCache(QMenu &menu);
 
        void addMenuForStyleSheets(QMenu &menu);
 
        void addMenuFile(QMenu &menu);
 
        void addMenuInternals(QMenu &menu);
 
        void addMenuWindow(QMenu &menu);
 
        void openUrl(const swift::misc::network::CUrl &url);
 
        void addMenuHelp(QMenu &menu);
 
        void showHelp(const QString &context = {}) const;
 
        void showHelp(const QObject *qObject) const;
 
        static bool triggerShowHelp(const QWidget *widget, QEvent *event);
 
        const CStyleSheetUtility &getStyleSheetUtility() const;
 
        QString getWidgetStyle() const;
 
        bool reloadStyleSheets();
 
        bool openStandardWidgetStyleSheet();
 
        bool openStandardLogDirectory();
 
        bool openStandardCrashDumpDirectory();
 
        bool updateFont(const QString &fontFamily, const QString &fontSize, const QString &fontStyle,
                        const QString &fontWeight, const QString &fontColor);
 
        bool updateFont(const QString &qss);
 
        bool resetFont();
 
        void setMinimumSizeInCharacters(int widthChars, int heightChars);
 
        void displaySetupLoadFailure(swift::misc::CStatusMessageList msgs) override;
 
        QDialog::DialogCode showCloseDialog(QMainWindow *mainWindow, QCloseEvent *closeEvent);
 
        void triggerNewVersionCheck(int delayedMs);
 
        void gracefulShutdown() override;
 
        bool toggleStayOnTop();
 
        void windowToFront();
        void windowToBack();
        void windowToFrontBackToggle();
 
        void windowMinimizeNormalToggle();
 
        void setSaveMainWidgetState(bool save) { m_saveMainWidgetState = save; }
 
        bool saveWindowGeometryAndState(const QMainWindow *window = CGuiApplication::mainApplicationWindow()) const;
 
        void resetWindowGeometryAndState();
 
        bool restoreWindowGeometryAndState(QMainWindow *window = CGuiApplication::mainApplicationWindow());
 
        static void setWindowIcon(const QPixmap &icon);
 
        static QWidget *mainApplicationWidget();
 
        void registerMainApplicationWidget(QWidget *mainWidget);
 
        bool hasMinimumMappingVersion() const override;
 
        static QMainWindow *mainApplicationWindow();
 
        static swift::gui::IMainWindowAccess *mainWindowAccess();
 
        static void exit(int retcode = 0);
 
        static void highDpiScreenSupport(const QString &scaleFactor = {});
 
        static bool isUsingHighDpiScreenSupport();
 
        static QScreen *currentScreen();
 
        static QRect currentScreenGeometry();
 
        static void modalWindowToFront();
 
        static double parseScaleFactor(int argc, char *argv[]);
 
        static QString scaleFactor(int argc, char *argv[]);
 
        static QString defaultScaleFactorString();
 
    signals:
        void styleSheetsChanged();
 
        void uiObjectTreeReady();
 
        void fontChanged();
 
        void alwaysOnTop(bool onTop);
 
    protected:
        bool parsingHookIn() override;
 
        void onCoreFacadeStarted() override;
 
        void onStartUpCompleted() override;
 
        void checkNewVersion(bool onlyIfNew);
 
        QString getFontInfo() const;
 
        static void registerMetadata();
 
    private:
        QPixmap m_windowIcon; 
        QString m_fontFamily; 
        int m_fontPointSize; 
        int m_minWidthChars = -1; 
        int m_minHeightChars = -1; 
        QCommandLineOption m_cmdWindowStateMinimized { "emptyMinimized" }; 
        QCommandLineOption m_cmdWindowMode { "emptyWindowMode" }; 
        QCommandLineOption m_cmdWindowSizeReset { "emptySizeReset" }; 
        QCommandLineOption m_cmdWindowScaleSize { "emptyScale" }; 
        CStyleSheetUtility m_styleSheetUtility { this }; 
        bool m_uiSetupCompleted = false; 
        bool m_saveMainWidgetState = true; 
        bool m_frontBack = true; 
        bool m_normalizeMinimize = true; 
        QScopedPointer<CSplashScreen> m_splashScreen; 
        components::CUpdateInfoDialog *m_updateDialog = nullptr; 
        components::CApplicationCloseDialog *m_closeDialog =
            nullptr; 
        swift::misc::CSettingReadOnly<settings::TGeneralGui> m_guiSettings { this, &CGuiApplication::settingsChanged };
        swift::misc::CSettingReadOnly<settings::TUpdateNotificationSettings> m_updateSetting {
            this
        }; 
 
        void settingsChanged();
 
        void checkNewVersionMenu();
 
        void adjustPalette();
 
        void onStyleSheetsChanged();
 
        void setCurrentFontValues();
 
        void superviseWindowMinSizes();
 
        static const QString &fileForWindowGeometryAndStateSettings();
 
        static int hashForStateSettingsSchema(const QMainWindow *window);
    };
} // namespace swift::gui
 
extern SWIFT_GUI_EXPORT swift::gui::CGuiApplication *sGui;
 
#endif // SWIFT_GUI_GUIAPPLICATION_H