ListItem.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/list_item.h"
 
#ifdef __cplusplus
 
#include <memory>
 
namespace kodi
{
namespace gui
{
 
class CWindow;
 
class ATTRIBUTE_HIDDEN CAddonGUIControlBase
{
public:
  KODI_GUI_LISTITEM_HANDLE GetControlHandle() const { return m_controlHandle; }
 
protected:
  explicit CAddonGUIControlBase(CAddonGUIControlBase* window)
    : m_controlHandle(nullptr),
      m_interface(::kodi::addon::CAddonBase::m_interface->toKodi),
      m_Window(window)
  {
  }
 
  virtual ~CAddonGUIControlBase() = default;
 
  friend class CWindow;
 
  KODI_GUI_LISTITEM_HANDLE m_controlHandle;
  AddonToKodiFuncTable_Addon* m_interface;
  CAddonGUIControlBase* m_Window;
 
private:
  CAddonGUIControlBase() = delete;
  CAddonGUIControlBase(const CAddonGUIControlBase&) = delete;
  CAddonGUIControlBase& operator=(const CAddonGUIControlBase&) = delete;
};
 
class CListItem;
 
//==============================================================================
class ATTRIBUTE_HIDDEN CListItem : public CAddonGUIControlBase
{
public:
  //============================================================================
  CListItem(const std::string& label = "",
            const std::string& label2 = "",
            const std::string& path = "")
    : CAddonGUIControlBase(nullptr)
  {
    m_controlHandle = m_interface->kodi_gui->listItem->create(m_interface->kodiBase, label.c_str(),
                                                              label2.c_str(), path.c_str());
  }
 
  /*
   * Constructor used for parts given by list items from addon window
   *
   * Related to call of "std::shared_ptr<CListItem> kodi::gui::CWindow::GetListItem(int listPos)"
   * Not needed for addon development itself
   */
  explicit CListItem(KODI_GUI_LISTITEM_HANDLE listItemHandle) : CAddonGUIControlBase(nullptr)
  {
    m_controlHandle = listItemHandle;
  }
 
  //============================================================================
  ~CListItem() override
  {
    m_interface->kodi_gui->listItem->destroy(m_interface->kodiBase, m_controlHandle);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  std::string GetLabel()
  {
    std::string label;
    char* ret = m_interface->kodi_gui->listItem->get_label(m_interface->kodiBase, m_controlHandle);
    if (ret != nullptr)
    {
      if (std::strlen(ret))
        label = ret;
      m_interface->free_string(m_interface->kodiBase, ret);
    }
    return label;
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetLabel(const std::string& label)
  {
    m_interface->kodi_gui->listItem->set_label(m_interface->kodiBase, m_controlHandle,
                                               label.c_str());
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  std::string GetLabel2()
  {
    std::string label;
    char* ret = m_interface->kodi_gui->listItem->get_label2(m_interface->kodiBase, m_controlHandle);
    if (ret != nullptr)
    {
      if (std::strlen(ret))
        label = ret;
      m_interface->free_string(m_interface->kodiBase, ret);
    }
    return label;
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetLabel2(const std::string& label)
  {
    m_interface->kodi_gui->listItem->set_label2(m_interface->kodiBase, m_controlHandle,
                                                label.c_str());
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  std::string GetArt(const std::string& type)
  {
    std::string strReturn;
    char* ret = m_interface->kodi_gui->listItem->get_art(m_interface->kodiBase, m_controlHandle,
                                                         type.c_str());
    if (ret != nullptr)
    {
      if (std::strlen(ret))
        strReturn = ret;
      m_interface->free_string(m_interface->kodiBase, ret);
    }
    return strReturn;
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetArt(const std::string& type, const std::string& url)
  {
    m_interface->kodi_gui->listItem->set_art(m_interface->kodiBase, m_controlHandle, type.c_str(),
                                             url.c_str());
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  std::string GetPath()
  {
    std::string strReturn;
    char* ret = m_interface->kodi_gui->listItem->get_path(m_interface->kodiBase, m_controlHandle);
    if (ret != nullptr)
    {
      if (std::strlen(ret))
        strReturn = ret;
      m_interface->free_string(m_interface->kodiBase, ret);
    }
    return strReturn;
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetPath(const std::string& path)
  {
    m_interface->kodi_gui->listItem->set_path(m_interface->kodiBase, m_controlHandle, path.c_str());
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetProperty(const std::string& key, const std::string& value)
  {
    m_interface->kodi_gui->listItem->set_property(m_interface->kodiBase, m_controlHandle,
                                                  key.c_str(), value.c_str());
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  std::string GetProperty(const std::string& key)
  {
    std::string label;
    char* ret = m_interface->kodi_gui->listItem->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;
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void Select(bool selected)
  {
    m_interface->kodi_gui->listItem->select(m_interface->kodiBase, m_controlHandle, selected);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  bool IsSelected()
  {
    return m_interface->kodi_gui->listItem->is_selected(m_interface->kodiBase, m_controlHandle);
  }
  //----------------------------------------------------------------------------
};
 
} /* namespace gui */
} /* namespace kodi */
 
#endif /* __cplusplus */