Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.

Kodi's busy dialog class More...

Modules

 DialogProgressBG
 Kodi's background progress dialog class
 

Classes

class  XBMCAddon::xbmcgui::DialogBusy
 

Functions

 XBMCAddon::xbmcgui::DialogBusy::create (...)
 
 XBMCAddon::xbmcgui::DialogBusy::update (...)
 
 XBMCAddon::xbmcgui::DialogBusy::close (...)
 
 XBMCAddon::xbmcgui::DialogBusy::iscanceled (...)
 

Detailed Description

Kodi's busy dialog class


v18 Python API changes:
removed, usage results in nop!

Function Documentation

◆ close()

void XBMCAddon::xbmcgui::DialogBusy::close (   ...)

\htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> xbmcgui.DialogBusy().close() </big></font></span></code></h4> \endhtmlonly

Close the progress dialog.


v18 Python API changes:
removed, usage results in nop!

◆ create()

void XBMCAddon::xbmcgui::DialogBusy::create (   ...)

\htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> xbmcgui.DialogBusy().create() </big></font></span></code></h4> \endhtmlonly

Create and show a busy dialog.

Note
Use update() to update the progressbar.

v18 Python API changes:
removed, usage results in nop!

Example:

..
dialog = xbmcgui.DialogBusy()
dialog.create()
..

◆ iscanceled()

bool XBMCAddon::xbmcgui::DialogBusy::iscanceled (   ...)

\htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> xbmcgui.DialogBusy().iscanceled() </big></font></span></code></h4> \endhtmlonly

Checks if busy dialog is canceled.

Returns
True if the user pressed cancel.

v18 Python API changes:
removed, usage results in nop!

◆ update()

void XBMCAddon::xbmcgui::DialogBusy::update (   ...)

\htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> xbmcgui.DialogBusy().update(percent) </big></font></span></code></h4> \endhtmlonly

Updates the busy dialog.

Parameters
percentinteger - percent complete. (-1:100)
Note
If percent == -1 (default), the progressbar will be hidden.

v18 Python API changes:
removed, usage results in nop!