ISessionMgr.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include "DocumentManager.h"


BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE
/*=================================================================================**/
enum ChooseMasterFileStatus
      {
      CHOOSEMASTERFILE_STATUS_Invalid   = 0,
      CHOOSEMASTERFILE_STATUS_Handled   = 1,
      CHOOSEMASTERFILE_STATUS_Canceled  = 2,
      };

enum class UIItemStateType
    {
    None        = 0,         
    Visible     = (1 << 0),  
    Enabled     = (1 << 1),  
    Checked     = (1 << 2),  
    };


/*=================================================================================**/
struct SessionMonitor
    {
    virtual void _OnMasterFileStart (DgnFileR) {}
    virtual void _OnMasterFileStop (DgnFileR, bool changingFiles) {}

    virtual void _OnModelRefPreActivate (DgnModelRefR modelRef) {}
    virtual void _OnModelRefActivate (DgnModelRefR newModelRef, DgnModelRefP oldModelRef) {}
    virtual void _OnModelRefActivated (DgnModelRefR newModelRef, DgnModelRefP oldModelRef) {}

    virtual void _OnReleaseWriteLock (T_DgnFilePtrVectorCR dgnFileVector) {}
    virtual void _OnReleasedWriteLock (T_DgnFilePtrVectorCR dgnFileVector) {}

    virtual void _OnWriteLocked (DgnFileR) {}
    virtual void _OnChooseMasterFile (ChooseMasterFileStatus&, DgnDocumentPtr&, WCharCP modelName) {}

    virtual bool __cdecl Dummy5() {return false;}
    virtual bool __cdecl Dummy4() {return false;}
    virtual bool __cdecl Dummy3() {return false;}
    virtual bool __cdecl Dummy2() {return false;}
    virtual bool __cdecl Dummy1() {return false;}
    };

/*=================================================================================**/
struct  ISessionMgr
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
        MSCORE_EXPORT static DgnHostR  GetMicroStationDgnHost();

        MSCORE_EXPORT static ISessionMgrR GetManager();

        MSCORE_EXPORT DgnDocumentP GetMaster();

        MSCORE_EXPORT static DgnFileP GetMasterDgnFile();

        MSCORE_EXPORT static DgnFileP GetActiveDgnFile();

        MSCORE_EXPORT static DgnModelP GetActiveDgnModelP();

        MSCORE_EXPORT static bool IsMasterFileClosing();

        MSCORE_EXPORT static bool IsDesignFileInitialized();

        MSCORE_EXPORT bool IsReadyForUIProcessing();

        MSCORE_EXPORT static bool IsMasterDgnFile(DgnFileP);

        MSCORE_EXPORT static bool IsActiveDgnFile(DgnFileP);

        MSCORE_EXPORT static DgnModelRefP GetActiveDgnModelRefP();

        MSCORE_EXPORT static bool IsActiveModel(DgnModelRefCP);

        MSCORE_EXPORT static bool InMasterFile(DgnModelRefP);

        MSCORE_EXPORT static bool InActiveFile(DgnModelRefP);

        MSCORE_EXPORT static bool InTransactableFile(DgnModelRefP);

        MSCORE_EXPORT static void SetAutoLockActiveModel(bool val);
        MSCORE_EXPORT static bool IsActiveModelLocked();
        MSCORE_EXPORT static void SetActiveModelLocked(bool val);

        MSCORE_EXPORT DgnPlatform::DgnFileStatus SwitchToNewFile(DgnDocumentR doc, WCharCP inputModelName, int fileType, bool doUpdate, bool releaseReferences, bool reopeningAfterSave = false, bool runInitUCM = false);

        MSCORE_EXPORT DgnFilePtr FindDesignFile(DgnPlatform::DgnFileStatus& status, WCharCP inFileName, WCharCP inModelName, int fileType, bool allowCancel);

        MSCORE_EXPORT DgnDocumentPtr OpenDgnFileDialog(DgnPlatform::DgnFileStatus& status);

        MSCORE_EXPORT StatusInt CreateNewDgnFile(WStringR newName, WCharCP defaultDir, bool switchToNewFile);

        MSCORE_EXPORT static void AddSessionMonitor(SessionMonitor& mon);

        MSCORE_EXPORT static void DropSessionMonitor(SessionMonitor& mon);

        MSCORE_EXPORT T_DgnFilePtrVectorCR GetWriteableFiles();

        MSCORE_EXPORT bool SaveDgnFileChanges(T_DgnFilePtrVectorCR docs);

        MSCORE_EXPORT void SetUIItemState(WCharCP key, UIItemStateType itemState, bool value, bool sendImmediateMessage = false);

        MSCORE_EXPORT bool GetUIItemState(WCharCP key, UIItemStateType itemState, bool defaultIfKeyNotFound);

        MSCORE_EXPORT void SetUIItemMenuMarkState(WCharCP key, MenuMarkType value = MARK_NONE, bool sendImmediateMessage = false);

        MSCORE_EXPORT MenuMarkType  GetUIItemMenuMarkState(WCharCP key, MenuMarkType defaultIfKeyNotFound = MARK_NONE);

        MSCORE_EXPORT void RemoveUIItemStateEntry(WCharCP key);
};


END_BENTLEY_MSTNPLATFORM_NAMESPACE