Skip to content

Commit

Permalink
Document Cancel Task command
Browse files Browse the repository at this point in the history
  • Loading branch information
furti committed Mar 19, 2019
1 parent 7ebdb79 commit 39df371
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,14 +185,21 @@ Displays all the Points the LithophaneImage contains in the 3D View. You have to

This command might be useful for debugging purposes to check if the pixel data was interpreted as you imagine.

### Cancel Task
![Cancel Task](./Resources/Icons/CancelTask.svg)

Cancels the current running operation. The operation will not be canceled immediately but after the current step is finished.

This is useful for cancelling long running tasks (e.g. you imported a way to big image).

</details>

## Progress Indicator

Commands that might take a while to recompute display a progress indicator in the bottom right corner of the FreeCAD window. So you can guess how long the command might take to finish.
![ProgressBar](./Resources/Documentation/progress_bar.png)

It is not possible to cancel a long running task right now. But it will be possible in the future(https://github.com/furti/FreeCAD-Lithophane/issues/31)
It is possible to cancel a long running task. See ```Cancel Task``` in the ```Command Details``` section.

## Image Viewer

Expand Down

0 comments on commit 39df371

Please sign in to comment.