Mdlg functions

Functions

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)
void MdlgExamineRawData (MDLGPARENT dlgparent, const void *buffer, int buffersize)
MDLGPARENT MdlgGetDefaultParent (void)
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 MdlgGetFile (MDLGPARENT dlgparent, FILEPATH &filename, const char *extns, const MISTRING &prompt, MdlgGetFileFilterProto filterfunc=0, void *funcdata=0, GETFILEFLAGS flags=GETFILEFLAG_None)
ERRVALUE MdlgGetFileComponentName (MDLGPARENT parent, const MISTRING &title, const FILEPATH &ParentDirectory, MISTRING &ComponentName, const MISTRING &Extension=TEXTID__None, const MISTRING &label=TEXTID__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)
ERRVALUE MdlgGetFolder (MDLGPARENT dlgparent, FILEPATH &filepath, const MISTRING &promptstr, GETFOLDERFLAGS flags=GETFOLDERFLAG_None, GETFOLDERFILTER *filter=0)
ERRVALUE MdlgSaveAsTextFile (MDLGPARENT dlgparent, const MISTRING &string, FILEPATH *pFilePath=0)
void MdlgSetMessageHookFunc (MESSAGEHOOKFUNC HookFunc, void *cbdata)
ERRVALUE MdlgShowErrorCode (MDLGPARENT parent, ERRVALUE errcode)
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)

Function Documentation

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

Dialog to ask user for numeric value (window title specified).

Parameters:
dlgparent Parent for dialog
dlgtitle Dialog title
prompt Prompt string
value Value passed/returned
minvalue Minimum allowed value
maxvalue Maximum allowed value
decplaces Number of decimal places to show
helpid Help ID if help provided
ERRVALUE MdlgAskNumber ( MDLGPARENT  dlgparent,
const MISTRING &  prompt,
double &  value,
double  minvalue,
double  maxvalue,
int  decplaces,
HELPID  helpid = HELPID__None 
)

Dialog to ask user for numeric value (default window title).

Parameters:
dlgparent Parent for dialog
prompt Prompt string
value Value passed/returned
minvalue Minimum allowed value
maxvalue Maximum allowed value
decplaces Number of decimal places to show
helpid Help ID if help provided
DLGRESPONSE MdlgAskQuestion ( MDLGPARENT  parent,
const MISTRING &  dlgtitle,
const MISTRING &  text,
DLGQ_STYLE  style,
DLGRESPONSE  dftresponse,
HELPID  helpid = HELPID__None 
)

Dialog to ask user question with buttons for responses (window title specified).

Returns:
DLGRESPONSE value
Parameters:
parent Parent for dialog, NULL for default
dlgtitle Title for dialog window
text Text to display
style Dialog style and buttons
dftresponse Default response (DLGRESPONSE_Yes or DLGRESPONSE_No)
helpid Help ID if help provided
DLGRESPONSE MdlgAskQuestion ( MDLGPARENT  parent,
const MISTRING &  text,
DLGQ_STYLE  style,
DLGRESPONSE  dftresponse,
HELPID  helpid = HELPID__None 
)

Dialog to ask user question with buttons for responses (default window title).

Returns:
DLGRESPONSE value
Parameters:
parent Parent for dialog, NULL for default
text Text to display
style Dialog style and buttons
dftresponse Default response (DLGRESPONSE_Yes or DLGRESPONSE_No)
helpid Help ID if help provided
ERRVALUE MdlgAskString ( MDLGPARENT  dlgparent,
const MISTRING &  dlgtitle,
const MISTRING &  prompt,
MISTRING &  string,
int  maxchars = 0,
HELPID  helpid = HELPID__None,
GETSTRINGFILTER *  filter = 0 
)

Dialog to ask user for string value (window title specified).

Parameters:
dlgparent Parent for dialog
dlgtitle Dialog title
prompt Prompt string
string String passed/returned
maxchars Maximum number of characters in string, 0 for no maximum
helpid Help ID if help provided
filter Optional filter for string validation
ERRVALUE MdlgAskString ( MDLGPARENT  dlgparent,
const MISTRING &  prompt,
MISTRING &  string,
int  maxchars = 0,
HELPID  helpid = HELPID__None,
GETSTRINGFILTER *  filter = 0 
)

Dialog to ask user for string value (default window title).

Parameters:
dlgparent Parent for dialog
prompt Prompt string
string String passed/returned
maxchars Maximum number of characters in string, 0 for no maximum
helpid Help ID if help provided
filter Optional filter for string validation
void MdlgExamineRawData ( MDLGPARENT  dlgparent,
const void *  buffer,
int  buffersize 
)

Modal dialog to allow user to examine raw memory buffer.

MDLGPARENT MdlgGetDefaultParent ( void   ) 

Retrieve default parent for creating dialog.

Returns:
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.
DEPRECATED int MdlgGetFile ( MDLGPARENT  dlgparent,
FILEPATH &  filename,
const MISTRING &  extns,
const MISTRING &  prompt,
MdlgGetFileFilterProto  filterfunc = 0,
void *  funcdata = 0,
GETFILEFLAGS  flags = GETFILEFLAG_None 
)

Dialog to select single file with MISTRING extension(s).

Parameters:
filename File path/name passed/returned
extns Extensions to show, if any
prompt Prompt
filterfunc Filter function
funcdata Data to pass to filter function
DEPRECATED int MdlgGetFile ( MDLGPARENT  dlgparent,
FILEPATH &  filename,
const char *  extns,
const MISTRING &  prompt,
MdlgGetFileFilterProto  filterfunc = 0,
void *  funcdata = 0,
GETFILEFLAGS  flags = GETFILEFLAG_None 
)

Dialog to select single file with char* extension(s).

Parameters:
filename File path/name passed/returned
extns Extensions to show, if any
prompt Prompt
filterfunc Filter function
funcdata Data to pass to filter function
ERRVALUE MdlgGetFileComponentName ( MDLGPARENT  parent,
const MISTRING &  title,
const FILEPATH &  ParentDirectory,
MISTRING &  ComponentName,
const MISTRING &  Extension = TEXTID__None,
const MISTRING &  label = TEXTID__None 
)

Prompt for a filepath component name for creation or renaming of a file.

Parameters:
parent Parent for dialog
title Dialog title
ParentDirectory Parent directory that 'ComponentName' will be created in
ComponentName File component name RETURNED
Extension Extension to add on if user did not add one
label Label to place in front of the name, TEXTID_Generic_Name_C is the default
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 
)

Dialog to select multiple files using char* extension list.

Parameters:
filename Default filename
extns Extensions to show, if any
minfiles Minimum number of files required
maxfiles Maximum allowed to be selected, 0 if no limit
filterfunc Filter function
funcdata Data to pass to filter function
ERRVALUE MdlgGetFolder ( MDLGPARENT  dlgparent,
FILEPATH &  filepath,
const MISTRING &  promptstr,
GETFOLDERFLAGS  flags = GETFOLDERFLAG_None,
GETFOLDERFILTER *  filter = 0 
)

Dialog to allow user to select folder.

Parameters:
dlgparent Parent for dialog
filepath Folder path passed/returned
promptstr Prompt string (also allows TEXTID)
flags Flags
filter Filter
ERRVALUE MdlgSaveAsTextFile ( MDLGPARENT  dlgparent,
const MISTRING &  string,
FILEPATH *  pFilePath = 0 
)

Dialog for file and save string in user-specified encoding.

Parameters:
dlgparent Parent for dialog
string String to save
pFilePath Optional filepath passed/returned
void MdlgSetMessageHookFunc ( MESSAGEHOOKFUNC  HookFunc,
void *  cbdata 
)

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.

ERRVALUE MdlgShowErrorCode ( MDLGPARENT  parent,
ERRVALUE  errcode 
)

Display error dialog with text for specified error code.

Returns:
error code or EUserCancel. Similar to MdlgShowMessageCode(parent,errcode,MDLG_MESSAGETYPE_Error) except that EUserCancel messages are not displayed.
Parameters:
parent Parent for dialog, NULL for default
errcode Error code
int MdlgShowErrorState ( MDLGPARENT  parent,
const ERRORSTATE &  ErrorState,
MDLG_MESSAGEFLAGS  flags = MDLG_MESSAGEFLAG_AllowSaveText 
)

Display message dialog with text for specified error state.

Returns:
If AllowCancel flag specified will return 0 or EUserCancel, otherwise the error code is returned.
Parameters:
parent Parent for dialog, NULL for default
ErrorState Error code
flags Flags
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 
)

Display message window with specified text.

Returns:
EUserCancel or 0.
Parameters:
parent Parent for dialog, NULL for default
msgtype Message type
msgtext Message string, multiple lines allowed, TEXTID implied.
flags Flags
helpid Help ID (HELPID__None for no 'help' button)
inibasetag Ini base tag for savable settings (eg. MDLG_MESSAGEFLAG_AllowNoShowAgain)
details Optional message "details"
int MdlgShowMessageCode ( MDLGPARENT  parent,
int  errcode,
MDLG_MESSAGETYPE  msgtype = MDLG_MESSAGETYPE_Default,
MDLG_MESSAGEFLAGS  flags = MDLG_MESSAGEFLAG_AllowSaveText 
)

Display message dialog with text for specified error code.

Returns:
If AllowCancel flag specified will return 0 or EUserCancel, otherwise the error code is returned.
Parameters:
parent Parent for dialog, NULL for default
errcode Error code
msgtype Message type
flags Flags
void MdlgShowProductInfo ( MDLGPARENT  dlgparent = 0  ) 

Display (modeless) dialog showing standard product information.

Generated on Sun Oct 7 21:33:03 2012 for TNTsdk 2012 by  doxygen 1.6.1