Public Member Functions | Package Functions

# BinNavi.API.helpers.IProgressThread Interface Reference

Helper class for showing progress dialogs. More...

List of all members.

## Public Member Functions
void | run () throws Exception
| Executes a long operation.
## Package Functions
boolean | close ()
| Invoked to stop a progress thread.

## Detailed Description

Interface that must be implemented by all objects that want to execute long operations while a progress dialog is shown.

Please note that the implementing object does not actually have to be a thread.

## Member Function Documentation

boolean BinNavi.API.helpers.IProgressThread.close | ( |  | ) | `[package]`

This function is invoked every time the user clicks on the X button of the progress dialog. Plugins that use the progress dialog have the change to clean up allocated resources before the dialog is closed.

Returns:
  True, to signal that the progress thread can be terminated. False, if the progress dialog can not be cancelled.

void BinNavi.API.helpers.IProgressThread.run | ( |  | ) | throws Exception

Executes the long operation for which a progress dialog is shown.

Exceptions:

  | Exception | Exception thrown by the long-running operation.