Module ui.widget.progressbardialog
A dialog that shows a progress bar with a title and subtitle.
Usage:
local progressbar_dialog = ProgressbarDialog:new {
title = nil,
subtitle = nil,
progress_max = nil
refresh_time_seconds = 3,
}
Note: provide at least one of title, subtitle or progress_max
Functions
| ProgressbarDialog:redrawProgressbarIfNeeded () | Updates the UI to show the current percentage of the progress bar when needed. |
| ProgressbarDialog:reportProgress (progress) | Used to notify about a progress update. |
| ProgressbarDialog:show () | Opens dialog. |
| ProgressbarDialog:close () | Closes dialog. |
Functions
- ProgressbarDialog:redrawProgressbarIfNeeded ()
- Updates the UI to show the current percentage of the progress bar when needed.
- ProgressbarDialog:reportProgress (progress)
-
Used to notify about a progress update.
Parameters:
- progress number the current progress (e.g. size of the file in bytes for file downloads)
- ProgressbarDialog:show ()
- Opens dialog.
- ProgressbarDialog:close ()
- Closes dialog.