vrfGuiSettingsManager.h

Go to the documentation of this file.

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



#pragma once

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

#include <vrvCore/DtStateView.h>
#include <vrvCore/DtEntityState.h>


#include <boost/unordered_map.hpp>

class DtUUID;

namespace makVrv
{
   class DtRecordSettingsBackupInterface;
   class DtDe;
}

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

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

      virtual void setHelpFile(const std::string&, bool save = false);
      virtual std::string helpFile() const;

      virtual void setFromRecord(const DtVrfGuiSettingsRecord& rec);
      virtual void loadDefaultGuiSettings(bool loadOnlyFactorySettings = false);
      virtual void getRecord(DtVrfGuiSettingsRecord& rec) const;

      virtual void setGrayOutHiddenItems(bool);
      virtual bool grayOutHiddenItems() const;

      virtual void setOrganizeOverlaysByCategory(bool);
      virtual bool organizeOverlaysByCategory() const;

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

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

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

      virtual bool zoomToScenarioExtentsOnLoad() const;
      virtual bool useSimulationTimeForAdvancement() const;
      virtual bool showOverlayBar() const;

      virtual void setUseAdditionalWindowTitle(bool);
      virtual bool useAdditionalWindowTitle() const;

      void setCommandPanelShowIcons(bool);
      bool commandPanelShowIcons() const;

      void setShowCommandPanelSmallIcons(bool);
      bool showCommandPanelSmallIcons() const;

      virtual void setShowCommandPanelLargeIcons(bool);
      virtual bool showCommandPanelLargeIcons() const;

      virtual void setAdditionalWindowTitle(const makVrv::DtUnicode&);
      virtual makVrv::DtUnicode additionalWindowTitle() const;

      virtual void setUseStartFreezePdus(bool);
      virtual bool useStartFreezePdus() const;

      virtual void setAllowWindowsStyleNameEditing(bool);
      virtual bool allowWindowsStyleNameEditing() const;

      virtual void setEditPressTime(double);
      virtual double editPressTime() const;

      virtual void setSortTaskSetMenus(bool);
      virtual bool sortTaskSetMenus() const;

      virtual void setPromptBeforeAbandoningPlan(bool);
      virtual bool promptBeforeAbandoningPlan() const;

      virtual void setPromptBeforeInterruptingTask(bool);
      virtual bool promptBeforeInterruptingTask() const;

      virtual void setAskToCancelOperation(bool);
      virtual bool askToCancelOperation() const;

      virtual void setUseDoubleClickToEndRouteCreation(bool);
      virtual bool useDoubleClickToEndRouteCreation() const;

      makVrv::DtRecordSettingsBackupInterface*  guiSettingsBackup()
      {
         return myGuiSettingsBackup;
      }

      void exportGuiSettings(const std::string& fileName);

      void importGuiSettings(const std::string& fileName);

      virtual void setDisplayCorrelationWarningMessages(bool);
      virtual bool displayCorrelationWarningMessages() const;

      virtual void setDoNotShowSessionStartupDialog(bool, bool save = true, bool signal = true);
      bool showSessionStartupDialog() const;

      virtual void setStartupPreference(int);
      int startupPreference() const;

      virtual void setTimeScaleRange(double low, double high, bool save = true);
      virtual void getTimeScaleRange(double& low, double& high) const;

      virtual void setUserDefinedSmoothing(bool);
      bool userDefinedSmoothing() const;

      virtual void setShowScenarioDescriptionDialog(bool b);
      virtual bool showScenarioDescriptionDialog() const;

      virtual void setTimescaleButtonMode(bool);
      virtual bool timescaleButtonMode();

      virtual void setTimescaleButtons(const std::string&);
      virtual const std::string& timescaleButtons() const;

      virtual void saveSettingsAsDefault();

   public:
      boost::signals2::signal<void (const DtVrfGuiSettingsRecord&)> signal_guiSettingsChanged;

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

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

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

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

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

   protected:
      makVrv::DtDe&              myDe;
      DtVrfGuiSettingsRecord            myGuiSettings;
      makVrv::DtRecordSettingsBackupInterface*  myGuiSettingsBackup;
   };
}