diff options
Diffstat (limited to 'xbmc/addons/interfaces/gui/Window.h')
| -rw-r--r-- | xbmc/addons/interfaces/gui/Window.h | 278 |
1 files changed, 278 insertions, 0 deletions
diff --git a/xbmc/addons/interfaces/gui/Window.h b/xbmc/addons/interfaces/gui/Window.h new file mode 100644 index 0000000..dad0737 --- /dev/null +++ b/xbmc/addons/interfaces/gui/Window.h @@ -0,0 +1,278 @@ +/* + * Copyright (C) 2005-2018 Team Kodi + * This file is part of Kodi - https://kodi.tv + * + * SPDX-License-Identifier: GPL-2.0-or-later + * See LICENSES/README.md for more information. + */ + +#pragma once + +#include "addons/kodi-dev-kit/include/kodi/c-api/gui/window.h" +#include "threads/Event.h" +#include "windows/GUIMediaWindow.h" + +extern "C" +{ + + struct AddonGlobalInterface; + struct gui_context_menu_pair; + + namespace ADDON + { + class CAddonDll; + + /*! + * @brief 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" + */ + struct Interface_GUIWindow + { + static void Init(AddonGlobalInterface* addonInterface); + static void DeInit(AddonGlobalInterface* addonInterface); + + /*! + * @brief 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 */ + static KODI_GUI_WINDOW_HANDLE create(KODI_HANDLE kodiBase, + const char* xml_filename, + const char* default_skin, + bool as_dialog, + bool is_media); + 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); + + /* Window control functions */ + 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); + + /* Window property functions */ + 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); + + /* List item functions */ + 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); + + /* Various functions */ + static void mark_dirty_region(KODI_HANDLE kodiBase, KODI_GUI_WINDOW_HANDLE handle); + + /* GUI control access functions */ + 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); + //@} + + private: + static KODI_GUI_CONTROL_HANDLE GetControl(KODI_HANDLE kodiBase, + KODI_GUI_WINDOW_HANDLE handle, + int control_id, + const char* function, + CGUIControl::GUICONTROLTYPES type, + const std::string& typeName); + static int GetNextAvailableWindowId(); + }; + + class CGUIAddonWindow : public CGUIMediaWindow + { + friend struct Interface_GUIWindow; + + public: + CGUIAddonWindow(int id, const std::string& strXML, ADDON::CAddonDll* addon, bool isMedia); + ~CGUIAddonWindow() override = default; + + bool OnMessage(CGUIMessage& message) override; + bool OnAction(const CAction& action) override; + void AllocResources(bool forceLoad = false) override; + void Render() override; + bool IsMediaWindow() const override { return m_isMedia; } + + /* Addon to Kodi call functions */ + void PulseActionEvent(); + void AddItem(CFileItemPtr* fileItem, int itemPosition); + void RemoveItem(int itemPosition); + void RemoveItem(CFileItemPtr* fileItem); + void ClearList(); + CFileItemPtr* GetListItem(int position); + int GetListSize(); + int GetCurrentListPosition(); + void SetCurrentListPosition(int item); + void SetContainerProperty(const std::string& key, const std::string& value); + void SetContainerContent(const std::string& value); + int GetCurrentContainerControlId(); + CGUIControl* GetAddonControl(int controlId, + CGUIControl::GUICONTROLTYPES type, + const std::string& typeName); + + protected: + void GetContextButtons(int itemNumber, CContextButtons& buttons) override; + bool OnContextButton(int itemNumber, CONTEXT_BUTTON button) override; + void SetupShares() override; + + /* kodi to addon callback function addresses */ + KODI_GUI_CLIENT_HANDLE m_clientHandle; + bool (*CBOnInit)(KODI_GUI_CLIENT_HANDLE cbhdl); + bool (*CBOnFocus)(KODI_GUI_CLIENT_HANDLE cbhdl, int controlId); + bool (*CBOnClick)(KODI_GUI_CLIENT_HANDLE cbhdl, int controlId); + bool (*CBOnAction)(KODI_GUI_CLIENT_HANDLE cbhdl, ADDON_ACTION actionId); + void (*CBGetContextButtons)(KODI_GUI_CLIENT_HANDLE cbhdl, + int itemNumber, + gui_context_menu_pair* buttons, + unsigned int* size); + bool (*CBOnContextButton)(KODI_GUI_CLIENT_HANDLE cbhdl, int itemNumber, unsigned int button); + + const int m_windowId; + int m_oldWindowId; + + private: + void WaitForActionEvent(unsigned int timeout); + + CEvent m_actionEvent; + ADDON::CAddonDll* m_addon; + std::string m_mediaDir; + bool m_isMedia; + }; + + class CGUIAddonWindowDialog : public CGUIAddonWindow + { + public: + CGUIAddonWindowDialog(int id, const std::string& strXML, ADDON::CAddonDll* addon); + + bool IsDialogRunning() const override { return m_bRunning; } + bool IsDialog() const override { return true; } + bool IsModalDialog() const override { return true; } + + void Show(bool show = true, bool modal = true); + void Show_Internal(bool show = true); + + private: + bool m_bRunning; + }; + + } /* namespace ADDON */ +} /* extern "C" */ |