mi32/mdlg.h

Go to the documentation of this file.

#ifndef  INC_MI32_MDLG_H
#define  INC_MI32_MDLG_H

#ifndef  INC_MI32_MISTRING_H
   #include <mi32/mistring.h>
#endif

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

#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations
class ERRORSTATE;
class FILEPATH;
class FILEPATHLIST;
class GETSTRINGFILTER;
#endif   // GENERATING_DOXYGEN_OUTPUT


//-------------------------------------------------------------------------------------------------------------------
class GETFILEFILTER {
   public:

      GETFILEFILTER (
         ) { }

      virtual ~GETFILEFILTER (
         ) { }

      virtual bool OnSelection (
         const FILEPATH& path
         ) = 0;

      void SetFilterMsg (
         const char *msgkey
         );

      void SetFilterMsg (
         const MIUNICODE* 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) (MIUNICODE*, char*, void*);

//    Return values for MdlgGetFileFilterProto
#define  FILT_NotUsable             0  
#define  FILT_NotSelectable         FILT_NotUsable 
#define  FILT_Usable                1  
#define  FILT_Selectable            FILT_Usable
#define  FILT_FolderUsable          5  

enum GETFILEFLAGS {
   GETFILEFLAG_None =            0,
   GETFILEFLAG_NewOK =           0x00000001, 
   GETFILEFLAG_DftNew =          0x00000002, 
   GETFILEFLAG_SkipOK =          0x00000004, 
   GETFILEFLAG_OnlyNew =         0x00000008, 
   GETFILEFLAG_MakeNew =         0x00000010, 
   GETFILEFLAG_FilterByExtn =    0x00000400, 
   GETFILEFLAG_SkipNone =        0x00002000, 
   GETFILEFLAG_AllowFewer =      0x00004000, 
   GETFILEFLAG_AllowAutoName =   0x00008000, 
   GETFILEFLAG_SelectDir =       0x00020000, 
   GETFILEFLAG_AllowDefault =    0x00080000, 
   GETFILEFLAG_AllowAllFiles =   0x00100000, 
   GETFILEFLAG_SelectFileOrDir = 0x00200000, 
   };
#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(GETFILEFLAGS)
#endif


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


DEPRECATED int MdlgGetFile (
   MDLGPARENT dlgparent,
   FILEPATH& filename,                       
   const char *extns,                        
   const MISTRING& prompt,                   
   MdlgGetFileFilterProto filterfunc = 0,    
   void *funcdata = 0,                       
   GETFILEFLAGS flags = GETFILEFLAG_None
   );

DEPRECATED int MdlgGetFile (
   MDLGPARENT dlgparent,
   FILEPATH& filename,                       
   const MISTRING& extns,                    
   const MISTRING& prompt,                   
   MdlgGetFileFilterProto filterfunc = 0,    
   void *funcdata = 0,                       
   GETFILEFLAGS flags = GETFILEFLAG_None
   );

DEPRECATED int MdlgGetFiles (
   MDLGPARENT dlgparent,
   FILEPATH& filename,                       
   const char *extns,                        
   const MISTRING& prompt,
   int minfiles,                             
   int maxfiles,                             
   FILEPATHLIST& FileList,
   MdlgGetFileFilterProto filterfunc = 0,    
   void *funcdata = 0,                       
   GETFILEFLAGS flags = GETFILEFLAG_None,
   MdlgGetFilesValidMultiProto validfunc = 0
   );

#ifndef NODLLLINKAGE    // Can't default mistring to textid with nodlllinkage
ERRVALUE MdlgGetFileComponentName (
   MDLGPARENT parent,                        
   const MISTRING& title,                    
   const FILEPATH& ParentDirectory,          
   MISTRING& ComponentName,                  
   const MISTRING& Extension = TEXTID__None, 
   const MISTRING& label = TEXTID__None      
   );
#endif


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

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

enum GETFOLDERFLAGS {
   GETFOLDERFLAG_None =          0,
   GETFOLDERFLAG_AllowNew =      0x0001,     
   GETFOLDERFLAG_CheckWritable = 0x0002,     
   GETFOLDERFLAG_CheckEmpty =    0x0004,     
   };
#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(GETFOLDERFLAGS)
#endif



ERRVALUE MdlgGetFolder (
   MDLGPARENT dlgparent,                        
   FILEPATH& filepath,                          
   const MISTRING& promptstr,                   
   GETFOLDERFLAGS flags = GETFOLDERFLAG_None,   
   GETFOLDERFILTER *filter = 0                  
   );


//----------------------------------------------------------------------------
//    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, 
   MDLG_MESSAGEFLAG_AllowSaveText =    0x00000002, 
   MDLG_MESSAGEFLAG_CenterDialog =     0x00000004, 
   MDLG_MESSAGEFLAG_NoCancel =         0x00000100, 
   MDLG_MESSAGEFLAG_AllowCancel =      0x00000200, 
   MDLG_MESSAGEFLAG_NoOK =             0x00000400, 
   MDLG_MESSAGEFLAG_ContinueButton =   0x00800000, 
   MDLG_MESSAGEFLAG_RetryButton =      0x01000000, 
   MDLG_MESSAGEFLAG_TraceButton =      0x02000000, 
   };
#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(MDLG_MESSAGEFLAGS)
#endif

// Do not change the values of existing types as they may be passed to DLLs.
enum MDLG_MESSAGETYPE {
   MDLG_MESSAGETYPE_Default =       0,       
   MDLG_MESSAGETYPE_Information =   1,       
   MDLG_MESSAGETYPE_Warning =       2,       
   MDLG_MESSAGETYPE_Error =         3,       
   MDLG_MESSAGETYPE_Message =       4,       
   MDLG_MESSAGETYPE_Working =       5,       
   MDLG_MESSAGETYPE_Question =      6,       
   };


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

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

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

enum DLGQ_STYLE {
   DLGQ_BUTTON_Ok =           0x00000001,    
   DLGQ_BUTTON_Yes =          0x00000002,    
   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_YesToAll =     0x00000800,
   DLGQ_BUTTON_NoToAll =      0x00001000,

   DLGQ_BUTTON_Cancel =       0x00010000,

   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  
   };
#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(DLGQ_STYLE)
#endif

enum DLGRESPONSE {
   DLGRESPONSE_Cancel = -1000,            
   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,
   DLGRESPONSE_NoToAll = 8,
   DLGRESPONSE_YesToAll = 9
   };


ERRVALUE MdlgAskNumber (
   MDLGPARENT dlgparent,                  
   const MISTRING& prompt,                
   double& value,                         
   double minvalue,                       
   double maxvalue,                       
   int decplaces,                         
   HELPID helpid = HELPID__None           
   );

ERRVALUE MdlgAskNumber (
   MDLGPARENT dlgparent,                  
   const MISTRING& dlgtitle,              
   const MISTRING& prompt,                
   double& value,                         
   double minvalue,                       
   double maxvalue,                       
   int decplaces,                         
   HELPID helpid = HELPID__None           
   );

DLGRESPONSE MdlgAskQuestion (
   MDLGPARENT parent,                     
   const MISTRING& text,                  
   DLGQ_STYLE style,                      
   DLGRESPONSE dftresponse,               
   HELPID helpid = HELPID__None           
   );

DLGRESPONSE MdlgAskQuestion (
   MDLGPARENT parent,                     
   const MISTRING& dlgtitle,              
   const MISTRING& text,                  
   DLGQ_STYLE style,                      
   DLGRESPONSE dftresponse,               
   HELPID helpid = HELPID__None           
   );

ERRVALUE MdlgAskString (
   MDLGPARENT dlgparent,                  
   const MISTRING& prompt,                
   MISTRING& string,                      
   int maxchars = 0,                      
   HELPID helpid = HELPID__None,          
   GETSTRINGFILTER *filter = 0            
   );

ERRVALUE MdlgAskString (
   MDLGPARENT dlgparent,                  
   const MISTRING& dlgtitle,              
   const MISTRING& prompt,                
   MISTRING& string,                      
   int maxchars = 0,                      
   HELPID helpid = HELPID__None,          
   GETSTRINGFILTER *filter = 0            
   );

void MdlgExamineRawData (
   MDLGPARENT dlgparent,
   const void *buffer,
   int buffersize
   );

MDLGPARENT MdlgGetDefaultParent (void);

ERRVALUE MdlgSaveAsTextFile (
   MDLGPARENT dlgparent,               
   const MISTRING& string,             
   FILEPATH *pFilePath = 0             
   );

void MdlgSetMessageHookFunc (
   MESSAGEHOOKFUNC HookFunc,
   void* cbdata
   );

int MdlgShowErrorState (
   MDLGPARENT parent,                  
   const ERRORSTATE& ErrorState,                         
   MDLG_MESSAGEFLAGS flags = MDLG_MESSAGEFLAG_AllowSaveText 
   );

int MdlgShowMessage (
   MDLGPARENT parent,                                 
   MDLG_MESSAGETYPE msgtype,                          
   const MISTRING& msgtext,                           
   MDLG_MESSAGEFLAGS flags = MDLG_MESSAGEFLAG_None,   
   HELPID helpid = HELPID__None,                      
   const char *inibasetag = 0,                        
   const MIUNICODE *details = 0                          
   );

int MdlgShowMessageCode (
   MDLGPARENT parent,                  
   int errcode,                        
   MDLG_MESSAGETYPE msgtype = MDLG_MESSAGETYPE_Default,     
   MDLG_MESSAGEFLAGS flags = MDLG_MESSAGEFLAG_AllowSaveText 
   );

void MdlgShowProductInfo (
   MDLGPARENT dlgparent = 0
   );


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

#endif   // INC_MI32_MDLG_H

---