GUIListItem.h

Go to the documentation of this file.

/*
 *  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 <map>
#include <memory>
#include <string>

//  Forward
class CGUIListItemLayout;
class CArchive;
class CVariant;

class CGUIListItem
{
public:
  typedef std::map<std::string, std::string> ArtMap;

  enum GUIIconOverlay { ICON_OVERLAY_NONE = 0,   
                        ICON_OVERLAY_RAR,        
                        ICON_OVERLAY_ZIP,        
                        ICON_OVERLAY_LOCKED,     
                        ICON_OVERLAY_UNWATCHED,  
                        ICON_OVERLAY_WATCHED,    
                        ICON_OVERLAY_HD          
                      };

  CGUIListItem(void);
  explicit CGUIListItem(const CGUIListItem& item);
  explicit CGUIListItem(const std::string& strLabel);
  virtual ~CGUIListItem(void);
  virtual CGUIListItem* Clone() const { return new CGUIListItem(*this); }

  CGUIListItem& operator =(const CGUIListItem& item);

  virtual void SetLabel(const std::string& strLabel);
  const std::string& GetLabel() const;

  void SetLabel2(const std::string& strLabel);
  const std::string& GetLabel2() const;

  void SetOverlayImage(GUIIconOverlay icon);
  std::string GetOverlayImage() const;

  void SetArt(const std::string &type, const std::string &url);

  void SetArt(const ArtMap &art);

  void AppendArt(const ArtMap &art, const std::string &prefix = "");

  void SetArtFallback(const std::string &from, const std::string &to);

  void ClearArt();

  std::string GetArt(const std::string &type) const;

  const ArtMap &GetArt() const;

  bool HasArt(const std::string &type) const;

  void SetSortLabel(const std::string &label);
  void SetSortLabel(const std::wstring &label);
  const std::wstring &GetSortLabel() const;

  void Select(bool bOnOff);
  bool IsSelected() const;

  bool HasOverlay() const;
  virtual bool IsFileItem() const { return false; }

  void SetLayout(std::unique_ptr<CGUIListItemLayout> layout);
  CGUIListItemLayout *GetLayout();

  void SetFocusedLayout(std::unique_ptr<CGUIListItemLayout> layout);
  CGUIListItemLayout *GetFocusedLayout();

  void FreeIcons();
  void FreeMemory(bool immediately = false);
  void SetInvalid();

  bool m_bIsFolder;     

  void SetProperty(const std::string &strKey, const CVariant &value);

  void IncrementProperty(const std::string &strKey, int nVal);
  void IncrementProperty(const std::string& strKey, int64_t nVal);
  void IncrementProperty(const std::string &strKey, double dVal);

  void ClearProperties();

  void AppendProperties(const CGUIListItem &item);

  void Archive(CArchive& ar);
  void Serialize(CVariant& value);

  bool       HasProperty(const std::string &strKey) const;
  bool HasProperties() const { return !m_mapProperties.empty(); }
  void       ClearProperty(const std::string &strKey);

  const CVariant &GetProperty(const std::string &strKey) const;

  void SetCurrentItem(unsigned int position);

  unsigned int GetCurrentItem() const;

protected:
  std::string m_strLabel2;     // text of column2
  GUIIconOverlay m_overlayIcon; // type of overlay icon

  std::unique_ptr<CGUIListItemLayout> m_layout;
  std::unique_ptr<CGUIListItemLayout> m_focusedLayout;
  bool m_bSelected;     // item is selected or not
  unsigned int m_currentItem; // current item number within container (starting at 1)

  struct icompare
  {
    bool operator()(const std::string &s1, const std::string &s2) const;
  };

  typedef std::map<std::string, CVariant, icompare> PropertyMap;
  PropertyMap m_mapProperties;
private:
  std::wstring m_sortLabel;    // text for sorting. Need to be UTF16 for proper sorting
  std::string m_strLabel;      // text of column1

  ArtMap m_art;
  ArtMap m_artFallbacks;
};