NDEVRTheme.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: NDEVR
File: NDEVRLightingTheme
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/INIInterface.h>
#include <NDEVR/RGBColor.h>
#include <QPropertyAnimation>
#include <QProxyStyle>
#include <QPalette>
class QFont;
namespace NDEVR
{
    enum NDEVRLightingTheme
    {
          e_dark_theme
        , e_light_theme
        , e_num_of_themes
    };
    class NDEVRProxyStyle;
    /**--------------------------------------------------------------------------------------------------
    \brief An animation that slowly changes the color over the entire UI.
    *-----------------------------------------------------------------------------------------------**/
    class ThemeChanger : public QPropertyAnimation
    {
        Q_OBJECT
        Q_PROPERTY(float percent READ percent WRITE setPercent)
    public:
        ThemeChanger(NDEVRLightingTheme start, NDEVRLightingTheme end, NDEVRProxyStyle* style);
        void startAnimation();
        float percent() const;
        void setPercent(float percent);
        NDEVRLightingTheme start;
        NDEVRLightingTheme end;
        NDEVRProxyStyle* style;
 
    protected:
        QPropertyAnimation* m_animation;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Responsible for setting up the core style of the application including size of various widgets
        and colors.
    Some themes are inherited from the OS, some from Qt's fusion style, and some are defined and drawn
        directly.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_WIDGETS_API NDEVRProxyStyle : public QProxyStyle, public INIInterface
    {
        Q_OBJECT
    public:
        NDEVRProxyStyle();
        NDEVRProxyStyle(const File& ini_file);
        NDEVRProxyStyle(QStyle* style);
        ~NDEVRProxyStyle();
    public:
        static NDEVRProxyStyle* GlobalStyle();
        int pixelMetric(PixelMetric metric, const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const override;
        virtual void drawPrimitive(PrimitiveElement pe, const QStyleOption *opt, QPainter *p, const QWidget *w = nullptr) const override;
        void drawControl(ControlElement element, const QStyleOption *opt, QPainter *painter, const QWidget *widget) const override;
        void drawComplexControl(ComplexControl control, const QStyleOptionComplex *option, QPainter *painter, const QWidget *widget = nullptr) const override;
        void drawArrow(Qt::ArrowType type, QPainter *painter, const QStyleOption *option, const QRect &rect, const QColor &color) const;
        void drawItemText(QPainter *painter, const QRect &rect, int flags, const QPalette &pal, bool enabled,
                          const QString &text, QPalette::ColorRole textRole = QPalette::NoRole) const override;
        virtual void drawItemPixmap(QPainter *painter, const QRect &rect, int alignment, const QPixmap &pixmap) const override;
        QRect subElementRect(SubElement element, const QStyleOption *option, const QWidget *widget) const override;
        QRect subControlRect(ComplexControl cc, const QStyleOptionComplex *opt, SubControl sc, const QWidget *widget) const override;
        QRect itemTextRect(const QFontMetrics &fm, const QRect &r, int flags, bool enabled, const QString &text) const override;
        QRect itemPixmapRect(const QRect &r, int flags, const QPixmap &pixmap) const override;
        QSize sizeFromContents(ContentsType type, const QStyleOption *option, const QSize &size, const QWidget *widget) const override;
        int styleHint(StyleHint stylehint, const QStyleOption *opt = nullptr,
                              const QWidget *widget = nullptr, QStyleHintReturn* returnData = nullptr) const override;
        virtual QPalette standardPalette() const override;
        QPalette themePalette(NDEVRLightingTheme theme) const;
        QPalette interpolatedThemePalette(NDEVRLightingTheme start, NDEVRLightingTheme end, fltp04 percent) const;
        QIcon standardIcon(StandardPixmap standardIcon, const QStyleOption* option = nullptr, const QWidget* widget = nullptr) const override;
        NDEVRLightingTheme oldTheme() const;
        static String ColorThemeIcon(NDEVRLightingTheme theme);
        fltp04 themeTransitionPercent();
        void setLightingTheme(NDEVRLightingTheme theme, bool force_update = false, bool save_settings = true);
        void setLightingThemeAnimated(NDEVRLightingTheme theme);
        void setLightingThemeAnimated(NDEVRLightingTheme start, NDEVRLightingTheme end, fltp04 percent);
        void setUseRoundedButtons(bool use_rounded_buttons);
        bool usingRoundedButtons() const;
        RGBColor disabledColor(NDEVRLightingTheme theme) const;
        bool isGlobalStyle() const;
        virtual void getINI(INIFactory& factory) override;
        void setToDefaultColors();
        NDEVRLightingTheme theme() const { return m_theme; };
        TimeSpan paletteAnimationTime() const;
        TimeSpan resizeAnimationTime() const;
        TimeSpan fadeInAnimationTime() const;
        TimeSpan fadeOutAnimationTime() const;
        void polish(QWidget *widget) override;
        void setToDefaultSizes();
        void updateResolutionPixelMetric();
        static QFont OriginalFont();
        fltp08 desktopFontScale();
        void updateUIFromStyle();
        void updateIconOverrideTheme();
        fltp08 baseTextScale() const;
    protected:
        void drawRoundedButtonBackground(const QStyleOption* opt, QPainter* p, int radius = Constant<int>::Max) const;
        fltp08 baseUIScale() const;
        
        void saveSettings();
        void init();
        void updateFontScale();
        static NDEVRProxyStyle* s_global_style;
    signals:
        void lightingThemeChangedSignal(NDEVRLightingTheme theme);
    protected:
        RGBColor theme_colors[NDEVRLightingTheme::e_num_of_themes][QPalette::NColorRoles];
    protected:
        fltp04 m_theme_transition_percent;
        NDEVRLightingTheme m_old_theme;
        NDEVRLightingTheme m_theme;
        QStyle* m_native_theme;
        fltp08 m_touch_ui_scale_horz;
        fltp08 m_touch_ui_scale_vert;
        fltp08 m_desktop_ui_scale;
        fltp08 m_touch_text_scale_vert;
        fltp08 m_touch_text_scale_horz;
        fltp08 m_desktop_text_scale;
        fltp08 m_resolution_pixel_metric;
        bool m_touch_use_rounded_buttons;
    };
    template class NDEVR_WIDGETS_API StringStream<NDEVRLightingTheme>;
}