Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Classes | Public Member Functions | List of all members
CFavouritesService Class Reference

#include <FavouritesService.h>

Classes

struct  FavouritesUpdated
 

Public Member Functions

 CFavouritesService (std::string userDataFolder)
 
virtual ~CFavouritesService ()=default
 
void ReInit (std::string userDataFolder)
 
bool IsFavourited (const CFileItem &item, int contextWindow) const
 
void GetAll (CFileItemList &items) const
 
std::string GetExecutePath (const CFileItem &item, int contextWindow) const
 
std::string GetExecutePath (const CFileItem &item, const std::string &contextWindow) const
 
bool AddOrRemove (const CFileItem &item, int contextWindow)
 
bool Save (const CFileItemList &items)
 
CEventStream< FavouritesUpdated > & Events ()
 

Constructor & Destructor Documentation

§ CFavouritesService()

CFavouritesService::CFavouritesService ( std::string  userDataFolder)
explicit

§ ~CFavouritesService()

virtual CFavouritesService::~CFavouritesService ( )
virtualdefault

Member Function Documentation

§ AddOrRemove()

bool CFavouritesService::AddOrRemove ( const CFileItem &  item,
int  contextWindow 
)

§ Events()

CEventStream<FavouritesUpdated>& CFavouritesService::Events ( )
inline

§ GetAll()

void CFavouritesService::GetAll ( CFileItemList &  items) const

§ GetExecutePath() [1/2]

std::string CFavouritesService::GetExecutePath ( const CFileItem &  item,
int  contextWindow 
) const

§ GetExecutePath() [2/2]

std::string CFavouritesService::GetExecutePath ( const CFileItem &  item,
const std::string &  contextWindow 
) const
Todo:
STRING_CLEANUP

§ IsFavourited()

bool CFavouritesService::IsFavourited ( const CFileItem &  item,
int  contextWindow 
) const

§ ReInit()

void CFavouritesService::ReInit ( std::string  userDataFolder)

For profiles

§ Save()

bool CFavouritesService::Save ( const CFileItemList &  items)
The documentation for this class was generated from the following files: