DialogProgressBG

Kodi's background progress dialog class More...

Classes
class	XBMCAddon::xbmcgui::DialogProgressBG

Functions
	XBMCAddon::xbmcgui::DialogProgressBG::create (...)
	XBMCAddon::xbmcgui::DialogProgressBG::update (...)
	XBMCAddon::xbmcgui::DialogProgressBG::close (...)
	XBMCAddon::xbmcgui::DialogProgressBG::isFinished (...)

Detailed Description

Kodi's background progress dialog class

Function Documentation

close()

void XBMCAddon::xbmcgui::DialogProgressBG::close

(

...

)

Function: xbmcgui.DialogProgressBG().close()

---

Close the background progress dialog

---

Example:

..
pDialog.close()
..

create()

void XBMCAddon::xbmcgui::DialogProgressBG::create

(

...

)

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

---

Create and show a background progress dialog.

Parameters

heading	string or unicode - dialog heading.
message	[opt] string or unicode - message text.

Note

'heading' is used for the dialog's id. Use a unique heading. Use update() to update heading, message and progressbar.

---

Example:

..
pDialog = xbmcgui.DialogProgressBG()
pDialog.create('Movie Trailers', 'Downloading Monsters Inc... .')
..

isFinished()

bool XBMCAddon::xbmcgui::DialogProgressBG::isFinished

(

...

)

Function: xbmcgui.DialogProgressBG().isFinished()

---

Checks progress is finished

Returns

True if the background dialog is active.

---

Example:

..
if (pDialog.isFinished()): return
..

update()

void XBMCAddon::xbmcgui::DialogProgressBG::update

(

...

)

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

---

Updates the background progress dialog.

Parameters

percent	[opt] integer - percent complete. (0:100)
heading	[opt] string or unicode - dialog heading.
message	[opt] string or unicode - message text.

Note

To clear heading or message, you must pass a blank character.

---

Example:

..
pDialog.update(25, message='Downloading Finding Nemo ...')
..