hold_control() function

Hold the User Interface actions.

When the User Interface is held, users cannot interact with visual elements.
The application must call resume_control() so that users can interact again with the visual elements.

You can set a callback function (or the name of a function) in the callback parameter. Then, a "Cancel" button will be displayed so the user can cancel whatever is happening in the application. When pressed, the callback is invoked.

Parameters:

Name Type Description Default
state State

The current user state received in any callback.

 required
callback Optional[Union[str, Callable]]

The function to be called if the user chooses to cancel.
If empty or None, no cancel action is provided to the user.
The signature of this function is:

  • state (State): The user state;
  • id (str): the id of the button that triggered the callback. That will always be "UIBlocker" since it is created and managed internally;

If this parameter is None, no "Cancel" button is displayed.

 None
message Optional[str]

The message to show. The default value is the string "Work in Progress...".

 'Work in Progress...'