guiutility.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2014 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_GUIUTILITY_H
#define SWIFT_GUI_GUIUTILITY_H
 
#include <QByteArray>
#include <QDockWidget>
#include <QFont>
#include <QFontMetrics>
#include <QFontMetricsF>
#include <QModelIndexList>
#include <QPoint>
#include <QSize>
#include <QString>
#include <QWidget>
#include <QWidgetList>
#include <QWindow>
 
#include "gui/swiftguiexport.h"
#include "misc/variant.h"
 
class QCheckBox;
class QComboBox;
class QLayout;
class QMimeData;
class QLineEdit;
class QTabWidget;
class QDialog;
class QLabel;
class QWizard;
class QGraphicsOpacityEffect;
class QAbstractItemModel;
 
namespace swift::misc
{
    class CIcon;
}
namespace swift::gui
{
    class CEnableForFramelessWindow;
    class COverlayMessagesFrame;
    class COverlayMessagesWizardPage;
    class COverlayMessagesTabWidget;
 
    class SWIFT_GUI_EXPORT CGuiUtility
    {
    public:
        static CEnableForFramelessWindow *mainFramelessEnabledWindow();
 
        static void registerMainApplicationWidget(QWidget *mainWidget);
 
        static QWidget *mainApplicationWidget();
 
        static qreal mainApplicationWidgetPixelRatio();
 
        static QSize desktopSize();
 
        static QSize physicalScreenSizeOs();
 
        static bool isMainWindowFrameless();
 
        static QString screenInformation(const QString &separator = "\n");
 
        static const QString &orientationAsString(Qt::ScreenOrientation orientation);
 
        static QString rectAsString(const QRect &rect);
        static QString rectAsString(const QRectF &rect);
        static QString sizeAsString(const QSize &size);
        static QString sizeAsString(const QSizeF &size);
 
        static QWidgetList topLevelApplicationWidgetsWithName();
 
        static QPoint mainWidgetGlobalPosition();
 
        static QString replaceTabCountValue(const QString &oldName, int count);
 
        static void deleteLayout(QLayout *layout, bool deleteWidgets);
 
        static bool lenientTitleComparison(const QString &title, const QString &comparison);
 
        static bool setComboBoxValueByStartingString(QComboBox *box, const QString &candidate,
                                                     const QString &unspecified = QString());
 
        static bool setComboBoxValueByContainingString(QComboBox *box, const QString &candidate,
                                                       const QString &unspecified = QString());
 
        static bool hasSwiftVariantMimeType(const QMimeData *mime);
 
        static swift::misc::CVariant fromSwiftDragAndDropData(const QMimeData *mime);
 
        static swift::misc::CVariant fromSwiftDragAndDropData(const QByteArray &utf8Data);
 
        static int metaTypeIdFromSwiftDragAndDropData(const QMimeData *mime);
 
        static QFileInfo representedMimeFile(const QMimeData *mime);
 
        static bool isMimeRepresentingReadableFile(const QMimeData *mime);
 
        static bool isMimeRepresentingReadableJsonFile(const QMimeData *mime);
 
        template <class OverlayWidget>
        static OverlayWidget *nextOverlayMessageWidget(QWidget *widget, int maxLevels = 10)
        {
            if (!widget || maxLevels < 1) { return nullptr; }
            OverlayWidget *o = qobject_cast<OverlayWidget *>(widget);
            if (o) { return o; }
            int cl = 0;
            QWidget *cw = widget->parentWidget();
            while (cl < maxLevels && cw)
            {
                o = qobject_cast<OverlayWidget *>(cw);
                if (o) { return o; }
                cl++;
                cw = cw->parentWidget();
            }
            return nullptr;
        }
 
        static COverlayMessagesFrame *nextOverlayMessageFrame(QWidget *widget, int maxLevels = 10);
 
        static COverlayMessagesTabWidget *nextOverlayMessageTabWidget(QWidget *widget, int maxLevels = 10);
 
        static COverlayMessagesWizardPage *nextOverlayMessageWizardPage(QWidget *widget, int maxLevels = 10);
 
        static const QString &swiftJsonDragAndDropMimeType();
 
        static void checkBoxReadOnly(QCheckBox *checkBox, bool readOnly);
 
        static void checkBoxesReadOnly(QWidget *parent, bool readOnly);
 
        static void tempUnhidePassword(QLineEdit *lineEdit, int unhideMs = 5000);
 
        template <class WIDGET>
        static void childrenSetEnabled(QWidget *parent, bool enabled)
        {
            if (!parent) { return; }
            QList<WIDGET *> children = parent->findChildren<WIDGET *>();
            for (WIDGET *w : children) { w->setEnabled(enabled); }
        }
 
        static bool toggleStayOnTop(QWidget *widget);
 
        static bool stayOnTop(bool onTop, QWidget *widget);
 
        static bool staysOnTop(QWidget *widget);
 
        static QTabWidget *parentTabWidget(QWidget *widget, int maxLevels = 5);
 
        static QString marginsToString(const QMargins &margins);
 
        static QMargins stringToMargins(const QString &str);
 
        static QList<int> indexToUniqueRows(const QModelIndexList &indexes);
 
        static int clearModel(QAbstractItemModel *model);
 
        static bool isTopLevelWidget(QWidget *widget);
 
        static bool isTopLevelWindow(QWidget *widget);
 
        static bool isQMainWindow(const QWidget *widget);
        static bool isDialog(const QWidget *widget);
 
        static void disableMinMaxCloseButtons(QWidget *window);
 
        static QGraphicsOpacityEffect *fadeInWidget(int durationMs, QWidget *widget, double startValue = 0.0,
                                                    double endValue = 1.0);
 
        static QGraphicsOpacityEffect *fadeOutWidget(int durationMs, QWidget *widget, double startValue = 1.0,
                                                     double endValue = 0.0);
 
        static QFontMetrics currentFontMetrics();
 
        static QFontMetricsF currentFontMetricsF();
 
        static QFont currentFont();
 
        static QSizeF fontMetrics80Chars(bool withRatio = false);
 
        static QSizeF fontMetricsLazyDog43Chars(bool withRatio = false);
 
        static QSizeF fontMetricsEstimateSize(int xCharacters, int yCharacters, bool withRatio = false);
 
        static void centerWidget(QWidget *widget);
 
        static void centerWidget(QWidget *widget, QWidget *host);
 
        static QString metricsInfo();
 
        static bool isUsingHighDpiScreenSupport();
 
        static void forceStyleSheetUpdate(QWidget *widget);
 
        static void superviseMainWindowMinSizes(qreal wRatio = 0.85, qreal hRatio = 0.85);
 
        static QString asSimpleHtmlImageWidth(const swift::misc::CIcon &icon, int width = -1);
 
        static QString asSimpleHtmlImageHeight(const swift::misc::CIcon &icon, int height = -1);
 
        static QDialog *findParentDialog(QWidget *widget);
 
        static QDialog *findParentDialog(QWidget *widget, int maxLevel);
 
        static void setElidedText(QLabel *label, const QString &text, Qt::TextElideMode mode = Qt::ElideMiddle);
 
        static void setElidedText(QLabel *label, const QString &shortText, const QString &longText,
                                  Qt::TextElideMode mode = Qt::ElideMiddle);
 
        static void setWizardButtonWidths(QWizard *wizard);
 
        static QWidgetList getAllModallWidgets();
 
        static QStringList getAllWidgetTitles(const QWidgetList &widgets);
 
        static QStringList getAllWidgetNames(const QWidgetList &widgets);
 
        static QList<QDockWidget *> getAllDockWidgets(QWidget *parent, bool floatingOnly);
 
        static QList<QDockWidget *> getAllDockWidgets(QWindow *parent, bool floatingOnly);
 
        static QWidgetList closeAllModalWidgets();
 
        static QStringList closeAllModalWidgetsGetTitles();
 
        static QList<QDockWidget *> closeAllDockWidgets(QWidget *parent, bool floatingOnly);
 
        static QList<QDockWidget *> closeAllDockWidgets(QWindow *parent, bool floatingOnly);
 
        static QStringList closeAllDockWidgetsGetTitles(QWidget *parent, bool floatingOnly);
 
        static QStringList closeAllDockWidgetsGetTitles(QWindow *parent, bool floatingOnly);
 
        static QStringList deleteLaterAllDockWidgetsGetTitles(QWidget *parent, bool floatingOnly);
 
    private:
        CGuiUtility() {}
 
        static QWidget *s_mainApplicationWidget;
    };
} // namespace swift::gui
 
#endif // SWIFT_GUI_GUIUTILITY_H