formZ SDK | 5.0 API Reference | System | User Interface (FUIM)
Description
Updates the wait cursor. This function updates the wait cursor to indicate to the user that some
processing is occurring and they must wait for it to complete (or cancel it if available). It should be
called at strategic places in code that could take a fzrt_int time to execute to give feedback to the user that
the processing is occurring. This function has small overhead so it will not affect performance unless it is
placed in very tight loops.
The function should be called once with kind == FZ_FUIM_CURS_WAIT_START to indicate the start of a time
consuming task. During the processing of the task, it should be called with kind == FZ_FUIM_CURS_WAIT_TURN to
update the cursor. A final call at the end of the task with FZ_FUIM_CURS_WAIT_END switches the cursor back to
the normal cursor. This function supports nested calls so that only the first call with
kind == FZ_FUIM_CURS_WAIT_START changes the cursor to the wait cursor. Likewise only the last nested call with
kind == FZ_FUIM_CURS_WAIT_END changes the cursor to the normal cursor.
Plugin Prototype
void fz_fuim_curs_wait(
kind ) |
Parameters
kind [Input]
Update kind for the wait cursor
Availability
5.0.0.0
See Also
Function Set
Defined in