Kodi Documentation  19.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmcgui::ListItem Class Reference

#include <ListItem.h>

Inheritance diagram for XBMCAddon::xbmcgui::ListItem:
XBMCAddon::AddonClass CCriticalSection XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >

Public Member Functions

 ListItem (const String &label=emptyString, const String &label2=emptyString, const String &path=emptyString, bool offscreen=false)
 
 ~ListItem () override
 
 getLabel ()
 

Function: getLabel()


Returns the listitem label. More...
 
 getLabel2 ()
 

Function: getLabel2()


Returns the second listitem label. More...
 
 setLabel (...)
 

Function: setLabel(label)


Sets the listitem's label. More...
 
 setLabel2 (...)
 

Function: setLabel2(label)


Sets the listitem's label2. More...
 
 setArt (...)
 

Function: setArt(values)


Sets the listitem's art More...
 
 setIsFolder (...)
 

Function: setIsFolder(isFolder)


Sets if this listitem is a folder. More...
 
 setUniqueIDs (...)
 

Function: setUniqueIDs(values, defaultrating)


Sets the listitem's uniqueID More...
 
 setRating (...)
 

Function: setRating(type, rating, votes = 0, defaultt = False)


Sets a listitem's rating. It needs at least type and rating param More...
 
 addSeason (...)
 

Function: addSeason(number, name = "")


Add a season with name to a listitem. It needs at least the season number More...
 
 getArt (key)
 

Function: getArt(key)


Returns a listitem art path as a string, similar to an infolabel.
More...
 
 getUniqueID (key)
 

Function: getUniqueID(key)


Returns a listitem uniqueID as a string, similar to an infolabel.
More...
 
 getRating (key)
 

Function: getRating(key)


Returns a listitem rating as a float.
More...
 
 getVotes (key)
 

Function: getVotes(key)


Returns a listitem votes as a integer.
More...
 
 select (...)
 

Function: select(selected)


Sets the listitem's selected status. More...
 
 isSelected ()
 

Function: isSelected()


Returns the listitem's selected status. More...
 
 setInfo (...)
 

Function: setInfo(type, infoLabels)


Sets the listitem's infoLabels. More...
 
 setCast (...)
 

Function: setCast(actors)


Set cast including thumbnails More...
 
 setAvailableFanart (...)
 

Function: setAvailableFanart(images)


Set available images (needed for video scrapers) More...
 
 addAvailableArtwork (...)
 

Function: addAvailableArtwork(images)


Add an image to available artworks (needed for video scrapers) More...
 
 addStreamInfo (...)
 

Function: addStreamInfo(type, values)


Add a stream with details. More...
 
 addContextMenuItems (...)
 

Function: addContextMenuItems([(label, action),*])


Adds item(s) to the context menu for media lists. More...
 
 setProperty (...)
 

Function: setProperty(key, value)


Sets a listitem property, similar to an infolabel. More...
 
 setProperties (...)
 

Function: setProperties(values)


Sets multiple properties for listitem's More...
 
 getProperty (...)
 

Function: getProperty(key)


Returns a listitem property as a string, similar to an infolabel. More...
 
 setPath (...)
 

Function: setPath(path)


Sets the listitem's path. More...
 
 setMimeType (...)
 

Function: setMimeType(mimetype)


Sets the listitem's mimetype if known. More...
 
 setContentLookup (...)
 

Function: setContentLookup(enable)


Enable or disable content lookup for item. More...
 
 setSubtitles (...)
 

Function: setSubtitles(subtitleFiles)


Sets subtitles for this listitem. More...
 
 getPath ()
 

Function: getPath()


Returns the path of this listitem. More...
 
 getVideoInfoTag ()
 

Function: getVideoInfoTag()


Returns the VideoInfoTag for this item. More...
 
 getMusicInfoTag ()
 

Function: getMusicInfoTag()


Returns the MusicInfoTag for this item. More...
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Additional Inherited Members

- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 
- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

The documentation for this class was generated from the following files: