pilotclient/src/blackgui/guiutility.h

/* Copyright (C) 2014
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKGUI_GUIUTILITY_H
#define BLACKGUI_GUIUTILITY_H

#include "blackgui/blackguiexport.h"
#include "blackmisc/variant.h"

#include <QByteArray>
#include <QSize>
#include <QPoint>
#include <QString>
#include <QWidget>
#include <QWidgetList>
#include <QFont>
#include <QFontMetrics>
#include <QFontMetricsF>
#include <QModelIndexList>

class QCheckBox;
class QComboBox;
class QLayout;
class QMimeData;
class QLineEdit;
class QTabWidget;
class QDialog;
class QLabel;
class QWizard;
class QGraphicsOpacityEffect;
class QAbstractItemModel;

namespace BlackMisc { class CIcon; }
namespace BlackGui
{
    class CEnableForFramelessWindow;
    class COverlayMessagesFrame;
    class COverlayMessagesWizardPage;
    class COverlayMessagesTabWidget;

    //! GUI utilities
    class BLACKGUI_EXPORT CGuiUtility
    {
    public:
        //! Main (frameless enabled) application window
        static CEnableForFramelessWindow *mainFramelessEnabledWindow();

        //! Register main application window widget if this is known
        //! \remark if not set, is is searched from QApplication::topLevelWidgets()
        static void registerMainApplicationWidget(QWidget *mainWidget);

        //! Main application window widget
        static QWidget *mainApplicationWidget();

        //! Device pixel ratio
        static qreal mainApplicationWidgetPixelRatio();

        //! Desktop size
        //! \remark might be scaled depending on CGuiUtility::mainApplicationWidgetPixelRatio
        static QSize desktopSize();

        //! Pysical screen resolution
        //! \remark unscaled
        static QSizeF physicalScreenSize(QWidget *currentWidget = nullptr);

        //! Qt independent implementation
        //! \remark allows to return values before QGuiApplication is initialized
        static QSize physicalScreenSizeOs();

        //! Is main window frameless?
        static bool isMainWindowFrameless();

        //! Info about screens
        static QString screenInformation(const QString &separator = "\n");

        //! Orientation as string
        static const QString &orientationAsString(Qt::ScreenOrientation orientation);

        //! QRect, QSize as string @{
        static const QString rectAsString(const QRect &rect);
        static const QString rectAsString(const QRectF &rect);
        static const QString sizeAsString(const QSize &size);
        static const QString sizeAsString(const QSizeF &size);
        //! @}

        //! Top level widgets with names
        static QWidgetList topLevelApplicationWidgetsWithName();

        //! Position of main widget
        static QPoint mainWidgetGlobalPosition();

        //! Replace count in name such as "stations (4)"
        static QString replaceTabCountValue(const QString &oldName, int count);

        //! Delete hierarchy of layouts
        static void deleteLayout(QLayout *layout, bool deleteWidgets);

        //! Lenient / relaxed
        static bool lenientTitleComparison(const QString &title, const QString &comparison);

        //! Find best match in comboBox
        static bool setComboBoxValueByStartingString(QComboBox *box, const QString &candidate, const QString &unspecified = QString());

        //! Find best match in comboBox
        static bool setComboBoxValueByContainingString(QComboBox *box, const QString &candidate, const QString &unspecified = QString());

        //! Mime data with swift type
        static bool hasSwiftVariantMimeType(const QMimeData *mime);

        //! From text dropped
        static BlackMisc::CVariant fromSwiftDragAndDropData(const QMimeData *mime);

        //! From text dropped
        static BlackMisc::CVariant fromSwiftDragAndDropData(const QByteArray &utf8Data);

        //! Meta type id from dropped data
        static int metaTypeIdFromSwiftDragAndDropData(const QMimeData *mime);

        //! Represented file if any
        static QFileInfo representedMimeFile(const QMimeData *mime);

        //! Is representing existing file
        static bool isMimeRepresentingReadableFile(const QMimeData *mime);

        //! Is representing existing JSON file
        static bool isMimeRepresentingReadableJsonFile(const QMimeData *mime);

        //! Find next BlackGui::COverlayMessages QFrame or other implementing widget
        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;
        }

        //! Find next COverlayMessagesFrame
        static COverlayMessagesFrame *nextOverlayMessageFrame(QWidget *widget, int maxLevels = 10);

        //! Find next COverlayMessagesTabWidget
        static COverlayMessagesTabWidget *nextOverlayMessageTabWidget(QWidget *widget, int maxLevels = 10);

        //! Find next COverlayMessagesWizardPage
        static COverlayMessagesWizardPage *nextOverlayMessageWizardPage(QWidget *widget, int maxLevels = 10);

        //! Metatype
        static const QString &swiftJsonDragAndDropMimeType();

        //! Pseudo readonly state for checkbox
        static void checkBoxReadOnly(QCheckBox *checkBox, bool readOnly);

        //! Pseudo readonly state for checkboxes of widget
        static void checkBoxesReadOnly(QWidget *parent, bool readOnly);

        //! Temp. unhide password
        static void tempUnhidePassword(QLineEdit *lineEdit, int unhideMs = 5000);

        //! Enable/disable all child widgets
        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);
            }
        }

        //! Toggle window flags / stay on top
        static bool toggleStayOnTop(QWidget *widget);

        //! Window flags / stay on top
        static bool stayOnTop(bool onTop, QWidget *widget);

        //! Window on top?
        static bool staysOnTop(QWidget *widget);

        //! From a given widget try to find parent tab widget (where widget is embedded)
        static QTabWidget *parentTabWidget(QWidget *widget, int maxLevels = 5);

        //! Convert to string
        static QString marginsToString(const QMargins &margins);

        //! Convert from string
        static QMargins stringToMargins(const QString &str);

        //! Only the row part and unique (so no rows is twice in the list)
        static QList<int> indexToUniqueRows(const QModelIndexList &indexes);

        //! Clear a model
        static int clearModel(QAbstractItemModel *model);

        //! Is top level widget?
        static bool isTopLevelWidget(QWidget *widget);

        //! Is top level window?
        static bool isTopLevelWindow(QWidget *widget);

        //! Check window type @{
        static bool isQMainWindow(const QWidget *widget);
        static bool isDialog(const QWidget *widget);
        //! @}

        //! Fade in a widget
        static QGraphicsOpacityEffect *fadeInWidget(int durationMs, QWidget *widget, double startValue = 0.0, double endValue = 1.0);

        //! Fade out a widget
        static QGraphicsOpacityEffect *fadeOutWidget(int durationMs, QWidget *widget, double startValue = 1.0, double endValue = 0.0);

        //! Main window font metrics or default metrics
        static QFontMetrics currentFontMetrics();

        //! Main window font metrics or default metrics
        static QFontMetricsF currentFontMetricsF();

        //! Main window font or default font
        static QFont currentFont();

        //! 80 characters width/height
        static QSizeF fontMetrics80Chars(bool withRatio = false);

        //! 43 characters width/height "the quick brown ..."
        static QSizeF fontMetricsLazyDog43Chars(bool withRatio = false);

        //! Estimate size based on current font
        static QSizeF fontMetricsEstimateSize(int xCharacters, int yCharacters, bool withRatio = false);

        //! Center widget to host or screen
        static void centerWidget(QWidget *widget);

        //! Center widget to screen
        static void centerWidget(QWidget *widget, QWidget *host);

        //! Some info about font metrics
        static QString metricsInfo();

        //! Using high DPI screen support
        static bool isUsingHighDpiScreenSupport();

        //! Forces a stylesheet update
        static void forceStyleSheetUpdate(QWidget *widget);

        //! Make sure that the min.sizes to not exceed the screen resolution
        static void superviseMainWindowMinSizes(qreal wRatio = 0.85, qreal hRatio = 0.85);

        //! CIcon as simple HTML image code segment
        static QString asSimpleHtmlImageWidth(const BlackMisc::CIcon &icon, int width = -1);

        //! CIcon as simple HTML image code segment
        static QString asSimpleHtmlImageHeight(const BlackMisc::CIcon &icon, int height = -1);

        //! Find parent dialog if there is any, otherwise null
        static QDialog *findParentDialog(QWidget *widget);

        //! Find parent dialog if there is any, otherwise null
        static QDialog *findParentDialog(QWidget *widget, int maxLevel);

        //! Set elided text
        static void setElidedText(QLabel *label, const QString &text, Qt::TextElideMode mode = Qt::ElideMiddle);

        //! Set elided text
        static void setElidedText(QLabel *label, const QString &shortText, const QString &longText, Qt::TextElideMode mode = Qt::ElideMiddle);

        //! Set button widths for a wizard
        static void setWizardButtonWidths(QWizard *wizard);

    private:
        //! No constructor, use static functions only
        CGuiUtility() {}

        static QWidget *s_mainApplicationWidget;
    };
} // ns

#endif // guard