filelist.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 "dlogitem.h"
#   include "rscdefs.r.h"

#   include <RmgrTools\Tools\msstrlst.h>    // for StringListP

// @addtogroup FileLists
// @beginGroup

/*----------------------------------------------------------------------+
|                                                                       |
|   Indexes into the file type icon lists                               |
|                                                                       |
+----------------------------------------------------------------------*/
#define     FILETYPELIST_INDEX_MICROSTION_SMALL                 0
#define     FILETYPELIST_INDEX_MICROSTION_MEDIUM                1
#define     FILETYPELIST_INDEX_MICROSTION_LARGE                 2
#define     FILETYPELIST_INDEX_MICROSTION_V7_SMALL              3
#define     FILETYPELIST_INDEX_MICROSTION_V7_MEDIUM             4
#define     FILETYPELIST_INDEX_MICROSTION_V7_LARGE              5
#define     FILETYPELIST_INDEX_MICROSTION_DWG_SMALL             6   // includes DXF
#define     FILETYPELIST_INDEX_MICROSTION_DWG_MEDIUM            7   // includes DXF
#define     FILETYPELIST_INDEX_MICROSTION_DWG_LARGE             8   // includes DXF
#define     FILETYPELIST_INDEX_MICROSTION_UNKNOWN_SMALL         9
#define     FILETYPELIST_INDEX_MICROSTION_UNKNOWN_MEDIUM        10
#define     FILETYPELIST_INDEX_MICROSTION_UNKNOWN_LARGE         11
#define     FILETYPELIST_INDEX_MICROSTION_PROTECTED_SMALL       12
#define     FILETYPELIST_INDEX_MICROSTION_PROTECTED_MEDIUM      13
#define     FILETYPELIST_INDEX_MICROSTION_PROTECTED_LARGE       14
#define     FILETYPELIST_INDEX_MICROSTION_SIGNED_SMALL          15
#define     FILETYPELIST_INDEX_MICROSTION_SIGNED_MEDIUM         16
#define     FILETYPELIST_INDEX_MICROSTION_SIGNED_LARGE          17
#define     FILETYPELIST_INDEX_MICROSTION_2D_SMALL              18  // MicroStation design files only
#define     FILETYPELIST_INDEX_MICROSTION_2D_MEDIUM             19  // MicroStation design files only
#define     FILETYPELIST_INDEX_MICROSTION_2D_LARGE              20  // MicroStation design files only

/*----------------------------------------------------------------------+
|                                                                       |
|   File List Magic Constant                                            |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELIST_VOLUMEMAGIC  0x00535653

/*----------------------------------------------------------------------+
|                                                                       |
|   File User Message Constants                                         |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTTYPE_UPDATE         1
#define FILELISTTYPE_SETFILENAME    2
#define FILELISTTYPE_SETFILTER      3
#define FILELISTTYPE_CLEARFILENAME  4
#define FILELISTTYPE_SETDIRECTORY   5

#define FILELISTDATA_DRIVES         1
#define FILELISTDATA_DIRECTORIES    2
#define FILELISTDATA_FILES          3

/*----------------------------------------------------------------------+
|                                                                       |
|   File List Attributes Constants                                      |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_SORT               0x00000001
#define FILELISTATTR_UNIQUE             0x00000002
#define FILELISTATTR_CASESENSITIVE      0x00000004
#define FILELISTATTR_MULTIPLE           0x00000008
#define FILELISTATTR_CANSELECTEXISTING  0x00000010
#define FILELISTATTR_CANSELECTNEW       0x00000020

#define FILELISTATTR_DRIVES             0x00000040
#define FILELISTATTR_DIRECTORIES        0x00000080
#define FILELISTATTR_FILES              0x00000100

/*----------------------------------------------------------------------+
|                                                                       |
| FILELISTATTR_REPLACEDIRDOTS will return the names of the current and  |
|    parent directories.  It will also replace ".." and "." with the    |
|    actual directory names.  Note that this is only valid in           |
|    combination with FILELISTATTR_DIRECTORIES                          |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_REPLACEDIRDOTS     0x00000200

/*----------------------------------------------------------------------+
|                                                                       |
|   If FILELISTATTR_DRIVES is set FILELISTATTR_NODRIVEBRACKETS will     |
|   return a drive list (on DOS & NT) without the enclosing "[]".       |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_NODRIVEBRACKETS    0x00000400

/*----------------------------------------------------------------------+
|                                                                       |
|   If FILELISTATTR_DIRECTORIES is set FILELISTATTR_NOPARENTDIR         |
|       will keep parent directory out of list.                         |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_NOPARENTDIR        0x00000800

/*----------------------------------------------------------------------+
|                                                                       |
| If you are doing a create and the file to be created already exists,  |
| specifying the following attribute will put up an alert asking you    |
| to confirm that choice. Choosing OK will overwrite the existing file, |
| Cancel will allow you to choose another file to create.               |
| Ignored for FILELISTATTR_MULTIPLE.                                    |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_ALERTONCREATEEXIST 0x00001000

/*----------------------------------------------------------------------+
|                                                                       |
| Part of FILELISTATTR_CREATEFROMSEED.                                  |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_SEEDFILESPECIFIED  0x00002000

/*----------------------------------------------------------------------+
|                                                                       |
| If this is set, put volumes before desktop directories in the list    |
| (this is Mac-only feature)                                            |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_SORTVOLUMESFIRST   0x00004000

/*----------------------------------------------------------------------+
|                                                                       |
| If this is set in conjunction with FILELISTATRR_DIRECTORIES,          |
|  include a check box that says to include subdirectories              |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_SUBDIRSCHECKBOX    0x00008000

/*----------------------------------------------------------------------+
|                                                                       |
| If this is set then allow only normal V8 files, i.e., exlude          |
|   non-V8 files and V8 files that are workfiles or shared files.       |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_NORMALV8FILES      0x00010000

/*----------------------------------------------------------------------+
|                                                                       |
| If this is set then allow only shared V8 files                        |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_SHAREDV8FILES      0x00010000

/*----------------------------------------------------------------------+
|                                                                       |
| If this is set then never use Winopen                                 |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_DONTUSEWINOPEN     0x00020000

/*----------------------------------------------------------------------+
|                                                                       |
| If this is set then do not override the initial directory from        |
| defFileId.
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_DONTDEFAULTTODEFFILE 0x00040000

/*----------------------------------------------------------------------+
|                                                                       |
| If this is set then always use Winopen                                |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_ALWAYSUSEWINOPEN     0x00080000


/*----------------------------------------------------------------------+
|                                                                       |
| Common attribute sets                                                 |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILELISTATTR_OPEN           FILELISTATTR_CANSELECTEXISTING

#define FILELISTATTR_CREATE         (FILELISTATTR_CANSELECTNEW | \
                                     FILELISTATTR_ALERTONCREATEEXIST)

#define FILELISTATTR_CREATEFROMSEED (FILELISTATTR_CREATE | \
                                     FILELISTATTR_SEEDFILESPECIFIED)

#define FILELISTATTR_OPENCREATE     (FILELISTATTR_CANSELECTEXISTING | \
                                     FILELISTATTR_CANSELECTNEW | \
                                     FILELISTATTR_ALERTONCREATEEXIST)

#define FILELISTATTR_DEFAULT        (FILELISTATTR_SORT | \
                                     FILELISTATTR_UNIQUE | \
                                     FILELISTATTR_MULTIPLE | \
                                     FILELISTATTR_OPEN | \
                                     FILELISTATTR_FILES)

struct FileListInfo
    {
    int     lastAction;
    WChar lastDirectory[MAXFILELENGTH];
    WChar lastFilter[MAXEXTENSIONLENGTH];
    } ;

/*----------------------------------------------------------------------+
|                                                                       |
| Possible attributes for mdlDialog_fileOpenExt                         |
|                                                                       |
+----------------------------------------------------------------------*/
#define FILEOPENEXTATTR_CENTERONSCREEN          0x00000001
#define FILEOPENEXTATTR_DONTDEFAULTTODEFFILE    0x00000002

/*----------------------------------------------------------------------+
|                                                                       |
| Structure used with mdlDialog_fileOpenExt                             |
|                                                                       |
+----------------------------------------------------------------------*/
/*---------------------------------------------------------------------------------**/
struct FileOpenParams
    {
    RscFileHandle   dialogRscH;

    RscId           dialogId;

    int             openCreate;

    WCharCP         suggestedFileNameP;

    WCharCP         defaultFilterP;

    WCharCP         filterInfoStrP;


    WCharCP         defaultDirP;

    WCharCP         dirCfgVarP;    

    WCharCP         titleP;

    RscId           defFileId;

    RscFileHandle   defFileRscH;

    MdlDesc*        dialogOwnerMD;

    WCharP          defSeedFileNameP;

    WCharCP         defSeedDirP;

    WCharCP         defSeedFilterP;

    RscId           defSeedFileId;

    UInt32          requiredRights;

    DgnFileSupplyRightsP reloadContext;
                            
    RscId               filterStringListId;
    RscFileHandle       filterStringHandle;

    struct
        {
        UInt32          preIncludeCADFileOpenFilters:1;
        UInt32          postIncludeCADFileOpenFilters:1;
        UInt32          unused:30;
        } filterFlags;
    int             winOpenReturnCode;      // if winopen is used, the return code from it.
    int             futureUse;

    WCharCP       futureUseCharP[4];

    WCharCP         workSetNameP;

    WCharCP         workSpaceNameP;
    };

/*----------------------------------------------------------------------+
|                                                                       |
| Structure returned by mdlDialog_fileOpenExt                           |
|                                                                       |
+----------------------------------------------------------------------*/
struct FileOpenExtraInfo
    {
    WChar           dirCfgVar[MAXNAMELENGTH];       /* name of cfg var used to select dir */
    WChar           seedFileName[MAXFILELENGTH];    /* seed file used to create new file  */
    };

/*----------------------------------------------------------------------+
|                                                                       |
| Structure used with mdlFileList_edit                                  |
|                                                                       |
+----------------------------------------------------------------------*/
struct FileEditParams
    {
    WChar           dialogTitle[2*MAXFILELENGTH];
    WChar           listLabel[2*MAXFILELENGTH];
    WChar           defaultFilter[2*MAXFILELENGTH];
    WChar           defaultDir[2*MAXFILELENGTH];
    long            attributes;
    StringListP     strListP;
    RscId           dialogId;
    FileOpenParams* fileOpenParamsP;
    };