QTTools.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: QTTools
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/PopupInfo.h>
#include <NDEVR/StringStream.h>
#include <NDEVR/BaseValues.h>
#include <NDEVR/Resource.h>
#include <NDEVR/Translator.h>
#include <NDEVR/Event.h>
#if NDEVR_SUPPORTS_THREADING
#include <QThread>
#endif
#include <QEvent>
#include <QAbstractEventDispatcher>
#include <QMessageBox>
#include <QMetaEnum>
 
class QFontMetrics;
class QMessageBox;
class QFont;
class QStyle;
class QColor;
class QFile;
class QSurfaceFormat;
class QScreen;
class QWindow;
 
namespace NDEVR
{
    class RGBColor;
    class File;
    class Ribbon;
    struct Font;
    class ImageData;
    class KeyEvent;
    struct GenericOption;
    struct Module;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Manages static logic dealing with Qt and relating to the application
    **/
    class NDEVR_WIDGETS_API QTTools
    {
    public:
        static void postToThread(std::function<void()>&& fun, QThread * thread = nullptr);
        static void postToThread(QObject* target, std::function<void()>&& fun);
        static void requestScreenOrientation(bool horizontal);
        static void RequestScreenResolution(const Vector<2, uint04>& size);
        static KeyEvent::KEY ConvertNativeKeyEvent(sint08 key);
        static QColor convert(const RGBColor& color);
        static RGBColor convert(const QColor& color);
        static Font convert(const QFont& q_font);
        static QFont convert(const Font& font);
        static void MultiplyFontSize(QFont& font, fltp08 multiplier);
        static QSize ScaleFontSizeToFit(QFont& font, const QString& text, const QRect& rect, bool shrink = true, bool grow = false);
        static void FitTextToRect(QString& text, QFont& font, const QRectF& size, bool allow_new_line = true);
        static QString AutoWrapText(const QString& value, const QFontMetrics& metrics, fltp08 length);
        static Buffer<QFont> GetFontRecursive(QWidget* widget);
        static void SetFontRecursive(QWidget* widget, const QFont& font);
        static void SetFontRecursive(QWidget* widget, const Buffer<QFont>& font);
        static void SetStyleRecursive(QWidget* widget, QStyle* style);
        static fltp08 PointSize(const QFont& font);
        static fltp08 PixelSize(const QFont& font);
        static fltp08 DPI();
        static void ForceSizeCalculation(QWidget* widget, bool process_events = false);
        static bool IsWidgetVisibleOnScreen(QWidget* widget);
        static QScreen* ScreenForWidget(const QWidget* widget);
        static QPixmap* DrawAnimationWidget(QWidget* widget, bool draw_background, QPixmap* pixmap = nullptr, QSize size = QSize());
        static QPixmap* DrawFullWidget(QWidget* widget, bool draw_background, QPixmap* pixmap = nullptr, QSize size = QSize());
        static qreal DevicePixelRatio(QWindow* window = nullptr);
        static ProgressInfo* log();
        static File convert(const QFile& file);
        static QRect PopupMenuLocation(QWidget* widget, const QSize& size);
        static QRect PopupMenuLocation(QRect popup_origin, const QSize& size);
        static void ClearLayout(QLayout* layout, bool delete_objects = false);
        static bool ShowDialog(QWidget* widget, const PopupInfo& info, const PopupInfo& end_location = PopupInfo());
        static void HideDialog(QWidget* widget, const PopupInfo& end_location = PopupInfo());
        static bool IsVisibleToUser(QWidget* widget);
        static bool ShowMessageBox(const TranslatedString& title, const TranslatedString& text
            , QMessageBox::StandardButtons buttons = { QMessageBox::StandardButton::Ok }
            , std::function<void(QMessageBox::StandardButton, PopupInfo info)> on_select = nullptr
            , const PopupInfo& popup_origin = PopupInfo());
        static bool ShowMessageBox(const TranslatedString& title, const String& image, const TranslatedString& text
            , QMessageBox::StandardButtons buttons = { QMessageBox::StandardButton::Ok }
            , std::function<void(QMessageBox::StandardButton, PopupInfo info)> on_select = nullptr
            , const PopupInfo& popup_origin = PopupInfo());
 
        static bool ShowMessageBox(const TranslatedString& title, const TranslatedString& text
            , const Buffer<TranslatedString, uint04, ObjectAllocator<false>>& button_labels
            , std::function<void(TranslatedString, PopupInfo info)> on_select = nullptr
            , const PopupInfo& popup_origin = PopupInfo());
        static bool ShowMessageBox(const TranslatedString& title, const String& image, const TranslatedString& text
            , const Buffer<TranslatedString, uint04, ObjectAllocator<false>>& button_labels
            , std::function<void(TranslatedString, PopupInfo info)> on_select = nullptr
            , const PopupInfo& popup_origin = PopupInfo());
 
        static bool ShowMessageBox(const GenericOption& options, std::function<bool(GenericOption, PopupInfo info)> on_select
            , const PopupInfo& popup_origin = PopupInfo());
        static bool ShowMessageBox(const GenericOption& options, const String& image, std::function<bool(GenericOption, PopupInfo info)> on_select
            , const PopupInfo& popup_origin = PopupInfo());
        static void RequestExit(bool relaunch, const PopupInfo& popup_origin = PopupInfo());
        static void ShowExperimentalFeatureDialog(const TranslatedString& feature);
        static fltp08 DefaultAnimationScale();
        static QSurfaceFormat DefaultSurfaceFormat();
        static void FormatPallete(bool error, QWidget* widget);
        static void ClearPallete(QWidget* widget);
        static void ServiceQT();
        static KeyEvent convert(QKeyEvent* event);
        static Module QTModule();
        static Resource<bool> is_horizontal;
 
        template<typename EnumType>
        static String EnumString(const EnumType& enumValue)
        {
            const char* enumName = qt_getEnumName(enumValue);
            const QMetaObject* metaObject = qt_getEnumMetaObject(enumValue);
            if (metaObject)
            {
                const int enumIndex = metaObject->indexOfEnumerator(enumName);
                return String(metaObject->className()) +" : "+ String(enumName) +" : "+ String(metaObject->enumerator(enumIndex).valueToKey(enumValue));
            }
 
            return String(enumName) +" : "+ String(static_cast<int>(enumValue));
        }
    };
    class NDEVR_WIDGETS_API QTAbstractResourceListener : public ResourceListener, public QObject
    {
    public:
        explicit QTAbstractResourceListener(QObject* parent = nullptr);
 
        virtual ~QTAbstractResourceListener();
        virtual void onChanged() = 0;
        void onValueChanged() override final;
        bool m_has_been_posted;
        bool m_safe_to_delete;
    };
    class NDEVR_WIDGETS_API QTResourceListener : public QTAbstractResourceListener
    {
    public:
        explicit QTResourceListener(const std::function<void()>& callback, QObject* parent);
        virtual ~QTResourceListener();
        void onChanged() override final;
        const std::function<void()> m_callback;
    };
    template class NDEVR_WIDGETS_API StringStream<QString>;
    template class NDEVR_WIDGETS_API StringStream<QByteArray>;
    #define _tqa(var) (_t(var).translation().getAs<QString>())//returns raw tranlation, should not be used for window titles
    #define _tqs(var) (String(_t(var)).getAs<QString>())//returns pseudo translation. Should be used for window titles
    #define _tdq(var, def) (_td(var, def).translation().getAs<QString>())
}