Window.h

/*
 *  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 "../AddonBase.h"
#include "../c-api/gui/window.h"
#include "ListItem.h"
#include "input/ActionIDs.h"
 
#ifdef __cplusplus
 
namespace kodi
{
namespace gui
{
 
//==============================================================================
 
//==============================================================================
using ClientHandle = KODI_GUI_CLIENT_HANDLE;
//------------------------------------------------------------------------------
 
class CListItem;
 
//==============================================================================
class ATTR_DLL_LOCAL CWindow : public CAddonGUIControlBase
{
public:
  //============================================================================
  CWindow(const std::string& xmlFilename,
          const std::string& defaultSkin,
          bool asDialog,
          bool isMedia = false)
    : CAddonGUIControlBase(nullptr)
  {
    m_controlHandle = m_interface->kodi_gui->window->create(
        m_interface->kodiBase, xmlFilename.c_str(), defaultSkin.c_str(), asDialog, isMedia);
    if (!m_controlHandle)
      kodi::Log(ADDON_LOG_FATAL, "kodi::gui::CWindow can't create window class from Kodi !!!");
    m_interface->kodi_gui->window->set_callbacks(m_interface->kodiBase, m_controlHandle, this,
                                                 CBOnInit, CBOnFocus, CBOnClick, CBOnAction,
                                                 CBGetContextButtons, CBOnContextButton);
  }
  CWindow(const std::string& xmlFilename, {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  ~CWindow() override
  {
    if (m_controlHandle)
      m_interface->kodi_gui->window->destroy(m_interface->kodiBase, m_controlHandle);
  }
  ~CWindow() override {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  bool Show()
  {
    return m_interface->kodi_gui->window->show(m_interface->kodiBase, m_controlHandle);
  }
  bool Show() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void Close() { m_interface->kodi_gui->window->close(m_interface->kodiBase, m_controlHandle); }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void DoModal()
  {
    m_interface->kodi_gui->window->do_modal(m_interface->kodiBase, m_controlHandle);
  }
  void DoModal() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  bool SetFocusId(int controlId)
  {
    return m_interface->kodi_gui->window->set_focus_id(m_interface->kodiBase, m_controlHandle,
                                                       controlId);
  }
  bool SetFocusId(int controlId) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  int GetFocusId()
  {
    return m_interface->kodi_gui->window->get_focus_id(m_interface->kodiBase, m_controlHandle);
  }
  int GetFocusId() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetControlLabel(int controlId, const std::string& label)
  {
    m_interface->kodi_gui->window->set_control_label(m_interface->kodiBase, m_controlHandle,
                                                     controlId, label.c_str());
  }
  void SetControlLabel(int controlId, const std::string& label) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetControlVisible(int controlId, bool visible)
  {
    m_interface->kodi_gui->window->set_control_visible(m_interface->kodiBase, m_controlHandle,
                                                       controlId, visible);
  }
  void SetControlVisible(int controlId, bool visible) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetControlSelected(int controlId, bool selected)
  {
    m_interface->kodi_gui->window->set_control_selected(m_interface->kodiBase, m_controlHandle,
                                                        controlId, selected);
  }
  void SetControlSelected(int controlId, bool selected) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetProperty(const std::string& key, const std::string& value)
  {
    m_interface->kodi_gui->window->set_property(m_interface->kodiBase, m_controlHandle, key.c_str(),
                                                value.c_str());
  }
  void SetProperty(const std::string& key, const std::string& value) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  std::string GetProperty(const std::string& key) const
  {
    std::string label;
    char* ret = m_interface->kodi_gui->window->get_property(m_interface->kodiBase, m_controlHandle,
                                                            key.c_str());
    if (ret != nullptr)
    {
      if (std::strlen(ret))
        label = ret;
      m_interface->free_string(m_interface->kodiBase, ret);
    }
    return label;
  }
  std::string GetProperty(const std::string& key) const {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetPropertyInt(const std::string& key, int value)
  {
    m_interface->kodi_gui->window->set_property_int(m_interface->kodiBase, m_controlHandle,
                                                    key.c_str(), value);
  }
  void SetPropertyInt(const std::string& key, int value) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  int GetPropertyInt(const std::string& key) const
  {
    return m_interface->kodi_gui->window->get_property_int(m_interface->kodiBase, m_controlHandle,
                                                           key.c_str());
  }
  int GetPropertyInt(const std::string& key) const {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetPropertyBool(const std::string& key, bool value)
  {
    m_interface->kodi_gui->window->set_property_bool(m_interface->kodiBase, m_controlHandle,
                                                     key.c_str(), value);
  }
  void SetPropertyBool(const std::string& key, bool value) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  bool GetPropertyBool(const std::string& key) const
  {
    return m_interface->kodi_gui->window->get_property_bool(m_interface->kodiBase, m_controlHandle,
                                                            key.c_str());
  }
  bool GetPropertyBool(const std::string& key) const {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetPropertyDouble(const std::string& key, double value)
  {
    m_interface->kodi_gui->window->set_property_double(m_interface->kodiBase, m_controlHandle,
                                                       key.c_str(), value);
  }
  void SetPropertyDouble(const std::string& key, double value) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  double GetPropertyDouble(const std::string& key) const
  {
    return m_interface->kodi_gui->window->get_property_double(m_interface->kodiBase,
                                                              m_controlHandle, key.c_str());
  }
  double GetPropertyDouble(const std::string& key) const {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void ClearProperties()
  {
    m_interface->kodi_gui->window->clear_properties(m_interface->kodiBase, m_controlHandle);
  }
  void ClearProperties() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void ClearProperty(const std::string& key)
  {
    m_interface->kodi_gui->window->clear_property(m_interface->kodiBase, m_controlHandle,
                                                  key.c_str());
  }
  void ClearProperty(const std::string& key) {…}
  //----------------------------------------------------------------------------

  //============================================================================
  void ClearList()
  {
    m_interface->kodi_gui->window->clear_item_list(m_interface->kodiBase, m_controlHandle);
  }
  void ClearList() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void AddListItem(const std::shared_ptr<CListItem>& item, int itemPosition = -1)
  {
    m_interface->kodi_gui->window->add_list_item(m_interface->kodiBase, m_controlHandle,
                                                 item->m_controlHandle, itemPosition);
  }
  void AddListItem(const std::shared_ptr<CListItem>& item, int itemPosition = -1) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void AddListItem(const std::string& item, int itemPosition = -1)
  {
    m_interface->kodi_gui->window->add_list_item(
        m_interface->kodiBase, m_controlHandle,
        std::make_shared<kodi::gui::CListItem>(item)->m_controlHandle, itemPosition);
  }
  void AddListItem(const std::string& item, int itemPosition = -1) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void RemoveListItem(int itemPosition)
  {
    m_interface->kodi_gui->window->remove_list_item_from_position(m_interface->kodiBase,
                                                                  m_controlHandle, itemPosition);
  }
  void RemoveListItem(int itemPosition) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void RemoveListItem(const std::shared_ptr<CListItem>& item)
  {
    m_interface->kodi_gui->window->remove_list_item(m_interface->kodiBase, m_controlHandle,
                                                    item->m_controlHandle);
  }
  void RemoveListItem(const std::shared_ptr<CListItem>& item) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  std::shared_ptr<CListItem> GetListItem(int listPos)
  {
    KODI_GUI_LISTITEM_HANDLE handle = m_interface->kodi_gui->window->get_list_item(
        m_interface->kodiBase, m_controlHandle, listPos);
    if (!handle)
      return std::shared_ptr<CListItem>();
 
    return std::make_shared<kodi::gui::CListItem>(handle);
  }
  std::shared_ptr<CListItem> GetListItem(int listPos) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetCurrentListPosition(int listPos)
  {
    m_interface->kodi_gui->window->set_current_list_position(m_interface->kodiBase, m_controlHandle,
                                                             listPos);
  }
  void SetCurrentListPosition(int listPos) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  int GetCurrentListPosition()
  {
    return m_interface->kodi_gui->window->get_current_list_position(m_interface->kodiBase,
                                                                    m_controlHandle);
  }
  int GetCurrentListPosition() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  int GetListSize()
  {
    return m_interface->kodi_gui->window->get_list_size(m_interface->kodiBase, m_controlHandle);
  }
  int GetListSize() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetContainerProperty(const std::string& key, const std::string& value)
  {
    m_interface->kodi_gui->window->set_container_property(m_interface->kodiBase, m_controlHandle,
                                                          key.c_str(), value.c_str());
  }
  void SetContainerProperty(const std::string& key, const std::string& value) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetContainerContent(const std::string& value)
  {
    m_interface->kodi_gui->window->set_container_content(m_interface->kodiBase, m_controlHandle,
                                                         value.c_str());
  }
  void SetContainerContent(const std::string& value) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  int GetCurrentContainerId()
  {
    return m_interface->kodi_gui->window->get_current_container_id(m_interface->kodiBase,
                                                                   m_controlHandle);
  }
  int GetCurrentContainerId() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  void MarkDirtyRegion()
  {
    return m_interface->kodi_gui->window->mark_dirty_region(m_interface->kodiBase, m_controlHandle);
  }
  void MarkDirtyRegion() {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  //
 
  //============================================================================
  virtual bool OnInit() { return false; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual bool OnFocus(int controlId) { return false; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual bool OnClick(int controlId) { return false; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual bool OnAction(ADDON_ACTION actionId)
  {
    switch (actionId)
    {
      case ADDON_ACTION_PREVIOUS_MENU:
      case ADDON_ACTION_NAV_BACK:
        Close();
        return true;
      default:
        break;
    }
    return false;
  }
  virtual bool OnAction(ADDON_ACTION actionId) {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual void GetContextButtons(int itemNumber,
                                 std::vector<std::pair<unsigned int, std::string>>& buttons)
  {
  }
  virtual void GetContextButtons(int itemNumber, {…}
  //----------------------------------------------------------------------------
 
  //============================================================================
  virtual bool OnContextButton(int itemNumber, unsigned int button) { return false; }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetIndependentCallbacks(kodi::gui::ClientHandle cbhdl,
                               bool (*CBOnInit)(kodi::gui::ClientHandle cbhdl),
                               bool (*CBOnFocus)(kodi::gui::ClientHandle cbhdl, int controlId),
                               bool (*CBOnClick)(kodi::gui::ClientHandle cbhdl, int controlId),
                               bool (*CBOnAction)(kodi::gui::ClientHandle cbhdl,
                                                  ADDON_ACTION actionId),
                               void (*CBGetContextButtons)(kodi::gui::ClientHandle cbhdl,
                                                           int itemNumber,
                                                           gui_context_menu_pair* buttons,
                                                           unsigned int* size) = nullptr,
                               bool (*CBOnContextButton)(kodi::gui::ClientHandle cbhdl,
                                                         int itemNumber,
                                                         unsigned int button) = nullptr)
  {
    if (!cbhdl || !CBOnInit || !CBOnFocus || !CBOnClick || !CBOnAction)
    {
      kodi::Log(ADDON_LOG_FATAL, "kodi::gui::CWindow::%s called with nullptr !!!", __FUNCTION__);
      return;
    }
 
    m_interface->kodi_gui->window->set_callbacks(m_interface->kodiBase, m_controlHandle, cbhdl,
                                                 CBOnInit, CBOnFocus, CBOnClick, CBOnAction,
                                                 CBGetContextButtons, CBOnContextButton);
  }
  void SetIndependentCallbacks(kodi::gui::ClientHandle cbhdl, {…}
  //----------------------------------------------------------------------------
 
private:
  static bool CBOnInit(KODI_GUI_CLIENT_HANDLE cbhdl)
  {
    return static_cast<CWindow*>(cbhdl)->OnInit();
  }
 
  static bool CBOnFocus(KODI_GUI_CLIENT_HANDLE cbhdl, int controlId)
  {
    return static_cast<CWindow*>(cbhdl)->OnFocus(controlId);
  }
 
  static bool CBOnClick(KODI_GUI_CLIENT_HANDLE cbhdl, int controlId)
  {
    return static_cast<CWindow*>(cbhdl)->OnClick(controlId);
  }
 
  static bool CBOnAction(KODI_GUI_CLIENT_HANDLE cbhdl, ADDON_ACTION actionId)
  {
    return static_cast<CWindow*>(cbhdl)->OnAction(actionId);
  }
 
  static void CBGetContextButtons(KODI_GUI_CLIENT_HANDLE cbhdl,
                                  int itemNumber,
                                  gui_context_menu_pair* buttons,
                                  unsigned int* size)
  {
    std::vector<std::pair<unsigned int, std::string>> buttonList;
    static_cast<CWindow*>(cbhdl)->GetContextButtons(itemNumber, buttonList);
    if (!buttonList.empty())
    {
      unsigned int presentSize = static_cast<unsigned int>(buttonList.size());
      if (presentSize > *size)
        kodi::Log(ADDON_LOG_WARNING, "GetContextButtons: More as allowed '%i' entries present!",
                  *size);
      else
        *size = presentSize;
      for (unsigned int i = 0; i < *size; ++i)
      {
        buttons[i].id = buttonList[i].first;
        strncpy(buttons[i].name, buttonList[i].second.c_str(), ADDON_MAX_CONTEXT_ENTRY_NAME_LENGTH);
      }
    }
  }
 
  static bool CBOnContextButton(KODI_GUI_CLIENT_HANDLE cbhdl, int itemNumber, unsigned int button)
  {
    return static_cast<CWindow*>(cbhdl)->OnContextButton(itemNumber, button);
  }
};
class ATTR_DLL_LOCAL CWindow : public CAddonGUIControlBase {…};
 
} /* namespace gui */
} /* namespace kodi */
 
#endif /* __cplusplus */