WidgetViewManager.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Flags.h"
#include "OTCore/OTClassHelper.h"
#include "OTCore/BasicServiceInformation.h"
#include "OTGui/WidgetViewBase.h"
#include "OTWidgets/WidgetView.h"
#include "OTWidgets/WidgetViewDockManager.h"
 
// Qt ADS header
#include <ads/DockWidget.h>
 
// Qt header
#include <QtCore/qobject.h>
#include <QtCore/qbytearray.h>
 
// std header
#include <list>
#include <string>
 
class QAction;
 
namespace ads {
    class CDockAreaWidget;
}
 
namespace ot {
 
    class WidgetView;
 
    class OT_WIDGETS_API_EXPORT WidgetViewManager : public QObject {
        Q_OBJECT
        OT_DECL_NOCOPY(WidgetViewManager)
    public:
        typedef std::pair<std::string, WidgetViewBase::ViewType> ViewNameTypeListEntry;
        typedef std::list<ViewNameTypeListEntry> ViewNameTypeList;
        typedef std::pair<BasicServiceInformation, ot::WidgetView*> ViewEntry;
 
        enum ManagerConfigFlag : uint32_t {
            NoFlags                            = 0 << 0, 
            InputFocusCentralViewOnFocusChange = 1 << 0, 
            InputFocusSideViewOnFocusChange    = 1 << 1, 
            InputFocusToolViewOnFocusChange    = 1 << 2, 
            IgnoreInputFocusOnViewInsert       = 1 << 3, 
 
            InputFocusOnAnyViewFocusChange     = InputFocusCentralViewOnFocusChange | InputFocusSideViewOnFocusChange | InputFocusToolViewOnFocusChange,
 
            InputFocusOnFocusChangeMask        = ~InputFocusOnAnyViewFocusChange,
 
 
            UseBestAreaFinderOnViewInsert      = 1 << 4
            
        };
        typedef Flags<ManagerConfigFlag> ManagerConfigFlags;
 
        static WidgetViewManager& instance(void);
 
        void initialize(WidgetViewDockManager* _dockManager = nullptr);
 
        ads::CDockManager* getDockManager(void) const { return m_dockManager; };
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // View Management
        
        bool addView(const BasicServiceInformation& _owner, WidgetView* _view, const WidgetView::InsertFlags& _insertFlags = WidgetView::InsertFlags(WidgetView::NoInsertFlags), WidgetView* _parentView = (WidgetView*)nullptr);
 
        WidgetView* findView(const std::string& _entityName, WidgetViewBase::ViewType _type) const;
 
        WidgetView* findViewFromTitle(const std::string& _viewTitle) const;
 
        bool findViewAndOwner(const std::string& _entityName, WidgetViewBase::ViewType _type, WidgetView*& _view, BasicServiceInformation& _owner) const;
 
        WidgetView* getViewFromDockWidget(ads::CDockWidget* _dock) const;
 
        void closeView(WidgetView* _view);
 
        void closeView(const std::string& _entityName, WidgetViewBase::ViewType _type);
 
        void closeViews(const BasicServiceInformation& _owner);
 
        void closeViews(void);
 
        void forgetView(WidgetView* _view);
 
        WidgetView* forgetView(const std::string& _entityName, WidgetViewBase::ViewType _type);
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // View manipulation
 
        void setCurrentView(const std::string& _entityName, WidgetViewBase::ViewType _type);
 
        void setCurrentViewFromTitle(const std::string& _viewTitle);
 
        std::string saveState(int _version = 0) const;
 
        bool restoreState(std::string _state, int _version = 0);
 
        void setConfigFlag(ManagerConfigFlag _flag, bool _active = true) { m_config.setFlag(_flag, _active); };
        void setConfigFlags(const ManagerConfigFlags& _flags) { m_config = _flags; };
        const ManagerConfigFlags& getConfigFlags(void) const { return m_config; };
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Information gathering
 
        BasicServiceInformation getOwnerFromView(WidgetView* _view) const;
 
        bool getViewExists(const std::string& _entityName, WidgetViewBase::ViewType _type) const;
 
        bool getViewTitleExists(const std::string& _title) const;
 
        ViewNameTypeList getViewNamesFromOwner(const BasicServiceInformation& _owner) const;
 
        std::list<std::string> getViewNamesFromOwner(const BasicServiceInformation& _owner, WidgetViewBase::ViewType _type) const;
 
        bool getAnyViewContentModified(void);
 
        QAction* getDockToggleAction(void) const { return m_dockToggleRoot; };
 
        WidgetView* getCurrentlyFocusedView(void) const;
 
        WidgetView* getLastFocusedView(void) const { return m_focusInfo.last; };
        WidgetView* getLastFocusedSideView(void) const { return m_focusInfo.lastSide; };
        WidgetView* getLastFocusedToolView(void) const { return m_focusInfo.lastTool; };
        WidgetView* getLastFocusedCentralView(void) const { return m_focusInfo.lastCentral; };
 
    Q_SIGNALS:
        void viewFocusChanged(WidgetView* _focusedView, WidgetView* _previousView);
        void viewCloseRequested(WidgetView* _view);
 
    private Q_SLOTS:
        void slotViewFocused(ads::CDockWidget* _oldFocus, ads::CDockWidget* _newFocus);
        void slotViewCloseRequested(void);
        void slotUpdateViewVisibility(void);
 
    private:
        enum ManagerState {
            DefaultState    = 0 << 0, 
            InsertViewState = 1 << 0 
        };
        typedef Flags<ManagerState> ManagerStateFlags;
 
        struct FocusInfo {
            WidgetView* last;
            WidgetView* lastCentral;
            WidgetView* lastSide;
            WidgetView* lastTool;
        };
 
        WidgetViewManager();
        ~WidgetViewManager();
 
        bool getViewExists(const ViewNameTypeListEntry& _entry) const;
 
        WidgetView* findView(const ViewNameTypeListEntry& _entry) const;
 
        bool addViewImpl(const BasicServiceInformation& _owner, WidgetView* _view, const WidgetView::InsertFlags& _insertFlags, WidgetView* _parentView);
 
        ads::CDockAreaWidget* getBestDockArea(const WidgetView* _view) const;
        ads::CDockAreaWidget* getFirstMatchingView(WidgetViewBase::ViewFlag _viewTypeFlag) const;
 
        ViewNameTypeList* findViewNameTypeList(const BasicServiceInformation& _owner);
        ViewNameTypeList* findOrCreateViewNameTypeList(const BasicServiceInformation& _owner);
 
        WidgetViewDockManager* m_dockManager; 
        QAction*           m_dockToggleRoot; 
        
        ManagerStateFlags m_state;
        ManagerConfigFlags m_config;
 
        FocusInfo        m_focusInfo;
        
        std::map<BasicServiceInformation, ViewNameTypeList*> m_viewOwnerMap; 
        std::list<ViewEntry> m_views; 
 
        OT_ADD_PRIVATE_FLAG_FUNCTIONS(ManagerState)
    };
 
}
 
OT_ADD_FLAG_FUNCTIONS(ot::WidgetViewManager::ManagerConfigFlag)