formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Progress Bar
Description
Initialize progress bar. This function creates a progress bar used to indicate a time consuming task. The stages parameter
indicates how many tasks the progress bar will show. Each stage is started with a call to fz_fuim_prog_stage_init and
completed with a call to . The progress bar contains a graphic progress indicator which
indicates the progress of the task. If the progress bar contains a multiple stages (stages greater than 1), then there are two
graphic progress indicators shown. The top indicator indicates the overall progress of all stages and is evenly
segmented to represent each stage. The lower indicator indicates the progress of the current stage.
By default the progress bar is shown on the screen after 2 seconds of processing. This can be adjusted with the
fz_fuim_prog_set_delay function. The progress bar is updated during fz_fuim_curs_wait calls when the use_clock parameter is TRUE.
If use_clock is FALSE then the progress bar is only updated when is called. For the smoothest interface
and best performance, it is recommended that use_clock is set to TRUE and fz_fuim_curs_wait function is called during the execution
of the task.
The progress bar also contains a cancel button in the lower right corner. The function fz_fuim_key_cancel can be used to
determine if the user has clicked the cancel button or pressed a cancel key shortcut. The function
can be used to disable the cancel button or change the title of the button.
Plugin Prototype
fzrt_error_td fz_fuim_prog_init(
fzrt_int | stages, |
kind, | |
use_clock ) |
Parameters
stages [Input]
number of stages in progress bar
kind [Input]
kind of progress bar to display
use_clock [Input]
if TRUE, then progress bar is updated when fz_fuim_curs_wait() is called if FALSE, then progress bar is updated when is called
Returns
Error codes
Availability
5.0.0.0
See Also
fz_fuim_prog_finit, fz_fuim_prog_stage_init,, fz_fuim_prog_set_delay, fz_fuim_curs_wait,, fz_fuim_key_cancel
Function Set
Defined in