layoutManager.h

Go to the documentation of this file.

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

#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <boost/signal.hpp>
#include <vlutil/vlFilename.h>
#include <vrvCore/DtToolbarConfiguration.h>
#include <vrvCore/DtPageConfiguration.h>
#include <vrvCore/DtVrvApplicationConfiguration.h>

namespace makVrv
{
   class DtDe;
}

#define DtWindowStatePageGeometry "WIN:StatePageGeometry"

namespace makVrf
{
   const makVrv::DtPageConfiguration::PageCollectionLocation DtFullScreen = (makVrv::DtPageConfiguration::PageCollectionLocation)(makVrv::DtPageConfiguration::Location_End + 10);
   const makVrv::DtPageConfiguration::PageCollectionLocation DtMaximized = (makVrv::DtPageConfiguration::PageCollectionLocation)(makVrv::DtPageConfiguration::Location_End + 11);
   const makVrv::DtPageConfiguration::PageCollectionLocation DtWindowed = (makVrv::DtPageConfiguration::PageCollectionLocation)(makVrv::DtPageConfiguration::Location_End + 12);

   class DT_DLL_VRFGUICORE DtLayoutManager : public makVrv::DtVirtualBaseClass
   {
   public:

      struct Configuration
      {
         makVrv::DtVrvApplicationConfiguration::UIConfiguration original;
         makVrv::DtVrvApplicationConfiguration::UIConfiguration current;
      };

      DtLayoutManager(makVrv::DtDe& de);

      virtual ~DtLayoutManager();

      static DtLayoutManager& instance(makVrv::DtDe&);

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

      virtual void setLayout(const DtFilename&, bool updateCurrentLayoutBeforeSwitch = false);

      virtual void setLayoutFromClass(const DtString&, bool updateCurrentLayoutBeforeSwitch = false);
      
      virtual DtString layout() const;

      virtual std::vector<DtString> layouts() const;

      virtual bool hasFactoryDefault(const DtString&) const;

      virtual void restoreFromFactory(const DtString&);

      virtual bool copyToFactory(const DtString&);

      virtual void revertCurrentLayout();

      virtual void revertLayout(const DtString&);

      virtual DtString classNameFrom(const DtFilename& f) const;

      virtual void uiConfigurationFor(const DtFilename&, makVrv::DtVrvApplicationConfiguration::UIConfiguration&);

      virtual void updateCurrentLayout();

      virtual void updateLayout(const DtString&);

      virtual void setIgnoreGeometryChange(bool b);
      virtual bool ignoreGeometryChange() const;

      virtual void resetLayoutFromMasterModeConfiguration();

      virtual void setDefaultLayout(const DtString&);
      virtual void clearDefaultLayout();
      virtual DtString defaultLayout() const;

      virtual bool duplicateLayout(const DtString& classNameFrom, const DtString& classNameTo);

      virtual DtFilename layoutFilename(const DtString&) const;

      virtual void addConfiguration(const DtFilename&, const makVrv::DtVrvApplicationConfiguration::UIConfiguration&);

      virtual bool hasLayout(const DtString&) const;

      virtual void addPageCollectionFromMaster(const DtString&);

      virtual void addToolbarFromMaster(const DtString&);

      virtual void setPanelVisible(const DtString& className, const DtString& panel, bool b);

      virtual void setToolbarVisible(const DtString& className, const DtString& toolbar, bool b);

      virtual void setPaletteItemVisible(const std::string&, bool);
      virtual bool paletteItemVisible(const std::string&, bool* keyExists = 0) const;

      virtual void addPaletteItemIfDoesNotExistAndSetToVisible(const std::string&, bool b);

      virtual void newLayout(const DtString&, bool basedOnCurrent = true);

      virtual void writeLayouts();

      virtual void saveLayout(const DtString&);

      virtual bool deleteLayout(const DtString& s);

      virtual void renameLayout(const DtString& oldName, const DtString& newName);

      virtual void setCurrentLayoutUsesFullScreen();
      virtual bool currentLayoutUsesFullScreen() const;
      virtual void setLayoutUsesFullScreen(const DtString&);
      virtual bool layoutUsesFullScreen(const DtString&) const;

      virtual void setCurrentLayoutIsAlwaysMaximized();
      virtual bool currentLayoutIsAlwaysMaximized() const;
      virtual void setLayoutIsAlwaysMaximized(const DtString&);
      virtual bool layoutIsAlwaysMaximized(const DtString&) const;

      virtual void setCurrentLayoutUsesWindowGeometry();
      virtual bool currentLayoutUsesWindowGeometry() const;
      virtual void setLayoutUsesWindowGeometry(const DtString&);
      virtual bool layoutUsesWindowGeometry(const DtString&) const;

      virtual void updateWithCurrentWindowGeometry(const DtString&);

      virtual void setWindowGeometry(const DtString&, int top, int left, int width, int height);
      virtual void layoutWindowGeometry(const DtString&, int& top, int& left, int& width, int& height) const;

      virtual void updateWindowWithGeometryFrom(const DtString&);

      virtual void initialize();

      virtual void setSaveLayouts(bool);
      bool saveLayouts() const;

      virtual void setSaveLastSavedLayout(bool);
      bool saveLastSavedLayout() const;

      virtual void addClassToIgnore(const DtString&);
      virtual void removeClassToIgnore(const DtString&);
      const std::set<DtString>& classesToIgnore() const { return myClassesToIgnore; };
      virtual bool ignoreClass(const DtString&) const;

      virtual void setLastSavedLayoutClassName(const DtString&);
      virtual const DtString& lastSavedLayoutClassName() const;

      virtual void preAssemble();
      virtual void postAssemble();

      boost::signal<void (const DtString& newLayout, const DtString& oldLayout)> signal_layoutSelected;

      boost::signal<void (const DtString&)> signal_layoutAdded;

      boost::signal<void (const DtString&)> signal_layoutUpdated;

      boost::signal<void (const DtString&)> signal_layoutDeleted;

      boost::signal<void (const DtString& newFav, const DtString& oldFav)> signal_defaultChanged;

      boost::signal<void (const DtString& oldName, const DtString& newName)> signal_layoutRenamed;

      boost::signal<void (const DtString& className, makVrv::DtVrvApplicationConfiguration::UIConfiguration&)> signal_layoutToBeRealized;

   protected:

      virtual void updateToolbarStates(const makVrv::DtToolbarConfiguration&);
      virtual void updatePageStates(const makVrv::DtPageConfiguration&);

      virtual bool addConfigurationFor(const DtFilename&, bool addAny = false);

      virtual void createLayoutBasedOnCurrentConfiguration(const DtString&, bool andUpdateLayout = true);

   protected:
      makVrv::DtDe& myDe;
      DtFilename myLayout;

      typedef std::map<DtString, std::pair<DtFilename, Configuration> > Configurations;
      Configurations myConfigurations;

      bool mySaveLayouts;
      bool mySaveLastSavedLayout;

      typedef std::map<std::string, bool> PanelItems;
      PanelItems myPanelItems;

      std::set<DtString> myClassesToIgnore;
      DtString myLastSavedLayoutClassName;

      bool myIgnoreGeometryChange;

      static DtString theLayoutFilePrefix;
  };
}