deffiles.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 <DgnPlatform\DgnDocumentManager.h>

#include <DgnPlatform\DgnCoreAPI.h>
#include <DgnPlatform\WorkSet.h>            // DgnWorkSetCR

#include <Mstn\MstnDefs.h>
#include <Mstn\MicroStation.r.h>

#include <list>

/*----------------------------------------------------------------------+
|                                                                       |
|   Typedefs                                                            |
|                                                                       |
+----------------------------------------------------------------------*/
struct FileInfoDocumentHistory
    {
private:
    std::list<DgnDocumentMonikerPtr>  m_documentMonikers;    

public:
    MSCORE_EXPORT void    Clear() {m_documentMonikers.clear();        }
    MSCORE_EXPORT size_t  Count() const {return m_documentMonikers.size();  }

    MSCORE_EXPORT void    Add (DgnDocumentMonikerPtr m);
    MSCORE_EXPORT void    Add (WCharCP file);

    MSCORE_EXPORT bool    Remove (DgnDocumentMonikerPtr m);
    MSCORE_EXPORT bool    Remove (WCharCP file);

    MSCORE_EXPORT DgnDocumentMonikerPtr   GetMoniker (size_t index) const; 
    MSCORE_EXPORT BeFileName              GetFileName (size_t index) const;
    MSCORE_EXPORT BeFileName              GetDisplayName (size_t index) const;

    };

struct FileInfoFolderHistory
    {
private:
    std::list<DgnFolderMonikerPtr>  m_folderMonikers;    

public:
    MSCORE_EXPORT void    Clear() {m_folderMonikers.clear();        }
    MSCORE_EXPORT size_t  Count() {return m_folderMonikers.size();  }

    MSCORE_EXPORT void    Add (DgnFolderMonikerPtr m);
    MSCORE_EXPORT void    Add (WCharCP folder);

    MSCORE_EXPORT bool    Remove (DgnFolderMonikerPtr m);
    MSCORE_EXPORT bool    Remove (WCharCP folder);

    MSCORE_EXPORT DgnFolderMonikerPtr GetMoniker (size_t index); 
    MSCORE_EXPORT BeFileName          GetFileName (size_t index);

    };


struct FileInfoItemHistory
    {
private:
    std::list<BeFileName>  m_names;    

public:
    MSCORE_EXPORT void    Clear() { m_names.clear();       }
    MSCORE_EXPORT size_t  Count() { return m_names.size(); }

    MSCORE_EXPORT void    Add (WCharCP name);
    MSCORE_EXPORT bool    Remove (WCharCP name);
    MSCORE_EXPORT bool    RemoveAtIndex (size_t index);

    MSCORE_EXPORT BeFileName GetFileName (size_t index);
    };


struct FileInfoHistory
    {
    FileInfoDocumentHistory documents;
    FileInfoFolderHistory   folders;
    FileInfoItemHistory     filters;
    FileInfoItemHistory     logicals;

    void Clear ()
        {
        documents.Clear();
        folders.Clear();
        filters.Clear();
        logicals.Clear();
        }

    };


struct DefaultFileInfo
    {
    BeFileName  fileName;       
    BeFileName  fileFilter;
    BeFileName  defDir;         

    FileInfoHistory history;

    DefaultFileInfo () { Clear (); }

    ~DefaultFileInfo() {} 

    void Clear ()
        {
        history.Clear();;
        }
  
    void Format 
        (
        WCharCP         fileNameP,      /* => File name to save. */
        WCharCP         fileFilterP,    /* => File Filter to save. */
        WCharCP         defaultDirP,    /* => Default Directory to save. */
        WCharCP         cfgVarP         /* => Cfg Var to save */
        );

    };

/*=================================================================================**/
struct WorkSetHistoryData
    {
    WString m_workSpaceName;
    WString m_workSetName;
    };

/*=================================================================================**/
struct WorkSetHistoryList
    {

    private: std::list<WorkSetHistoryData>                   m_workSetInfoList;

    public: MSCORE_EXPORT void                               Add (DgnWorkSetCR workSet);
    public: MSCORE_EXPORT bool                               Remove (DgnWorkSetCR workset);
    public: MSCORE_EXPORT void                               Add (WorkSetHistoryData& data);
    public: MSCORE_EXPORT bool                               Remove (WorkSetHistoryData& data);
    public: MSCORE_EXPORT void                               GetAtIndex (size_t index, WorkSetHistoryData& data);
    public: MSCORE_EXPORT void                               Clear ();
    public: MSCORE_EXPORT size_t                             Count ();
    };

/*=================================================================================**/
struct WorkSetHistoryInfo
    {
    private: WorkSetHistoryList                       m_workSetHistoryList;

    public:  MSCORE_EXPORT void                       Clear ();
    public:  MSCORE_EXPORT StatusInt                  ToStorage ();
    public:  MSCORE_EXPORT StatusInt                  FromStorage ();
    public:  MSCORE_EXPORT WorkSetHistoryList&        GetWorkSetHistory ();
    public:  MSCORE_EXPORT StatusInt                  AddWorkSet (DgnWorkSetCR workSet);
    public:  MSCORE_EXPORT StatusInt                  RemoveWorkSet (DgnWorkSetCR workSet);
    };