DtWidgetIconStyleManager.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2022 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once

#include <vrvCoreQt/vrvCoreQt.h>

#include <vrvCore/DtHeaderParser.h>
#include <vrvCore/DtQIconConfiguration.h>
#include <vrvCore/DtVirtualBaseClassCreator.h>

#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/signalslib.h>
#include <vrvUtil/DtUnicode.h>

#include <QtGui/QIcon>
#include <QtGui/QColor>

#include <QtCore/QPointer>
#include <utility>

class QObject;

namespace makVrv
{
   class DtDe;

   class DtWidgetIconStyleManagerEventFilter;

   typedef DtVirtualBaseClassCreator<DtWidgetIconStyleManagerEventFilter> DtWidgetIconStyleManagerEventFilterCreator;

   template <>
   inline const char* creatorTypeName<DtWidgetIconStyleManagerEventFilter>(void) { return "DtWidgetIconStyleManagerEventFilterCreator"; }

   class DT_DLL_VRVCOREQT DtWidgetIconStyleManagerEventFilter : public QObject
   {
      friend DtWidgetIconStyleManagerEventFilterCreator;

   public:
      virtual ~DtWidgetIconStyleManagerEventFilter();

      DtWidgetIconStyleManagerEventFilter() = delete;

      DtWidgetIconStyleManagerEventFilter(
         const DtWidgetIconStyleManagerEventFilter &other) = delete;

      DtWidgetIconStyleManagerEventFilter &operator=(
         const DtWidgetIconStyleManagerEventFilter &other) = delete;

   protected:
      DtWidgetIconStyleManagerEventFilter(DtDe& de);

      virtual bool eventFilter(QObject*, QEvent*) override;

   protected:
      DtDe& myDe;
   };

   class DT_DLL_VRVCOREQT DtWidgetIconStyleManager
      : public DtVirtualBaseClass
   {
      friend class DtWidgetIconStyleManagerEventFilter;
   public:
      typedef std::vector<std::pair<int, DtQIconConfigurations> > DtIndexableQIconConfigurations;

   public:
      static DtWidgetIconStyleManager& instance(DtDe& de);

      static void registerInstance(DtDe& de, DtWidgetIconStyleManager* instance);

   public:
      DtWidgetIconStyleManager() = delete;

      DtWidgetIconStyleManager(
         const DtWidgetIconStyleManager &other) = delete;

      DtWidgetIconStyleManager &operator=(
         const DtWidgetIconStyleManager &other) = delete;

   public:
      virtual void manageWidget(QObject* widgetToManage, const std::string& iconFileNameOrPath);

      virtual void manageWidget(QObject* widgetToManage, const DtQIconConfigurations& iconConfigurations);

      virtual void manageIndexableWidget(QObject* indexedWidgetToManage, 
         int index, const DtQIconConfigurations& iconConfigurations);

      virtual void unmanageWidget(QObject* widgetToManage);

      virtual void clearCache(bool refreshIcons = true);

      virtual QPixmap generateThemedPixmap(const std::string& iconFileNameOrPath, const QSize& pixmapSize=QSize(16,16),
         QIcon::Mode iconModeOfGeneratedPixmap = QIcon::Normal, QIcon::State iconStateOfGeneratedPixmap = QIcon::Off);

      virtual QIcon createQIconBasedOnConfigurations(const DtQIconConfigurations& configurations);

      boost::signalslib::signal<void()> signal_refreshApplicationIcons;

   protected:

      DtWidgetIconStyleManager(DtDe& de);

      virtual ~DtWidgetIconStyleManager();

      virtual void slot_darkModeEnabledChanged(bool enabled);

      virtual void slot_lightModeDarkModeIconsEnabledChanged(bool enabled);

      virtual void updateAllManagedIcons(bool lightDarkModeIconsEnabled);

      virtual void updateIcon(QObject* widget,
         const DtQIconConfigurations& iconConfigurations, bool lightDarkModeIconsEnabled);

      virtual void updateIndexedIcon(QObject* indexedWidget,
         const DtIndexableQIconConfigurations& iconConfigurations, bool lightDarkModeIconsEnabled);

      virtual QPixmap findOrCreatePixmapInCache(const std::string& filePath);

      virtual QPixmap findOrCreateThemedPixmapInCache(const std::string& fileNameOrPath);

      virtual std::string iconsDirectory(const std::string& iconFileNameOrPath) const;

      virtual bool iconExistsOnDiskOrInCache(const std::string& iconFilePath) const;

      virtual std::string iconFilePath(const std::string& iconFileNameOrPath) const;

      virtual void generateAndAppendAdditionalIconConfigurationsIfNeeded(
         QIcon& iconToAppendToIfNeeded, const DtQIconConfigurations& iconConfigurations) const;

      virtual QPixmap generateThemedPixmap(const std::string& iconFileNameOrPath,
         QIcon::Mode iconModeOfGeneratedPixmap = QIcon::Normal, QIcon::State iconStateOfGeneratedPixmap = QIcon::Off) const;

      virtual bool getPixmapFromSVGAndColorMappings(const std::string& iconFileNameOrPath,
         const std::vector<std::pair<QColor, QColor>> colorMappings, QPixmap& resultIcon) const;

   protected:
      DtDe& myDe;

      DtSignalConnectionManager myConnections;

      std::map<QPointer<QObject>, DtQIconConfigurations> myWidgetsToManage;

      std::map<QPointer<QObject>, DtIndexableQIconConfigurations > myIndexedWidgetsToManage;

      std::map<std::string, QPixmap> myFilepathsToPixmapCache;

      DtWidgetIconStyleManagerEventFilter* myEventFilter;
   };

}