Kodi Development  20.0
for Binary and Script based Add-Ons
DialogProgress

Detailed Description

Kodi's progress dialog class (Duh!)

Modules

 DialogProgressBG
 Kodi's background progress dialog class
 

Function Documentation

◆ create()

create (   ...)

Function: xbmcgui.DialogProgress().create(heading[, message])


Create and show a progress dialog.

Parameters
headingstring or unicode - dialog heading.
message[opt] string or unicode - message text.
Note
Use update() to update lines and progressbar.

v19 Python API changes:

Renamed option line1 to message.

Removed option line2.

Removed option line3.

Example:

..
pDialog = xbmcgui.DialogProgress()
pDialog.create('Kodi', 'Initializing script...')
..

◆ update()

update (   ...)

Function: xbmcgui.DialogProgress().update(percent[, message])


Updates the progress dialog.

Parameters
percentinteger - percent complete. (0:100)
message[opt] string or unicode - message text.

v19 Python API changes:

Renamed option line1 to message.

Removed option line2.

Removed option line3.

Example:

..
pDialog.update(25, 'Importing modules...')
..

◆ close()

close (   ...)

Function: xbmcgui.DialogProgress().close()


Close the progress dialog.


Example:

..
pDialog.close()
..

◆ iscanceled()

iscanceled (   ...)

Function: xbmcgui.DialogProgress().iscanceled()


Checks progress is canceled.

Returns
True if the user pressed cancel.

Example:

..
if (pDialog.iscanceled()): return
..