Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 
mi32

mdlg.h File Reference

<mi32/mdlg.h> Definitions for standard dialogs More...

#include <mi32/filepath.h>
#include <mi32/helpid.h>
#include <mi32/stddefns.h>

Include dependency graph for mdlg.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Classes

class  GETFILEFILTER
 Base class for filter used in file/folder selection dialogs. More...
class  GETFOLDERFILTER

Typedefs

typedef int(* MdlgGetFileFilterProto )(MIUNICODE *, char *, void *)
typedef int(* MdlgGetFilesValidMultiProto )(const FILEPATHLIST &list, void *, char *)
typedef int(* MESSAGEHOOKFUNC )(void *cbdata, MDLG_MESSAGETYPE msgtype, const MISTRING &msg, const MIUNICODE *details)

Enumerations

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_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
}
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
}
enum  GETFILEFLAGS {
  GETFILEFLAG_None = 0, GETFILEFLAG_NewOK = 0x00000001, GETFILEFLAG_DftNew = 0x00000002, GETFILEFLAG_SkipOK = 0x00000004,
  GETFILEFLAG_OnlyNew = 0x00000008, GETFILEFLAG_MakeNew = 0x00000010, GETFILEFLAG_NoDftExtn = 0x00000020, GETFILEFLAG_CanChgExtn = 0x00000040,
  GETFILEFLAG_AltDescFunc = 0x00000100, GETFILEFLAG_UseFilter = 0x00000200, GETFILEFLAG_FilterByExtn = 0x00000400, GETFILEFLAG_SortByExtn = 0x00000800,
  GETFILEFLAG_Unicode = 0x00001000, GETFILEFLAG_SkipNone = 0x00002000, GETFILEFLAG_AllowFewer = 0x00004000, GETFILEFLAG_AllowAutoName = 0x00008000,
  GETFILEFLAG_ExtnUnicode = 0x00010000, GETFILEFLAG_SelectDir = 0x00020000, GETFILEFLAG_AllowDefault = 0x00080000, GETFILEFLAG_AllowAllFiles = 0x00100000,
  GETFILEFLAG_SelectFileOrDir = 0x00200000
}
enum  GETFOLDERFLAGS { GETFOLDERFLAG_None = 0, GETFOLDERFLAG_AllowNew = 0x0001, GETFOLDERFLAG_CheckWritable = 0x0002, GETFOLDERFLAG_CheckEmpty = 0x0004 }
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_RetryButton = 0x01000000
}
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
}

Functions

 DEFINE_ENUM_OP_BITWISE (DLGQ_STYLE)
 DEFINE_ENUM_OPERATORS (MDLG_MESSAGEFLAGS)
 DEFINE_ENUM_OPERATORS (GETFOLDERFLAGS)
 DEFINE_ENUM_OPERATORS (GETFILEFLAGS)
ERRVALUE MdlgAskNumber (MDLGPARENT dlgparent, const MISTRING &dlgtitle, const MISTRING &prompt, double &value, double minvalue, double maxvalue, int decplaces, HELPID helpid=HELPID__None)
ERRVALUE MdlgAskNumber (MDLGPARENT dlgparent, const MISTRING &prompt, double &value, double minvalue, double maxvalue, int decplaces, HELPID helpid=HELPID__None)
DLGRESPONSE MdlgAskQuestion (MDLGPARENT parent, const MISTRING &dlgtitle, const MISTRING &text, DLGQ_STYLE style, DLGRESPONSE dftresponse, HELPID helpid=HELPID__None)
DLGRESPONSE MdlgAskQuestion (MDLGPARENT parent, const MISTRING &text, DLGQ_STYLE style, DLGRESPONSE dftresponse, HELPID helpid=HELPID__None)
ERRVALUE MdlgAskString (MDLGPARENT dlgparent, const MISTRING &dlgtitle, const MISTRING &prompt, MISTRING &string, int maxchars=0, HELPID helpid=HELPID__None, GETSTRINGFILTER *filter=0)
ERRVALUE MdlgAskString (MDLGPARENT dlgparent, const MISTRING &prompt, MISTRING &string, int maxchars=0, HELPID helpid=HELPID__None, GETSTRINGFILTER *filter=0)
DEPRECATED int MdlgAskYesNo (MDLGPARENT parent, const char *msgname, int dft, HELPID helpid=HELPID__None)
DEPRECATED DLGRESPONSE MdlgAskYesNo (MDLGPARENT parent, const MISTRING &text, DLGRESPONSE dftresponse, HELPID helpid=HELPID__None)
MDLGPARENT MdlgGetDefaultParent (void)
ERRVALUE MdlgGetFile (MDLGPARENT parent, FILEPATH &filepath, const char *ExtnFilters, const char *TitleKey, GETFILEFLAGS getfileflags, GETFILEFILTER *filter=0)
ERRVALUE MdlgGetFile (MDLGPARENT parent, FILEPATH &filepath, const char *ExtnFilters, const MIUNICODE *title, GETFILEFLAGS getfileflags, GETFILEFILTER *filter=0)
int MdlgGetFile (MDLGPARENT dlgparent, FILEPATH &filename, const char *extns, const void *prompt, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None, int(*createoptfunc)(Widget, void *)=0, void *createoptdata=0)
int MdlgGetFile (MDLGPARENT dlgparent, MIUNICODE *filename, const char *extns, const void *prompt, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None, int(*createoptfunc)(Widget, void *)=0, void *createoptdata=0)
int MdlgGetFileExtnUC (MDLGPARENT dlgparent, FILEPATH &filename, const MISTRING &extns, const void *prompt, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None, int(*createoptfunc)(Widget, void *)=0, void *createoptdata=0)
int MdlgGetFileExtnUC (MDLGPARENT dlgparent, MIUNICODE *filename, const MIUNICODE *extns, const void *prompt, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None, int(*createoptfunc)(Widget, void *)=0, void *createoptdata=0)
int MdlgGetFiles (Widget dlgparent, FILEPATH &filename, const char *extns, const void *prompt, int minfiles, int maxfiles, FILEPATHLIST &FileList, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None, MdlgGetFilesValidMultiProto validfunc=0, int(*createoptfunc)(Widget, void *)=0, void *createoptdata=0)
int MdlgGetFiles (Widget dlgparent, MIUNICODE *filename, const char *extns, const void *prompt, int minfiles, int maxfiles, FNAMEUC **fnameret, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None, MdlgGetFilesValidMultiProto validfunc=0, int(*createoptfunc)(Widget, void *)=0, void *createoptdata=0)
int MdlgGetFileSet (Widget dlgparent, MIUNICODE *filename, const char *extns, const void *prompt, int setnumfiles, FNAMEUC fname[], MIUNICODE **filelabel, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None, MdlgGetFilesValidMultiProto validfunc=0, int(*updatefunc)(FILEPATHLIST::ITERATOR, void *)=0, int(*createoptfunc)(Widget, void *)=0, void *createoptdata=0)
ERRVALUE MdlgGetFolder (MDLGPARENT dlgparent, FILEPATH &filepath, const MISTRING &promptstr, GETFOLDERFLAGS flags=GETFOLDERFLAG_None, GETFOLDERFILTER *filter=0)
ERRVALUE MdlgGetTextFile (MDLGPARENT dlgparent, FILEPATH &filepath, CHAR_ENCODING &encoding, ENCODELIST_FLAGS enclistflags, const char *extns, const void *prompt, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None)
int MdlgMaintGeneralFile (MDLGPARENT dlgparent, bool mainproc)
void MdlgSetMessageHookFunc (MESSAGEHOOKFUNC HookFunc, void *cbdata)
DEPRECATED int MdlgShowMessage (MDLGPARENT parent, MDLG_MESSAGETYPE msgtype, const char *group, const char *key, const char *help=NULL, MDLG_MESSAGEFLAGS flags=MDLG_MESSAGEFLAG_None)
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)

Detailed Description

<mi32/mdlg.h> Definitions for standard dialogs

Definition in file mdlg.h.

Typedef Documentation

typedef int(* MdlgGetFileFilterProto)(MIUNICODE *, char *, void *)
 

Definition at line 266 of file mdlg.h.

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

Definitions for MdlgGetFile...

Definition at line 265 of file mdlg.h.

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

Definition at line 538 of file mdlg.h.

Enumeration Type Documentation

enum DLGQ_STYLE
 

Styles for MdlgAskQuestion().

Enumeration values:
DLGQ_BUTTON_Ok  Cannot use with BUTTON_Yes.
DLGQ_BUTTON_Yes  Cannot use with BUTTON_Ok.
DLGQ_BUTTON_No 
DLGQ_BUTTON_Retry 
DLGQ_BUTTON_Save 
DLGQ_BUTTON_SaveAs 
DLGQ_BUTTON_SaveAll 
DLGQ_BUTTON_Discard 
DLGQ_BUTTON_DiscardAll 
DLGQ_BUTTON_Skip 
DLGQ_BUTTON_Continue 
DLGQ_BUTTON_Cancel 
DLGQ_BUTTONS_OkCancel  Common button combinations.
DLGQ_BUTTONS_YesNo 
DLGQ_BUTTONS_YesNoCancel 
DLGQ_BUTTONS_RetryCancel 
DLGQ_BUTTONS_SaveDiscardCancel 
DLGQ_BUTTONS_ContinueCancel 
DLGQ_STYLE_CenterText  Center text in the dialog.

Definition at line 544 of file mdlg.h.

enum DLGRESPONSE
 

Responses for MdlgAskQuestion().

Enumeration values:
DLGRESPONSE_Cancel  Same as EUserCancel.
DLGRESPONSE_No 
DLGRESPONSE_Ok 
DLGRESPONSE_Yes 
DLGRESPONSE_Continue 
DLGRESPONSE_Save 
DLGRESPONSE_SaveAs 
DLGRESPONSE_SaveAll 
DLGRESPONSE_Discard 
DLGRESPONSE_Skip 
DLGRESPONSE_DiscardAll 
DLGRESPONSE_Retry 

Definition at line 573 of file mdlg.h.

enum GETFILEFLAGS
 

Enumeration values:
GETFILEFLAG_None 
GETFILEFLAG_NewOK  Let user create new file.
GETFILEFLAG_DftNew  Default to new file if user presses OK.
GETFILEFLAG_SkipOK  Allow user to skip this selection.
GETFILEFLAG_OnlyNew  Don't let user select existing files.
GETFILEFLAG_MakeNew  Warn user if select existing file for overwrite.
GETFILEFLAG_NoDftExtn  XXX obsolete.
GETFILEFLAG_CanChgExtn  XXX obsolete.
GETFILEFLAG_AltDescFunc  Use alternate description function XXX implemented?
GETFILEFLAG_UseFilter  XXX obsolete.
GETFILEFLAG_FilterByExtn  Filter by extension.
GETFILEFLAG_SortByExtn  Sort files by extension, then name.
GETFILEFLAG_Unicode  Use Unicode prompt string directly instead of doing lookup.
GETFILEFLAG_SkipNone  Change "Skip" button to "None".
GETFILEFLAG_AllowFewer  Allow fewer than requested number of files for MdlgGetFileSet...().
GETFILEFLAG_AllowAutoName  Allow "auto-name" for MdlgGetFileSet...().
GETFILEFLAG_ExtnUnicode  XXX obsolete.
GETFILEFLAG_SelectDir  Select directory instead of file.
GETFILEFLAG_AllowDefault  Use provided filename for default new file.
GETFILEFLAG_AllowAllFiles  Allow all file types option.
GETFILEFLAG_SelectFileOrDir  Allow selection of files OR directories based on filter.

Definition at line 268 of file mdlg.h.

enum GETFOLDERFLAGS
 

Flags for MdlgGetFolder.

Enumeration values:
GETFOLDERFLAG_None 
GETFOLDERFLAG_AllowNew  Allow new folder to be created.
GETFOLDERFLAG_CheckWritable  Check if selected folder is writable.
GETFOLDERFLAG_CheckEmpty  Selected folder must be empty.

Definition at line 483 of file mdlg.h.

enum MDLG_MESSAGEFLAGS
 

Enumeration values:
MDLG_MESSAGEFLAG_None 
MDLG_MESSAGEFLAG_AllowNoShowAgain  Include "Don't show this message again" toggle.
MDLG_MESSAGEFLAG_AllowSaveText  Allow message text to be saved to file.
MDLG_MESSAGEFLAG_CenterDialog  Center dialog on screen.
MDLG_MESSAGEFLAG_NoCancel  Don't include "cancel" button if default is to show.
MDLG_MESSAGEFLAG_AllowCancel  Include cancel button if default is not to.
MDLG_MESSAGEFLAG_NoOK  Don't include "ok" button.
MDLG_MESSAGEFLAG_RetryButton  Use "Retry" instead of "OK".

Definition at line 511 of file mdlg.h.

enum MDLG_MESSAGETYPE
 

Message type, used to select icon and window title.

Enumeration values:
MDLG_MESSAGETYPE_Default  No icon.
MDLG_MESSAGETYPE_Information  'i' (information) icon
MDLG_MESSAGETYPE_Warning  Exclamation point icon.
MDLG_MESSAGETYPE_Error  circle/slash icon
MDLG_MESSAGETYPE_Message  No icon.
MDLG_MESSAGETYPE_Working  Hourglass icon.
MDLG_MESSAGETYPE_Question  Question mark icon.

Definition at line 525 of file mdlg.h.

Function Documentation

DEFINE_ENUM_OP_BITWISE (  DLGQ_STYLE   ) 
 

DEFINE_ENUM_OPERATORS (  MDLG_MESSAGEFLAGS   ) 
 

DEFINE_ENUM_OPERATORS (  GETFOLDERFLAGS   ) 
 

DEFINE_ENUM_OPERATORS (  GETFILEFLAGS   ) 
 

Generated on Wed May 31 15:27:40 2006 for TNTsdk by  doxygen 1.3.8-20040913