GUIManager.h

#pragma once
 
#include "GUIDefinitions.h"
 
#include <deque>
#include <stack>
#include <queue>
#include <map>
#include <set>
 
namespace FLImaging
{
    namespace GUI
    {
        class CGUIPropertyMenuBase;
        class CGUIPaneBase;
        class CGUIPaneMenu;
        class CGUIPaneLog;
        class CGUIPaneCode;
        class CGUIPaneExampleSNAP;
        class CGUIPaneViewGraph;
        class CGUIFixedViewPlacementSet;
        class CGUIMenuItemFixedViewPlacementSet;
        class CGUIMenuItemProperty;
        class CGUIMenuItemBase;
        class CGUIViewImageBase;
        class CGUIMainFrame;
        class CGUITreeContainer;
 
        typedef struct sMenuItemPredefinedExpandSetting
        {
            sMenuItemPredefinedExpandSetting() :
                m_strMenuItemFullPath(L""),
                m_bExpand(false),
                m_bRecursive(false),
                m_bAllowToLoad(true) {}
 
            sMenuItemPredefinedExpandSetting(
                const Base::CFLString<wchar_t>& strMenuItemFullPath,
                bool bExpand, bool bRecursive, bool bAllowToLoad) :
                m_strMenuItemFullPath(strMenuItemFullPath),
                m_bExpand(bExpand),
                m_bRecursive(bRecursive),
                m_bAllowToLoad(bAllowToLoad) {}
 
            sMenuItemPredefinedExpandSetting(sMenuItemPredefinedExpandSetting& rhs) :
                m_strMenuItemFullPath(rhs.m_strMenuItemFullPath),
                m_bExpand(rhs.m_bExpand),
                m_bRecursive(rhs.m_bRecursive),
                m_bAllowToLoad(rhs.m_bAllowToLoad) {}
 
            ~sMenuItemPredefinedExpandSetting() {}
            Base::CFLString<wchar_t> m_strMenuItemFullPath;
            bool m_bExpand;
            bool m_bRecursive;
            bool m_bAllowToLoad;
        }
        SMenuItemPredefinedExpandSetting;
 
        class FL_EXPORT CGUIManager : public Base::CFLBase
        {
            CGUIManager();
            CGUIManager(const CGUIManager& rh);
 
        public:
            virtual ~CGUIManager();
 
            static bool PreInitialize();
            static bool Initialize();
            static bool IsInitialized();
            static bool PreTerminate();
            static bool Terminate();
 
            static bool PeekAndPump();
 
            static const CResult SetConfigurationPath(const Base::CFLString<wchar_t>& strPath);
 
            static Base::CFLString<wchar_t> GetConfigurationPath();
 
            static const CResult SetExamplesSNAPPath(const Base::CFLString<wchar_t>& strPath);
 
            static Base::CFLString<wchar_t> GetExamplesSNAPPath();
 
            static uint32_t GetValidResourceId();
 
            static const CResult AddChargedResourceId(uint32_t u32ResourceID);
 
            static const CResult ReleaseChargedResourceId(uint32_t i32ResourceID);
 
            static int64_t GetMenuItemCount();
            
            static const CResult RegisterMenu(const CGUIPropertyMenuBase& pmb, const Base::CFLString<wchar_t>& strName, const Base::CFLString<wchar_t>& strPath, bool bAllowMultiInstance = true, bool bSetGlobalModel = false);
            
            static const CResult RegisterMenu(const CGUIPropertyMenuBase& pmb, const Base::CFLString<wchar_t>& strName, const Base::CFLString<wchar_t>& strInsertPositionFullPath, EInsertPosition eInsertAt, bool bAllowMultiInstance, bool bSetGlobalModel);
 
            static const CResult UnregisterMenu(const Base::CFLString<wchar_t>& flsFullPath);
 
            static bool AddMenuItem(CGUIMenuItemBase* pItem);
 
            static bool AddMenuItem(CGUIMenuItemBase* pMI, bool bAllowMultiInstance, bool bSetGlobalModel = false);
 
            static bool InsertMenuItem(CGUIMenuItemBase* pItem, CGUIMenuItemBase* pItemPosition, EInsertPosition eInsertAt = EInsertPosition_After);
 
            static bool InsertMenuItem(CGUIMenuItemBase* pItem, CGUIMenuItemBase* pItemPosition, EInsertPosition eInsertAt, bool bAllowMultiInstance, bool bSetGlobalModel = false);
 
            static bool DeleteMenuItem(CGUIMenuItemBase* pItem);
            
            static bool DeleteMenuItem(const Base::CFLString<wchar_t>& flsFullPath);
 
            static CGUIMenuItemBase* GetMenuItem(int64_t i64Index);
 
            static CGUIMenuItemBase* GetMenuItem(const Base::CFLString<wchar_t>& flsName, const Base::CFLString<wchar_t>& flsPath);
            
            static CGUIMenuItemBase* GetMenuItem(const Base::CFLString<wchar_t>& flsFullPath);
 
            static const CResult GetMenuItemChildren(CGUIMenuItemBase* pItem, std::vector<CGUIMenuItemBase*>& vctChildItems);
 
            static const CResult GetMenuItemChildren(const Base::CFLString<wchar_t>& flsPath, std::vector<CGUIMenuItemBase*>& vctChildItems);
 
            static CGUIMenuItemFixedViewPlacementSet* GetMenuItemFixedViewPlacementSet(Base::CFLString<wchar_t> flstrName);
 
            static CGUIMenuItemFixedViewPlacementSet* GetMenuItemFixedViewPlacementSet(int64_t i64FvpSetIndex);
 
            static void PushBackFixedViewPlacementSet(CGUIMenuItemFixedViewPlacementSet* pFvpSet);
 
            static void EraseFixedViewPlacementSet(CGUIMenuItemFixedViewPlacementSet* pFvpSet);
 
            static bool RegisterTreeItem(const wchar_t* pWcsName, const wchar_t* pWcsPath, void* pData, ETreeItemIcon eIcon = ETreeItemIcon_DocEmpty);
            
            static bool UnregisterTreeItem(const wchar_t* pWcsFullPath);
 
            static bool UnregisterTreeItem(void* pData);
 
            static bool RenameTreeItem(void* pData, const wchar_t* pWcsNewName);
 
            static bool IsThereTreeItem(void* pData);
 
            static bool SortTreeItem(ESortOrder eSortOrder = ESortOrder_Ascending);
 
            static bool SortTreeItem(CGUIMenuItemBase* pItem, ESortOrder eSortOrder = ESortOrder_Ascending);
 
            static bool CancelSortTreeItem(CGUIMenuItemBase* pItem = nullptr);
 
            static void PreInitializePaneVisibility(bool bShowPaneMenu = true, bool bShowPaneLog = false, bool bShowPaneCode = false, bool bShowPaneExampleSNAP = true, bool bShowPaneColorTable = false, bool bShowPaneViewGraph = false, bool bShowPaneSheet = false);
 
            static void GetPreInitializedPaneVisibility(bool& bShowPaneMenu, bool& bShowPaneLog, bool& bShowPaneCode, bool& bShowPaneExampleSNAP, bool& bShowPaneColorTable, bool& bShowPaneViewGraph, bool& bShowPaneSheet);
 
            static void ModifyPaneCreationOnInitialize(EPaneType ePaneTypeRemove, EPaneType ePaneTypeAdd = EPaneType_MainPane);
 
            static void SetPaneCreationOnInitialize(EPaneType ePaneType, bool bCreate);
 
            static EPaneType GetPaneCreationSetting();
 
            static void BeginWaitCursor();
 
            static void EndWaitCursor();
 
            static const CResult AddFontSetting(Base::CFLString<wchar_t> strPaneClassName);
 
            static const CResult LoadFontSetting();
 
            static const CResult WriteFontSetting(Base::CFLString<wchar_t> strPaneClassName, CFont* pFont);
 
            static const CResult LoadFixedViewPlacementSetting(const wchar_t* pWcsFileNameWithPath = nullptr);
            
            static const CResult ImportFixedViewPlacementSet(const wchar_t* pWcsFileNameWithPath = nullptr, bool bOverwrite = true, bool bApply = false);
 
            static const CResult WriteFixedViewPlacementSetting(const wchar_t* pWcsFileNameWithPath = nullptr);
 
            static const CResult LoadThemeSetting();
 
            static const CResult WriteThemeSetting(int nValue);
 
            static const CResult AddPredefinedMenuItemExpandSetting(const Base::CFLString<wchar_t>& strMenuItemFullPath, bool bExpand, bool bRecursive, bool bAllowToLoad);
 
            static const CResult GetPredefinedMenuItemExpandSetting(const Base::CFLString<wchar_t>& strMenuItemFullPath, bool& bExpand, bool& bRecursive, bool& bAllowToLoad);
 
            static const CResult LoadMenuItemExpandSetting();
 
            static const CResult LoadMenuItemExpandSetting(const Base::CFLString<wchar_t>& strMenuItemFullPath, bool& bExpand);
 
            static const CResult WriteMenuItemExpandSetting(const Base::CFLString<wchar_t>& strMenuItemFullPath, bool bExpand);
 
            static const CResult LoadExampleSNAPExpandSetting();
 
            static const CResult LoadExampleSNAPExpandSetting(const Base::CFLString<wchar_t>& strExampleSNAPFullPath, bool& bExpand);
 
            static const CResult WriteExampleSNAPExpandSetting(const Base::CFLString<wchar_t>& strExampleSNAPFullPath, bool bExpand);
 
            static const CResult LoadWorkingPane();
 
            static const CResult WriteWorkingPane(const CGUIMenuItemBase* pMenuItem, bool bExist);
 
            static const CResult WriteWorkingPanes();
 
            static const CResult WriteLastFocusedWorkingPane();
 
            static const CResult LoadFavoriteMenuItemSetting();
 
            static const CResult WriteFavoriteMenuItemSetting(CGUIMenuItemBase* pMenuItem, bool bDelete, bool bDeleteProfile = false);
 
            static const CResult WriteFavoriteMenuItemSetting();
 
            static const CResult LoadFavoriteExampleSNAPSetting();
 
            static const CResult WriteFavoriteExampleSNAPSetting(CGUIMenuItemBase* pExampleSNAP, bool bDelete, bool bDeleteProfile = false);
 
            static const CResult WriteFavoriteExampleSNAPSetting();
 
            static bool IsLoadingFavoriteMenu();
 
            static bool IsLoadingMenuItemExpand();
 
            static bool IsLoadingExampleSNAPExpand();
 
            static bool IsLoadingFixedViewPlacement();
 
            static bool EnableMenuItemSNAPObject(bool bEnable);
 
            static bool IsMenuItemSNAPObjectEnabled();
 
            static const CResult ReloadOpenedPanePropertiesAll();
 
            static CGUIMainFrame* GetMainFrame();
 
            static const CResult OpenURL(const Base::CFLString<wchar_t>& strURL);
 
            static const CResult GetMenuItemPropertyOfVisiblePane(std::set<CGUIMenuItemProperty*>& setPMenuItemProperty);
 
            static const CResult SetAppTitle(const Base::CFLString<wchar_t>& strAppTitle);
 
            static Base::CFLString<wchar_t> GetAppTitle();
 
            static void SetMenuItemRootPath(const Base::CFLString<wchar_t>& strRoot);
 
            static Base::CFLString<wchar_t> GetMenuItemRootName();
 
            static void SetMenuItemRootIcon(ETreeItemIcon eRootIcon = ETreeItemIcon_FLImaging);
 
            static ETreeItemIcon GetMenuItemRootIcon();
 
            static void EnableWriteWorkingPanesOnTerminate(bool bEnable);
 
            static bool IsWriteWorkingPanesOnTerminateEnabled();
 
            static void RunOnMainThread(const std::function<void(void*)>& lmdFunction, void* pVResult, const void* pVCaller);
            static void RunOnMainThreadPostMessage(const std::function<void(void*)>& lmdFunction, void* pVResult, const void* pVCaller);
            static DWORD GetMainThreadID();
 
            static bool EnterDllResource();
            static bool LeaveDllResource();
 
            static const Base::CFLString<wchar_t> GetModuleFileName();
 
            static bool IsSwitchingViewTab();
            static void SetSwitchingViewTab(bool bSet);
 
            static HINSTANCE GetDllResource();
 
            static CGUIViewImageBase* GetCallerView(const CFLBase* pCaller);
 
            static const CResult InitializeAfxInstanceHandle();
            
            static CGUITreeContainer* GetTreeContainerMenuItem();
 
            DeclareGetClassType();
 
        protected:
            virtual void OnReceiveBroadcast(const Base::CBroadcastMessage* pMessage) override;
            static bool PumpMessage();
            static bool OnIdle(LONG lCount);
            static const CResult InternalSetMenuItemName(CGUIMenuItemBase* pItem, const Base::CFLString<wchar_t>& strName);
            static const CResult InternalSetMenuItemPath(CGUIMenuItemBase* pItem, const Base::CFLString<wchar_t>& strPath);
            static const CResult InternalInitializeTreeContainerMenuItem();
            static const CResult InternalInitializeTreeContainerMenuItemExampleSNAP();
 
        private:
            static CGUIManager* GetObject();
 
            Base::CFLString<wchar_t> m_strConfigurationPath;
            Base::CFLString<wchar_t> m_strExamplesSNAPPath;
            Base::CFLString<wchar_t> m_strAppTitle;
            Base::CFLString<wchar_t> m_strRoot; 
            ETreeItemIcon m_eRootIcon;
 
            bool m_bInitialized;
            bool m_bPreTerminate;
 
            bool m_bPreInitPaneMenuVisibility;
            bool m_bPreInitPaneLogVisibility;
            bool m_bPreInitPaneCodeVisibility;
            bool m_bPreInitPaneExampleSNAPVisibility;
            bool m_bPreInitPaneColorTableVisibility;
            bool m_bPreInitPaneViewGraphVisibility;
            bool m_bPreInitPaneSheetVisibility;
            bool m_bEnableMenuItemSNAPObject;
 
            bool m_bLoadFixedViewPlacementSetting;
            bool m_bLoadThemeSetting;
            bool m_bLoadWorkingPane;
            bool m_bLoadFavoriteMenuItemSetting;
            bool m_bLoadMenuItemExpandSetting;
            bool m_bLoadFavoriteExampleSNAPSetting;
            bool m_bLoadExampleSNAPExpandSetting;
            bool m_bLoadFontSetting;
 
            bool m_bEnableWriteWorkingPanes;
 
            bool m_bNowLoadingFavoriteMenu;
            bool m_bNowLoadingFavoriteExampleSNAP;
            bool m_bNowLoadingMenuItemExpand;
            bool m_bNowLoadingExampleSNAPExpand;
            bool m_bNowLoadingFixedViewPlacement;
            bool m_bNowSwitchingViewTab;
 
            std::stack<HINSTANCE>& m_stackResources;
            std::deque<CGUIMenuItemBase*>& m_deqMenuItems;
            std::map<uint32_t, bool>& m_mapResourceIdChargedStatus;
            std::vector<CGUIMenuItemFixedViewPlacementSet*>& m_vctMenuItemFvpSet;
            std::set<Base::CFLString<wchar_t>>& m_setPaneName;
            std::vector<SMenuItemPredefinedExpandSetting*>& m_vctMenuItemPredefinedExpandSetting;
 
            EPaneType m_ePaneCreationOnInitialize;
            CRuntimeClass* m_pRtiOrg;
            DWORD m_dwMainThreadID;
 
            CGUITreeContainer* m_pTreeContainerMenuItem;
 
            friend class CGUIMenuItemBase;
        };
    }
}