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

#include <Window.h>

Static Public Member Functions
static void	Init (AddonGlobalInterface *addonInterface)

static void	DeInit (AddonGlobalInterface *addonInterface)

static KODI_GUI_WINDOW_HANDLE	create (KODI_HANDLE kodiBase, const char xml_filename, const char default_skin, bool as_dialog, bool is_media)
	callback functions from add-on to kodi

static void	destroy (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static void	set_callbacks (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, KODI_GUI_CLIENT_HANDLE clienthandle, bool(CBInit)(KODI_GUI_CLIENT_HANDLE), bool(CBFocus)(KODI_GUI_CLIENT_HANDLE, int), bool(CBClick)(KODI_GUI_CLIENT_HANDLE, int), bool(CBOnAction)(KODI_GUI_CLIENT_HANDLE, ADDON_ACTION), void(CBGetContextButtons)(KODI_GUI_CLIENT_HANDLE, int, gui_context_menu_pair , unsigned int ), bool(CBOnContextButton)(KODI_GUI_CLIENT_HANDLE, int, unsigned int))

static bool	show (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static bool	close (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static bool	do_modal (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static bool	set_focus_id (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static int	get_focus_id (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static void	set_control_label (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id, const char *label)

static void	set_control_visible (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id, bool visible)

static void	set_control_selected (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id, bool selected)

static void	set_property (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char key, const char value)

static void	set_property_int (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key, int value)

static void	set_property_bool (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key, bool value)

static void	set_property_double (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key, double value)

static char *	get_property (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key)

static int	get_property_int (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key)

static bool	get_property_bool (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key)

static double	get_property_double (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key)

static void	clear_properties (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static void	clear_property (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *key)

static void	clear_item_list (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static void	add_list_item (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, KODI_GUI_LISTITEM_HANDLE item, int list_position)

static void	remove_list_item_from_position (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int list_position)

static void	remove_list_item (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, KODI_GUI_LISTITEM_HANDLE item)

static KODI_GUI_LISTITEM_HANDLE	get_list_item (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int list_position)

static void	set_current_list_position (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int list_position)

static int	get_current_list_position (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static int	get_list_size (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static void	set_container_property (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char key, const char value)

static void	set_container_content (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, const char *value)

static int	get_current_container_id (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static void	mark_dirty_region (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle)

static KODI_GUI_CONTROL_HANDLE	get_control_button (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_edit (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_fade_label (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_image (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_label (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_radio_button (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_progress (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_render_addon (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_settings_slider (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_slider (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_spin (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

static KODI_GUI_CONTROL_HANDLE	get_control_text_box (KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle, int control_id)

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/Window.h"

Member Function Documentation

◆ add_list_item()

void ADDON::Interface_GUIWindow::add_list_item	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		KODI_GUI_LISTITEM_HANDLE	item,
		int	list_position )

static

◆ clear_item_list()

void ADDON::Interface_GUIWindow::clear_item_list	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

List item functions

◆ clear_properties()

void ADDON::Interface_GUIWindow::clear_properties	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ clear_property()

void ADDON::Interface_GUIWindow::clear_property	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key )

static

◆ close()

bool ADDON::Interface_GUIWindow::close	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ create()

KODI_GUI_WINDOW_HANDLE ADDON::Interface_GUIWindow::create	(	KODI_HANDLE	kodiBase,
		const char *	xml_filename,
		const char *	default_skin,
		bool	as_dialog,
		bool	is_media )

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.

Window creation functions

◆ DeInit()

void ADDON::Interface_GUIWindow::DeInit ( AddonGlobalInterface * addonInterface )

static

◆ destroy()

void ADDON::Interface_GUIWindow::destroy	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ do_modal()

bool ADDON::Interface_GUIWindow::do_modal	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ get_control_button()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_button	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

GUI control access functions

◆ get_control_edit()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_edit	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_fade_label()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_fade_label	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_image()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_image	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_label()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_label	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_progress()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_progress	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_radio_button()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_radio_button	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_render_addon()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_render_addon	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_settings_slider()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_settings_slider	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_slider()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_slider	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_spin()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_spin	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_control_text_box()

KODI_GUI_CONTROL_HANDLE ADDON::Interface_GUIWindow::get_control_text_box	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

◆ get_current_container_id()

int ADDON::Interface_GUIWindow::get_current_container_id	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ get_current_list_position()

int ADDON::Interface_GUIWindow::get_current_list_position	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ get_focus_id()

int ADDON::Interface_GUIWindow::get_focus_id	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ get_list_item()

KODI_GUI_LISTITEM_HANDLE ADDON::Interface_GUIWindow::get_list_item	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	list_position )

static

◆ get_list_size()

int ADDON::Interface_GUIWindow::get_list_size	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

◆ get_property()

char * ADDON::Interface_GUIWindow::get_property	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key )

static

◆ get_property_bool()

bool ADDON::Interface_GUIWindow::get_property_bool	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key )

static

◆ get_property_double()

double ADDON::Interface_GUIWindow::get_property_double	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key )

static

◆ get_property_int()

int ADDON::Interface_GUIWindow::get_property_int	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key )

static

◆ Init()

void ADDON::Interface_GUIWindow::Init ( AddonGlobalInterface * addonInterface )

static

◆ mark_dirty_region()

void ADDON::Interface_GUIWindow::mark_dirty_region	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

Various functions

◆ remove_list_item()

void ADDON::Interface_GUIWindow::remove_list_item	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		KODI_GUI_LISTITEM_HANDLE	item )

static

◆ remove_list_item_from_position()

void ADDON::Interface_GUIWindow::remove_list_item_from_position	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	list_position )

static

◆ set_callbacks()

void ADDON::Interface_GUIWindow::set_callbacks	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		KODI_GUI_CLIENT_HANDLE	clienthandle,
		bool(*)(KODI_GUI_CLIENT_HANDLE)	CBInit,
		bool(*)(KODI_GUI_CLIENT_HANDLE, int)	CBFocus,
		bool(*)(KODI_GUI_CLIENT_HANDLE, int)	CBClick,
		bool(*)(KODI_GUI_CLIENT_HANDLE, ADDON_ACTION)	CBOnAction,
		void()(KODI_GUI_CLIENT_HANDLE, int, gui_context_menu_pair , unsigned int *)	CBGetContextButtons,
		bool(*)(KODI_GUI_CLIENT_HANDLE, int, unsigned int)	CBOnContextButton )

static

◆ set_container_content()

void ADDON::Interface_GUIWindow::set_container_content	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	value )

static

◆ set_container_property()

void ADDON::Interface_GUIWindow::set_container_property	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key,
		const char *	value )

static

◆ set_control_label()

void ADDON::Interface_GUIWindow::set_control_label	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id,
		const char *	label )

static

◆ set_control_selected()

void ADDON::Interface_GUIWindow::set_control_selected	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id,
		bool	selected )

static

◆ set_control_visible()

void ADDON::Interface_GUIWindow::set_control_visible	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id,
		bool	visible )

static

◆ set_current_list_position()

void ADDON::Interface_GUIWindow::set_current_list_position	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	list_position )

static

◆ set_focus_id()

bool ADDON::Interface_GUIWindow::set_focus_id	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		int	control_id )

static

Window control functions

◆ set_property()

void ADDON::Interface_GUIWindow::set_property	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key,
		const char *	value )

static

Window property functions

◆ set_property_bool()

void ADDON::Interface_GUIWindow::set_property_bool	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key,
		bool	value )

static

◆ set_property_double()

void ADDON::Interface_GUIWindow::set_property_double	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key,
		double	value )

static

◆ set_property_int()

void ADDON::Interface_GUIWindow::set_property_int	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle,
		const char *	key,
		int	value )

static

◆ show()

bool ADDON::Interface_GUIWindow::show	(	KODI_HANDLE	kodiBase,
		KODI_GUI_WINDOW_HANDLE	handle )

static

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ add_list_item()

◆ clear_item_list()

◆ clear_properties()

◆ clear_property()

◆ close()

◆ create()

◆ DeInit()

◆ destroy()

◆ do_modal()

◆ get_control_button()

◆ get_control_edit()

◆ get_control_fade_label()

◆ get_control_image()

◆ get_control_label()

◆ get_control_progress()

◆ get_control_radio_button()

◆ get_control_render_addon()

◆ get_control_settings_slider()

◆ get_control_slider()

◆ get_control_spin()

◆ get_control_text_box()

◆ get_current_container_id()

◆ get_current_list_position()

◆ get_focus_id()

◆ get_list_item()

◆ get_list_size()

◆ get_property()

◆ get_property_bool()

◆ get_property_double()

◆ get_property_int()

◆ Init()

◆ mark_dirty_region()

◆ remove_list_item()

◆ remove_list_item_from_position()

◆ set_callbacks()

◆ set_container_content()

◆ set_container_property()

◆ set_control_label()

◆ set_control_selected()

◆ set_control_visible()

◆ set_current_list_position()

◆ set_focus_id()

◆ set_property()

◆ set_property_bool()

◆ set_property_double()

◆ set_property_int()

◆ show()