formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Progress Bar

# fz_fuim_prog_stage_set_cancel

Description

Set progress button state and title. The progress button is by default enabled with the "Cancel" (localized) as the title. button. This function can be used to change the enabled state of the button or to change its title.
Setting the state to FZ_FUIM_PROG_CANCEL_DISABLED disables the button and ability to cancel the task. Setting the state to FZ_FUIM_PROG_CANCEL_SELECTED indicates that to progress has been canceled by some specific action in the task.
Changing the title should be used with caution because the button will still act like a cancel button (responds to clicks and cancel key shortcuts). An acceptable reason to change the title is to use the string "Pause" to indicate that a task can be suspended and then resumed. To implement this, the task should enter a suspended state when fz_fuim_key_cancel indicates that the process has been canceled.

Plugin Prototype

fzrt_error_td fz_fuim_prog_stage_set_cancel(

fz_fuim_prog_cancel_enum * | state,
char * | title )

Parameters

state [Input, Optional]

new state for the cancel button

title [Input, Optional]

title for progress button (Cancel by default)

Returns

Error codes

Availability

5.0.0.0

See Also

, fz_fuim_prog_stage_get_cancel

Function Set

fz_fuim_fset

Defined in

fz_fuim_prog_api.h