commandLevelsManager.h

Go to the documentation of this file.

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

#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/commandLevelsRecord.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vlutil/vlFilename.h>

#include <boost/signals2.hpp>
#include <map>
#include <string>

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtCommandLevelsManager : public makVrv::DtVirtualBaseClass
   {
   public:
      DtCommandLevelsManager(makVrv::DtDe&);
      virtual ~DtCommandLevelsManager() override;

      static DtCommandLevelsManager& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe& de, DtCommandLevelsManager*);

      virtual void getSplitRecord(std::vector<DtCommandLevelsRecord>& rec,
         std::vector<std::string>& fileNames) {};

      virtual void addRecords(DtCommandLevelsRecord& recs,
         DtCommandLevelsRecord& combinedRec) {};

      virtual void setFromRecord(const DtCommandLevelsRecord& rec);
      virtual void loadDefaultCommandLevelsSettings(bool loadOnlyFactorySettings = false);
      virtual void getRecord(DtCommandLevelsRecord& rec) const;

      virtual void setAutoSave(bool);
      virtual bool autoSave() const;
      virtual void saveSettingsAsDefault();

      virtual void addTaskSetCommandLevel(int level, const DtString& title, const DtString& toolTip, const DtString& icon);
      virtual void addToTaskSetCommandLevel(int level, const DtString&, bool thisSessionOnly = false);

      virtual void setIsMagicCommand(const DtString&, bool flag);
      virtual bool isMagicCommand(const DtString&) const;

      virtual void removeFromTaskSetCommandLevel(int level, const DtString&, bool thisSessionOnly = false);

      virtual DtString taskSetCommandLevelToolTip(int level) const;
      virtual DtString taskSetCommandLevelTitle(int level) const;
      virtual DtString taskSetCommandLevelIcon(int level) const;
      virtual std::vector<int> taskSetCommandLevels(const DtString&) const;
      virtual int numberOfTaskSetCommandLevels() const;
      virtual std::vector<int> taskSetCommandLevels() const;
      virtual bool isInTaskSetCommandLevel(int level, const DtString& taskSetType) const;
      virtual void clearSessionCommandLevels();

      virtual void setExpandCollapsedState(const DtString& section, bool exp);
      virtual bool expandCollapsedState(const DtString& section) const;

      virtual void setAlwaysPopOut(bool);
      virtual bool alwaysPopOut() const;

   public:
      boost::signals2::signal<void (const DtCommandLevelsRecord&)> signal_commandLevelsChanged;
      boost::signals2::signal<void ()> signal_sessionCommandLevelsChanged;
      boost::signals2::signal<void ()> signal_commandLevelCategoriesChanged;

      boost::signals2::signal<void (const DtString&, int level, bool)> signal_commandLevelChanged;

      boost::signals2::signal<void (const DtString&, bool)> signal_expandCollapsedStateChanged;

      boost::signals2::signal<void (bool)> signal_alwaysPopOutChanged;

   protected:
      makVrv::DtDe&              myDe;
      DtCommandLevelsRecord            myCommandLevelsRecord;

      std::map<int, std::set<DtString> > myTaskSetCommandLevels;
      std::map<DtString, bool> myIsMagicCommand;

      struct CommandLevel
      {
         DtString title;
         DtString icon;
         DtString toolTip;
      };

      typedef std::map<int, CommandLevel> CommandLevels;
      CommandLevels myCommandLevels;
   };
}