CASL Progress

Progress
Brings up a modal progress dialog

Download

brings up a modal progress dialog.
can be used to show the progress of a long time computing loop.
the user could stop that progress with a Cancel button.
the progress can be updated with additional information, for example with counters or percent of completion.
a bitmap could be shown additionally, if the bitmap resource id is known.
the autooff time is automatically switched off, as long as the dialog is displayed.

Functions definition

external "progress_manager";
#
#
# Starts a progress dialog
function prg_StartDialog (string Title, string BasicText, numeric BitmapID) as string;
# Title = title of the progress dialog
# BasicText = first part of the display test
# BitmapID = Resource ID of the bitmap, can be found with a resource editor in the compiled
# prc file; 0, if no bitmap is used
# Return value: Progress ID, used to identify the progress dialog

# Updates the text in the progress dialog and controls, whether a OK or a Cancel button is shown
function prg_UpdateDialog (string xID, numeric Error, string AddText);
# xID = Progress ID, is returned from prg_StartDialog
# Error = 0: Cancel button is shown in progress dialog
# = 1; OK button is shown in progress dialog
# Addtest = This text is added to the BasicText (= paraneter in prg_StartDialog)

# Closes a progress dialog
function prg_StopDialog (string xID, numeric Force);
# xID = Progress ID, is returned from prg_StartDialog
# Force = true: closes the dialog immediately
# = false: waits, until the user has confirmed

# checks, if the user has tapped the cancel button
function prg_UserCancel (string xID) as numeric;
# xID = Progress ID, is returned from prg_StartDialog

#
end_external;