Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
ADDON::Interface_GUIDialogProgress Struct Reference

Global gui Add-on to Kodi callback functions. More...

#include <Progress.h>

Static Public Member Functions

static void Init (AddonGlobalInterface *addonInterface)
 
static void DeInit (AddonGlobalInterface *addonInterface)
 
static KODI_GUI_HANDLE new_dialog (KODI_HANDLE kodiBase)
 callback functions from add-on to kodi
 
static void delete_dialog (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle)
 
static void open (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle)
 
static void set_heading (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle, const char *heading)
 
static void set_line (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle, unsigned int line, const char *text)
 
static void set_can_cancel (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle, bool canCancel)
 
static bool is_canceled (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle)
 
static void set_percentage (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle, int percentage)
 
static int get_percentage (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle)
 
static void show_progress_bar (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle, bool bOnOff)
 
static void set_progress_max (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle, int max)
 
static void set_progress_advance (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle, int nSteps)
 
static bool abort (KODI_HANDLE kodiBase, KODI_GUI_HANDLE handle)
 

Detailed Description

Global gui Add-on to Kodi callback functions.

To hold functions not related to a instance type and usable for every add-on type.

Related add-on header is "./xbmc/addons/kodi-dev-kit/include/kodi/gui/dialogs/Progress.h"

Member Function Documentation

◆ abort()

bool ADDON::Interface_GUIDialogProgress::abort ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle )
static

◆ DeInit()

void ADDON::Interface_GUIDialogProgress::DeInit ( AddonGlobalInterface * addonInterface)
static

◆ delete_dialog()

void ADDON::Interface_GUIDialogProgress::delete_dialog ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle )
static

◆ get_percentage()

int ADDON::Interface_GUIDialogProgress::get_percentage ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle )
static

◆ Init()

void ADDON::Interface_GUIDialogProgress::Init ( AddonGlobalInterface * addonInterface)
static

◆ is_canceled()

bool ADDON::Interface_GUIDialogProgress::is_canceled ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle )
static

◆ new_dialog()

KODI_GUI_HANDLE ADDON::Interface_GUIDialogProgress::new_dialog ( KODI_HANDLE kodiBase)
static

callback functions from add-on to kodi

Note
To add a new function use the "_" style to directly identify an add-on callback function. Everything with CamelCase is only to be used in Kodi.

The parameter kodiBase is used to become the pointer for a CAddonDll class.

◆ open()

void ADDON::Interface_GUIDialogProgress::open ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle )
static

◆ set_can_cancel()

void ADDON::Interface_GUIDialogProgress::set_can_cancel ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle,
bool canCancel )
static

◆ set_heading()

void ADDON::Interface_GUIDialogProgress::set_heading ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle,
const char * heading )
static

◆ set_line()

void ADDON::Interface_GUIDialogProgress::set_line ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle,
unsigned int line,
const char * text )
static

◆ set_percentage()

void ADDON::Interface_GUIDialogProgress::set_percentage ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle,
int percentage )
static

◆ set_progress_advance()

void ADDON::Interface_GUIDialogProgress::set_progress_advance ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle,
int nSteps )
static

◆ set_progress_max()

void ADDON::Interface_GUIDialogProgress::set_progress_max ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle,
int max )
static

◆ show_progress_bar()

void ADDON::Interface_GUIDialogProgress::show_progress_bar ( KODI_HANDLE kodiBase,
KODI_GUI_HANDLE handle,
bool bOnOff )
static

The documentation for this struct was generated from the following files: