mdlg.h

Go to the documentation of this file.

/**
 * \file mdlg.h <mi32/mdlg.h>
 * \brief Definitions for standard dialogs
 *
 * \if NODOC
 * $Id: mdlg.h_v 1.85 2004/06/22 20:54:28 mju Exp $
 *
 * $Log: mdlg.h_v $
 * Revision 1.85  2004/06/22 20:54:28  mju
 * Move mdlgShowErrorCode to stddefns.
 *
 * Revision 1.84  2004/05/13 19:24:12  scowan
 * Added continue for ask question button.
 *
 * Revision 1.83  2004/03/05 14:35:55  mju
 * Add default ctor for getfolderfilter.
 *
 * Revision 1.82  2004/03/04 18:40:00  mju
 * Use forward-decl to avoid unneeded hdr.
 *
 * Revision 1.81  2004/03/03 14:55:19  mju
 * Ignore warning about deprecated declaration within header.
 *
 * Revision 1.80  2004/03/01 15:24:35  dwilliss
 * Hook function needed callback data
 *
 * Revision 1.79  2004/03/01 15:10:11  dwilliss
 * Added function to set message hook
 *
 * Revision 1.78  2004/02/18 20:17:07  mju
 * Only ifdef out certain prototypes.
 *
 * Revision 1.77  2004/02/18 17:46:58  mju
 * Exclude entire header unless X/MFC.
 *
 * Revision 1.76  2004/02/17 13:06:55  mju
 * Remove unwanted inline.
 *
 * Revision 1.75  2004/02/16 21:34:10  mju
 * Don't have inline call deprecated function as warns unnecessarily.
 *
 * Revision 1.74  2004/02/16 20:57:15  mju
 * Warn on deprecated usage.
 *
 * Revision 1.73  2003/12/18 13:39:36  mju
 * Remove deprecated items.
 *
 * Revision 1.72  2003/10/24 21:11:20  mju
 * Remove obsolete mdlgAskNumber variants.
 *
 * Revision 1.71  2003/10/24 20:03:16  mju
 * Rmv mdlgshowmessagestr prototype.
 *
 * Revision 1.70  2003/10/24 15:11:37  mju
 * Remove obsolete ShowMsg variant using textid and char* helpid.
 *
 * Revision 1.69  2003/10/24 13:47:20  mju
 * Can't inline deprecated asknumber/string as calls another deprecated fn.
 *
 * Revision 1.68  2003/10/24 13:09:32  mju
 * Fully deprecate stuff using char* title but not groupkey.
 *
 * Revision 1.67  2003/10/22 15:16:25  mju
 * Change default for flag to MdlgShowMessageCode to allow saving text.
 *
 * Revision 1.66  2003/10/17 14:53:05  mju
 * Remove unused stuff.
 * Add MdlgAskNumber/String variants with no 'title' parm.
 * Deprecate more group/key stuff.
 * Document MdlgAskYesno/Cancel as being "deprecated".
 *
 * Revision 1.65  2003/10/15 17:02:03  mju
 * Add ShowMessage variant using const MISTRING& and HELPID.
 * Use DEPRECATE_OLDHELP on other ShowMessage... variants.
 *
 * Revision 1.64  2003/10/09 15:10:14  scowan
 * Fixed for deprecated groupkey define.
 *
 * Revision 1.63  2003/09/25 21:29:07  dwilliss
 * Don't capitalize enum any more. Genitor needed it, doxygen doesn't like it.
 *
 * Revision 1.62  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.61  2003/09/09 14:20:18  msmith
 * removed savediscardcancel
 *
 * Revision 1.60  2003/09/08 21:05:05  dwilliss
 * Added doxygen start/end tags for functions groups
 *
 * Revision 1.59  2003/09/08 19:40:49  scowan
 * Changed dl;gqw enum flags.
 *
 * Revision 1.58  2003/09/05 21:26:41  mju
 * Add DLGQSTYLE and MdlgAskQuestion.
 *
 * Revision 1.57  2003/08/29 19:48:47  mju
 * Forgot to inline some things.
 *
 * Revision 1.56  2003/08/29 16:44:22  mju
 * Fix helpid stuff.
 * Add versions taking const mistring refs.
 * Be specific about DLGRESPONSE values.
 * Add MdlgAskYN/NYC variants using DLGRESPONSE.
 *
 * Revision 1.55  2003/08/19 22:39:55  msmith
 * Added MdlgAskSaveDiscardCancel
 *
 * Revision 1.54  2003/08/19 21:03:49  msmith
 * Nothing.
 *
 * Revision 1.53  2003/06/26 16:17:36  mju
 * Add DEPRECATE_GROUPKEY.
 *
 * Revision 1.52  2003/05/28 16:09:37  mju
 * ?
 *
 * Revision 1.51  2003/04/01 16:45:46  mju
 * Add MdlgShowProductInfo.
 *
 * Revision 1.50  2003/02/24 15:00:33  mju
 * Don't define unimplemented versions for X.
 *
 * Revision 1.49  2003/02/05 15:08:26  scowan
 * nc.
 *
 * Revision 1.48  2003/01/16 16:06:27  mju
 * Add filter to AskString.
 * Add TEXTID version of AskString.
 *
 * Revision 1.47  2003/01/15 21:56:44  mju
 * Add TEXTID version of YesNo/Cancel dialogs.
 *
 * Revision 1.46  2002/08/14 13:51:23  mju
 * Add more getfile variants for mfc.
 *
 * Revision 1.45  2002/08/13 15:51:41  mju
 * Limit use of older getfile fns to X version.
 *
 * Revision 1.44  2002/08/13 14:39:59  scowan
 * nc.
 *
 * Revision 1.43  2002/05/29 20:56:08  mju
 * Remove ambiguous overload.
 *
 * Revision 1.42  2002/05/29 17:31:22  mju
 * Add defaults for MdlgShowMessage.
 *
 * Revision 1.41  2002/03/29 21:13:35  mju
 * Remove varargs parm from DlgShowMessage.
 *
 * Revision 1.40  2002/03/29 18:50:08  mju
 * Add MdlgShowMessage using TEXTID.
 *
 * Revision 1.39  2002/03/29 18:40:43  mju
 * Un-deprecated MdlgShowMessage.
 *
 * Revision 1.38  2002/03/29 18:15:40  mju
 * Deprecate var args version.
 *
 * Revision 1.37  2001/12/20 21:46:13  mju
 * Enum docs.
 *
 * Revision 1.36  2001/09/13 21:09:45  mju
 * MFC stuff no longer in DLL.
 *
 * Revision 1.35  2001/07/16 14:44:22  mju
 * In MdlgAskNumber/String for msg lookup use "promptpopup" for group if NULL.
 *
 * Revision 1.34  2001/07/16 14:30:16  mju
 * Forgot inlines.
 *
 * Revision 1.33  2001/07/16 14:10:05  mju
 * Add MdlgAskNumber/String.
 *
 * Revision 1.31  2001/05/09 16:50:06  mju
 * Add MdlgGetFolder defns.
 *
 * Revision 1.30  2001/03/13 22:49:50  mju
 * Add GETFILEFLAG_AllowAllFiles.
 *
 * Revision 1.29  2000/12/28 21:07:50  mju
 * Add MdlgShowMessage with no flags parm.
 *
 * Revision 1.1  1998/12/28  16:29:52  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MI32_MDLG_H
#define  INC_MI32_MDLG_H

#ifndef  INC_MI32_STDDEFNS_H
   #include <mi32/stddefns.h>
#endif

#ifndef  INC_MI32_HELPID_H
   #include <mi32/helpid.h>
#endif

#ifndef  INC_MI32_FILEPATH_H
   #include <mi32/filepath.h>
#endif

#ifdef WIN32
#pragma warning (disable:4996)   // Disable warning about deprecated declaration within header
#endif

//! Forward declarations
struct FNAMEUC;
class GETSTRINGFILTER;


//-------------------------------------------------------------------------------------------------------------------
//! Base class for filter used in file/folder selection dialogs.
class GETFILEFILTER {
   public:

      //! Constructor.
      GETFILEFILTER (
         ) { }

      //! Destructor.
      virtual ~GETFILEFILTER (
         ) { }

      //! Method called when user attempts to select a file (or folder).
      //! @return 'true' if selection acceptable, 'false' if not.
      virtual bool OnSelection (
         const FILEPATH& path
         ) = 0;

      //! Set message returned by filter using message lookup from [getfile] group.
      void SetFilterMsg (
         const char *msgkey
         );

      //! Set message returned by filter using UNICODE string.
      void SetFilterMsg (
         const UNICODE* string
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MISTRING m_msgstr;

      GETFILEFILTER (const GETFILEFILTER&);
      GETFILEFILTER& operator= (const GETFILEFILTER&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//-------------------------------------------------------------------------------------------------------------------
//!      Definitions for MdlgGetFile...                                          
//-------------------------------------------------------------------------------------------------------------------

typedef int (*MdlgGetFilesValidMultiProto) (const FILEPATHLIST& list, void*, char*);
typedef int (*MdlgGetFileFilterProto) (UNICODE*, char*, void*);

enum GETFILEFLAGS {
   GETFILEFLAG_None =            0,
   GETFILEFLAG_NewOK =           0x00000001, //!< Let user create new file
   GETFILEFLAG_DftNew =          0x00000002, //!< Default to new file if user presses OK
   GETFILEFLAG_SkipOK =          0x00000004, //!< Allow user to skip this selection
   GETFILEFLAG_OnlyNew =         0x00000008, //!< Don't let user select existing files
   GETFILEFLAG_MakeNew =         0x00000010, //!< Warn user if select existing file for overwrite
   GETFILEFLAG_NoDftExtn =       0x00000020, //!< XXX obsolete
   GETFILEFLAG_CanChgExtn =      0x00000040, //!< XXX obsolete
   GETFILEFLAG_AltDescFunc =     0x00000100, //!< Use alternate description function XXX implemented?
   GETFILEFLAG_UseFilter =       0x00000200, //!< XXX obsolete
   GETFILEFLAG_FilterByExtn =    0x00000400, //!< Filter by extension
   GETFILEFLAG_SortByExtn =      0x00000800, //!< Sort files by extension, then name
   GETFILEFLAG_Unicode =         0x00001000, //!< Use Unicode prompt string directly instead of doing lookup
   GETFILEFLAG_SkipNone =        0x00002000, //!< Change "Skip" button to "None"
   GETFILEFLAG_AllowFewer =      0x00004000, //!< Allow fewer than requested number of files for MdlgGetFileSet...()
   GETFILEFLAG_AllowAutoName =   0x00008000, //!< Allow "auto-name" for MdlgGetFileSet...()
   GETFILEFLAG_ExtnUnicode =     0x00010000, //!< XXX obsolete
   GETFILEFLAG_SelectDir =       0x00020000, //!< Select directory instead of file
   GETFILEFLAG_AllowDefault =    0x00080000, //!< Use provided filename for default new file
   GETFILEFLAG_AllowAllFiles =   0x00100000, //!< Allow all file types option
   };
DEFINE_ENUM_OPERATORS(GETFILEFLAGS);


//-------------------------------------------------------------------------------------------------------------------

//!\addtogroup mdlg Mdlg functions
//!@{

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to prompt user for single file using UNICODE filename (X only).
int MdlgGetFile (
   MDLGPARENT dlgparent,
   UNICODE *filename,                        //!< File path/name passed/returned
   const char *extns,                        //!< Extensions to show, if any
   const void *prompt,
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None,
   int (*createoptfunc)(Widget,void*) = 0,   //!< Function to create optional controls on dialog
   void *createoptdata = 0
   );
#endif


#if defined(X_NATIVE) || defined(WIN32_MFC)
int MdlgGetFile (
   MDLGPARENT dlgparent,
   FILEPATH& filename,                       //!< File path/name passed/returned
   const char *extns,                        //!< Extensions to show, if any
   const void *prompt,
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None
#ifdef X_NATIVE
   ,
   int (*createoptfunc)(Widget,void*) = 0,   //!< Function to create optional controls on dialog
   void *createoptdata = 0
#endif
   );
#endif


#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to prompt user for single file using UNICODE filename and UNICODE extension (X only).
int MdlgGetFileExtnUC (
   MDLGPARENT dlgparent,
   UNICODE *filename,                        //!< File path/name passed/returned
   const UNICODE *extns,                     //!< Extensions to show, if any
   const void *prompt,
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None,
   int (*createoptfunc)(Widget,void*) = 0,   //!< Function to create optional controls on dialog
   void *createoptdata = 0
   );
#endif


#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to prompt user for single file using FILEPATH and UNICODE extension (X only).
int MdlgGetFileExtnUC (
   MDLGPARENT dlgparent,
   FILEPATH& filename,                       //!< File path/name passed/returned
   const MISTRING& extns,                    //!< Extensions to show, if any
   const void *prompt,
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None,
   int (*createoptfunc)(Widget,void*) = 0,   //!< Function to create optional controls on dialog
   void *createoptdata = 0
   );
#endif


#if /*defined(X_NATIVE) ||*/ defined(WIN32_MFC)
//! Prompt user for single file using UNICODE* title and extension filter list.
ERRVALUE MdlgGetFile (
   MDLGPARENT parent,            //!< Parent for dialog
   FILEPATH& filepath,           //!< Path to file passed/returned
   const char *ExtnFilters,      //!< Extension filters in form "msgkey|extns|msgkey|extns"  extns are ;-separated and must include "*."
   const UNICODE *title,         //!< Title for dialog prompt
   GETFILEFLAGS getfileflags,    //!< Flags
   GETFILEFILTER *filter = 0     //!< Optional filter
   );
#endif


#if /*defined(X_NATIVE) ||*/ defined(WIN32_MFC)
//! Prompt user for single file using title from message lookup.
ERRVALUE MdlgGetFile (
   MDLGPARENT parent,            //!< Parent for dialog
   FILEPATH& filepath,           //!< Path to file passed/returned
   const char *ExtnFilters,      //!< Extension filters in form "msgkey|extns|msgkey|extns"  extns are ;-separated and must include "*."
   const char *TitleKey,         //!< Title key for use with 'getfile' group in message file
   GETFILEFLAGS getfileflags,    //!< Flags
   GETFILEFILTER *filter = 0     //!< Optional filter
   );
#endif


#ifdef X_NATIVE
//! Display dialog allowing user to select multiple files (X only).
int MdlgGetFiles (
   Widget dlgparent,
   UNICODE *filename,                        //!< Default filename
   const char *extns,                        //!< Extensions to show, if any
   const void *prompt,
   int minfiles,                             //!< Minimum number of files required
   int maxfiles,                             //!< Maximum allowed to be selected, 0 if no limit
   FNAMEUC **fnameret,
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None,
   MdlgGetFilesValidMultiProto validfunc = 0,
   int (*createoptfunc)(Widget,void*) = 0,   //!< Function to create optional controls on dialog
   void *createoptdata = 0
   );
#endif


#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Display dialog allowing user to select multiple files.
int MdlgGetFiles (
   Widget dlgparent,
   FILEPATH& filename,                       //!< Default filename
   const char *extns,                        //!< Extensions to show, if any
   const void *prompt,
   int minfiles,                             //!< Minimum number of files required
   int maxfiles,                             //!< Maximum allowed to be selected, 0 if no limit
   FILEPATHLIST& FileList,
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None,
   MdlgGetFilesValidMultiProto validfunc = 0
#ifdef X_NATIVE
   ,
   int (*createoptfunc)(Widget,void*) = 0,   //!< Function to create optional controls on dialog
   void *createoptdata = 0
#endif
   );
#endif


#ifdef X_NATIVE
//! Prompt user for "set" of filenames with allowance for optional controls (X only).
int MdlgGetFileSet (
   Widget dlgparent,
   UNICODE *filename,                        //!< Default filename
   const char *extns,                        //!< Extensions to show, if any
   const void *prompt,
   int setnumfiles,                          //!< Number of files to be selected
   FNAMEUC fname[],
   UNICODE **filelabel,                      //!< Labels and default names for each file
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None,
   MdlgGetFilesValidMultiProto validfunc = 0,
   int (*updatefunc)(FILEPATHLIST::ITERATOR,void*) = 0,  //!< Function called when any file in the set is changed by the user
   int (*createoptfunc)(Widget,void*) = 0,   //!< Function to create optional controls on dialog
   void *createoptdata = 0
   );
#endif


//! Prompt for a text file with user-specified encoding.
ERRVALUE MdlgGetTextFile (
   MDLGPARENT dlgparent,                     //!< Parent for dialog
   FILEPATH& filepath,                       //!< File path passed/returned
   CHAR_ENCODING& encoding,                  //!< Text character encoding passed/returned
   ENCODELIST_FLAGS enclistflags,            //!< Flags specifying allowed encodings
   const char *extns,                        //!< Extensions to show, if any
   const void *prompt,                       //!< Prompt message
   MdlgGetFileFilterProto filterfunc = 0,    //!< Filter function
   void *funcdata = 0,                       //!< Data to pass to filter function
   GETFILEFLAGS flags = GETFILEFLAG_None     //!< File selection flags
   );

//!@}

//----------------------------------------------------------------------------
//    Definitions for MdlgGetFolder...
//----------------------------------------------------------------------------

class GETFOLDERFILTER : public GETFILEFILTER {
   public:
      GETFOLDERFILTER () {}
   private:
      GETFOLDERFILTER (const GETFOLDERFILTER&);
      GETFOLDERFILTER& operator= (const GETFOLDERFILTER&);
   };

//! Flags for MdlgGetFolder.
enum GETFOLDERFLAGS {
   GETFOLDERFLAG_None =          0,
   GETFOLDERFLAG_AllowNew =      0x0001,     //!< Allow new folder to be created
   GETFOLDERFLAG_CheckWritable = 0x0002,     //!< Check if selected folder is writable
   GETFOLDERFLAG_CheckEmpty =    0x0004,     //!< Selected folder must be empty
   };
DEFINE_ENUM_OPERATORS(GETFOLDERFLAGS);


//!\addtogroup mdlg Mdlg functions
//!@{

//! Dialog to allow user to select folder.
ERRVALUE MdlgGetFolder (
   MDLGPARENT dlgparent,                        //!< Parent for dialog
   FILEPATH& filepath,                          //!< Folder path passed/returned
   const MISTRING& promptstr,                   //!< Prompt string (also allows TEXTID)
   GETFOLDERFLAGS flags = GETFOLDERFLAG_None,   //!< Flags
   GETFOLDERFILTER *filter = 0                  //!< Filter
   );

//!@}

//----------------------------------------------------------------------------
//    Definitions for MdlgShowMessage...                                      
//----------------------------------------------------------------------------

// Do not change the values of existing flags as they may be passed to DLLs.
enum MDLG_MESSAGEFLAGS {
   MDLG_MESSAGEFLAG_None =             0,
   MDLG_MESSAGEFLAG_AllowNoShowAgain = 0x00000001, //!< Include "Don't show this message again" toggle
   MDLG_MESSAGEFLAG_AllowSaveText =    0x00000002, //!< Allow message text to be saved to file
   MDLG_MESSAGEFLAG_CenterDialog =     0x00000004, //!< Center dialog on screen
   MDLG_MESSAGEFLAG_NoCancel =         0x00000100, //!< Don't include "cancel" button if default is to show
   MDLG_MESSAGEFLAG_AllowCancel =      0x00000200, //!< Include cancel button if default is not to
   MDLG_MESSAGEFLAG_NoOK =             0x00000400, //!< Don't include "ok" button
   MDLG_MESSAGEFLAG_RetryButton =      0x01000000, //!< Use "Retry" instead of "OK"
   };
DEFINE_ENUM_OPERATORS(MDLG_MESSAGEFLAGS);

// Do not change the values of existing types as they may be passed to DLLs.
//! Message type, used to select icon and window title.
enum MDLG_MESSAGETYPE {
   MDLG_MESSAGETYPE_Default =       0,       //!< No icon
   MDLG_MESSAGETYPE_Information =   1,       //!< 'i' (information) icon
   MDLG_MESSAGETYPE_Warning =       2,       //!< Exclamation point icon
   MDLG_MESSAGETYPE_Error =         3,       //!< circle/slash icon
   MDLG_MESSAGETYPE_Message =       4,       //!< No icon
   MDLG_MESSAGETYPE_Working =       5,       //!< Hourglass icon
   MDLG_MESSAGETYPE_Question =      6,       //!< Question mark icon
   };


//----------------------------------------------------------------------------

typedef int (*MESSAGEHOOKFUNC)(void* cbdata, MDLG_MESSAGETYPE msgtype, const MISTRING& msg, const UNICODE* details);

//----------------------------------------------------------------------------

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Styles for MdlgAskQuestion().
enum DLGQ_STYLE {
   //! Possible buttons, will appear in order listed at bottom of dialog.
   DLGQ_BUTTON_Ok =           0x00000001,    //!< Cannot use with BUTTON_Yes
   DLGQ_BUTTON_Yes =          0x00000002,    //!< Cannot use with BUTTON_Ok
   DLGQ_BUTTON_No =           0x00000004,
   DLGQ_BUTTON_Retry =        0x00000008,
   DLGQ_BUTTON_Save =         0x00000010,
   DLGQ_BUTTON_SaveAs =       0x00000020,
   DLGQ_BUTTON_SaveAll =      0x00000040,
   DLGQ_BUTTON_Discard =      0x00000080,
   DLGQ_BUTTON_DiscardAll =   0x00000100,
   DLGQ_BUTTON_Skip =         0x00000200,
   DLGQ_BUTTON_Continue =     0x00000400,

   DLGQ_BUTTON_Cancel =       0x00010000,

   //! Common button combinations
   DLGQ_BUTTONS_OkCancel =          DLGQ_BUTTON_Ok | DLGQ_BUTTON_Cancel,
   DLGQ_BUTTONS_YesNo =             DLGQ_BUTTON_Yes | DLGQ_BUTTON_No,
   DLGQ_BUTTONS_YesNoCancel =       DLGQ_BUTTON_Yes | DLGQ_BUTTON_No | DLGQ_BUTTON_Cancel,
   DLGQ_BUTTONS_RetryCancel =       DLGQ_BUTTON_Retry | DLGQ_BUTTON_Cancel,
   DLGQ_BUTTONS_SaveDiscardCancel = DLGQ_BUTTON_Save | DLGQ_BUTTON_Discard | DLGQ_BUTTON_Cancel,
   DLGQ_BUTTONS_ContinueCancel =    DLGQ_BUTTON_Continue | DLGQ_BUTTON_Cancel,

   DLGQ_STYLE_CenterText = 0x10000000  //!< Center text in the dialog
   };
DEFINE_ENUM_OP_BITWISE(DLGQ_STYLE);

//! Responses for MdlgAskQuestion().
enum DLGRESPONSE {
   DLGRESPONSE_Cancel = -1000,            //!< Same as EUserCancel
   DLGRESPONSE_No = 0,
   DLGRESPONSE_Ok = 1,
   DLGRESPONSE_Yes = DLGRESPONSE_Ok,
   DLGRESPONSE_Continue = DLGRESPONSE_Ok,
   DLGRESPONSE_Save = 2,
   DLGRESPONSE_SaveAs = 3,
   DLGRESPONSE_SaveAll = 4,
   DLGRESPONSE_Discard = 5,
   DLGRESPONSE_Skip = DLGRESPONSE_Discard,
   DLGRESPONSE_DiscardAll = 6,
   DLGRESPONSE_Retry = 7
   };
#endif

//!\addtogroup mdlg Mdlg functions
//!@{

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to ask user for numeric value (default window title).
ERRVALUE MdlgAskNumber (
   MDLGPARENT dlgparent,                  //!< Parent for dialog
   const MISTRING& prompt,                //!< Prompt string
   double& value,                         //!< Value passed/returned
   double minvalue,                       //!< Minimum allowed value
   double maxvalue,                       //!< Maximum allowed value
   int decplaces,                         //!< Number of decimal places to show
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to ask user for numeric value (window title specified).
ERRVALUE MdlgAskNumber (
   MDLGPARENT dlgparent,                  //!< Parent for dialog
   const MISTRING& dlgtitle,              //!< Dialog title
   const MISTRING& prompt,                //!< Prompt string
   double& value,                         //!< Value passed/returned
   double minvalue,                       //!< Minimum allowed value
   double maxvalue,                       //!< Maximum allowed value
   int decplaces,                         //!< Number of decimal places to show
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to ask user question with buttons for responses (default window title).
//! @return DLGRESPONSE value
DLGRESPONSE MdlgAskQuestion (
   MDLGPARENT parent,                     //!< Parent for dialog, NULL for default
   const MISTRING& text,                  //!< Text to display
   DLGQ_STYLE style,                      //!< Dialog style and buttons
   DLGRESPONSE dftresponse,               //!< Default response (DLGRESPONSE_Yes or DLGRESPONSE_No)
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to ask user question with buttons for responses (window title specified).
//! @return DLGRESPONSE value
DLGRESPONSE MdlgAskQuestion (
   MDLGPARENT parent,                     //!< Parent for dialog, NULL for default
   const MISTRING& dlgtitle,              //!< Title for dialog window
   const MISTRING& text,                  //!< Text to display
   DLGQ_STYLE style,                      //!< Dialog style and buttons
   DLGRESPONSE dftresponse,               //!< Default response (DLGRESPONSE_Yes or DLGRESPONSE_No)
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to ask user for string value (default window title).
ERRVALUE MdlgAskString (
   MDLGPARENT dlgparent,                  //!< Parent for dialog
   const MISTRING& prompt,                //!< Prompt string
   MISTRING& string,                      //!< String passed/returned
   int maxchars = 0,                      //!< Maximum number of characters in string, 0 for no maximum
   HELPID helpid = HELPID__None,          //!< Help ID if help provided
   GETSTRINGFILTER *filter = 0            //!< Optional filter for string validation
   );
#endif

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog to ask user for string value (window title specified).
ERRVALUE MdlgAskString (
   MDLGPARENT dlgparent,                  //!< Parent for dialog
   const MISTRING& dlgtitle,              //!< Dialog title
   const MISTRING& prompt,                //!< Prompt string
   MISTRING& string,                      //!< String passed/returned
   int maxchars = 0,                      //!< Maximum number of characters in string, 0 for no maximum
   HELPID helpid = HELPID__None,          //!< Help ID if help provided
   GETSTRINGFILTER *filter = 0            //!< Optional filter for string validation
   );
#endif

#ifndef DEPRECATE_ALL
#if defined(X_NATIVE) || defined(WIN32_MFC)
//! DEPRECATED Dialog to ask user for Yes/No response.
//! \deprecated Replaced by MdlgAskQuestion
//! @return DLGRESPONSE_Yes or DLGRESPONSE_No
DEPRECATED DLGRESPONSE MdlgAskYesNo (
   MDLGPARENT parent,                     //!< Parent for dialog, NULL for default
   const MISTRING& text,                  //!< Text to display
   DLGRESPONSE dftresponse,               //!< Default response (DLGRESPONSE_Yes or DLGRESPONSE_No)
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif
#endif

#ifndef DEPRECATE_GROUPKEY
#if defined(X_NATIVE) || defined(WIN32_MFC)
//! DEPRECATED Dialog to ask user for Yes/No response with prompt from message lookup.
//! \deprecated Replaced by MdlgAskQuestion
//! @return 0 = "No", 1 = "Yes".
DEPRECATED int MdlgAskYesNo (
   MDLGPARENT parent,                     //!< Parent for dialog, NULL for default
   const char *msgname,                   //!< Message name for lookup in "popupync" group
   int dft,                               //!< Default response
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif
#endif

#ifndef DEPRECATE_ALL
#if defined(X_NATIVE) || defined(WIN32_MFC)
//! DEPRECATED Dialog to ask user for Yes/No/Cancel response.
//! \deprecated Replaced by MdlgAskQuestion
//! @return DLGRESPONSE_Yes, DLGRESPONSE_No or DLGRESPONSE_Cancel
DEPRECATED DLGRESPONSE MdlgAskYesNoCancel (
   MDLGPARENT parent,                     //!< Parent for dialog, NULL for default
   const MISTRING& text,                  //!< Text to display
   DLGRESPONSE dftresponse,               //!< Default response (DLGRESPONSE_Yes, DLGRESPONSE_No or DLGRESPONSE_Cancel)
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif
#endif

#ifndef DEPRECATE_GROUPKEY
#if defined(X_NATIVE) || defined(WIN32_MFC)
//! DEPRECATED Dialog to ask user for Yes/No/Cancel response with prompt from message lookup.
//! \deprecated Replaced by MdlgAskQuestion
//! @return 0 = "No", 1 = "Yes", -1 = "Cancel".
DEPRECATED int MdlgAskYesNoCancel (
   MDLGPARENT parent,                     //!< Parent for dialog, NULL for default
   const char *msgname,                   //!< Message name for lookup in "popupync" group
   int dft,                               //!< Default response
   HELPID helpid = HELPID__None           //!< Help ID if help provided
   );
#endif
#endif

//! Retrieve default parent for creating dialog.
//! @return Default parent for creating dialog.
//! This function should be used by the individual Mdlg... function itself, not by the caller.
//!   If the default parent is desired, pass NULL as the parent for any Mdlg function.
MDLGPARENT MdlgGetDefaultParent (void);

#if defined(X_NATIVE) || defined(WIN32_MFC)
//! Dialog for general file maintenance.
int MdlgMaintGeneralFile (
   MDLGPARENT dlgparent,               //!< Parent for dialog
   bool mainproc                       //!< Treat as "main process (show "Exit" instead of "Close" button)
   );
#endif


//! Arrange to intercept all messages.
//!
//! This is to be used by non-interactive applications such as the automated
//! test suite which don't work very well if they sit all night waiting for
//! somebody to click OK on an error dialog.  It allows you to register a 
//! function that will get called instead of popping up the error dialog.
void MdlgSetMessageHookFunc (
   MESSAGEHOOKFUNC HookFunc,
   void* cbdata
   );

//! Display message window with specified text.
//! @return EUserCancel or 0.
int MdlgShowMessage (
   MDLGPARENT parent,                                 //!< Parent for dialog, NULL for default
   MDLG_MESSAGETYPE msgtype,                          //!< Message type
   const MISTRING& msgtext,                           //!< Message string, multiple lines allowed, TEXTID implied.
   MDLG_MESSAGEFLAGS flags = MDLG_MESSAGEFLAG_None,   //!< Flags
   HELPID helpid = HELPID__None,                      //!< Help ID (HELPID__None for no 'help' button)
   const char *inibasetag = 0,                        //!< Ini base tag for savable settings (eg. MDLG_MESSAGEFLAG_AllowNoShowAgain)
   const UNICODE *details = 0                         //!< Optional message "details"
   );

#if !defined(DEPRECATE_GROUPKEY) && !defined(DEPRECATE_OLDHELP)
//! Show dialog displaying a message using message file (DEPRECATED)
//!
//! \deprecated Replaced by version using MISTRING and HELPID.
//!
//! @return EUserCancel or 0.
//!
//! If the MDLG_MESSAGEFLAG_AllowNoShowAgain flag is set, an entry in the ini file in the "popupmsg"
//!   section based on the group/key will be checked to determine if the user has previously
//!   requested that this dialog not be shown.  If set, the dialog will not be displayed and
//!   a value of 0 will be returned.
DEPRECATED int MdlgShowMessage (
   MDLGPARENT parent,                              //!< Parent for dialog, NULL for default
   MDLG_MESSAGETYPE msgtype,                       //!< Message type
   const char *group,                              //!< Message database group, eg: "tntdisp"
   const char *key,                                //!< Message database key, eg: "SelectRaster"
   const char *help = NULL,                        //!< Help code (NULL for no help button)
   MDLG_MESSAGEFLAGS flags = MDLG_MESSAGEFLAG_None //!< Flags
   );
#endif

//! Display message dialog with text for specified error code.
//!
//! @return If AllowCancel flag specified will return 0 or EUserCancel, otherwise the error code is returned.
int MdlgShowMessageCode (
   MDLGPARENT parent,                  //!< Parent for dialog, NULL for default
   int errcode,                        //!< Error code
   MDLG_MESSAGETYPE msgtype = MDLG_MESSAGETYPE_Default,     //!< Message type
   MDLG_MESSAGEFLAGS flags = MDLG_MESSAGEFLAG_AllowSaveText //!< Flags
   );


//! Display (modeless) dialog showing standard product information.
void MdlgShowProductInfo (
   MDLGPARENT dlgparent = 0
   );

//!@}

#ifdef WIN32
#pragma warning (default:4996)   // Restore warning about deprecated declaration
#endif

#endif   // INC_MI32_MDLG_H

---