CGUIListItem Class Reference

Inheritance diagram for CGUIListItem:

Classes
struct	icompare

Public Types
enum	GUIIconOverlay {   ICON_OVERLAY_NONE = 0, ICON_OVERLAY_RAR, ICON_OVERLAY_ZIP, ICON_OVERLAY_LOCKED,   ICON_OVERLAY_UNWATCHED, ICON_OVERLAY_WATCHED, ICON_OVERLAY_HD }
typedef std::map< std::string, std::string >	ArtMap

Public Member Functions
	CGUIListItem (const CGUIListItem &item)
	CGUIListItem (const std::string &strLabel)
virtual CGUIListItem *	Clone () const
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)
	Set a particular art type for an item. More...
void	SetArt (const ArtMap &art)
	set artwork for an item More...
void	AppendArt (const ArtMap &art, const std::string &prefix="")
	append artwork to an item More...
void	SetArtFallback (const std::string &from, const std::string &to)
	set a fallback image for art More...
void	ClearArt ()
	clear art on an item More...
std::string	GetArt (const std::string &type) const
	Get a particular art type for an item. More...
const ArtMap &	GetArt () const
	get artwork for an item Retrieves artwork in a type:url map More...
bool	HasArt (const std::string &type) const
	Check whether an item has a particular piece of art Equivalent to !GetArt(type).empty() More...
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
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 ()
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)
	Append the properties of one CGUIListItem to another. Any existing properties in the current item will be overridden if they are set in the passed in item. More...
void	Archive (CArchive &ar)
void	Serialize (CVariant &value)
bool	HasProperty (const std::string &strKey) const
bool	HasProperties () const
void	ClearProperty (const std::string &strKey)
const CVariant &	GetProperty (const std::string &strKey) const
void	SetCurrentItem (unsigned int position)
	Set the current item number within it's container Our container classes will set this member with the items position in the container starting at 1. More...
unsigned int	GetCurrentItem () const
	Get the current item number within it's container Retrieve the items position in a container, this is useful to show for example numbering in front of entities in an arbitrary list of entities, like songs of a playlist.

Public Attributes
bool	m_bIsFolder
	is item a folder or a file

Protected Types
typedef std::map< std::string, CVariant, icompare >	PropertyMap

Protected Attributes
std::string	m_strLabel2
GUIIconOverlay	m_overlayIcon
std::unique_ptr< CGUIListItemLayout >	m_layout
std::unique_ptr< CGUIListItemLayout >	m_focusedLayout
bool	m_bSelected
unsigned int	m_currentItem
PropertyMap	m_mapProperties

Member Function Documentation

AppendArt()

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

append artwork to an item

Parameters

art	a type:url map for artwork
prefix	a prefix for the art, if applicable.

See also

GetArt

AppendProperties()

void CGUIListItem::AppendProperties

(

const CGUIListItem &

item

)

Append the properties of one CGUIListItem to another. Any existing properties in the current item will be overridden if they are set in the passed in item.

Parameters

item	the item containing the properties to append.

ClearArt()

void CGUIListItem::ClearArt

(

)

clear art on an item

See also

SetArt

GetArt() [1/2]

std::string CGUIListItem::GetArt

(

const std::string &

type

)

const

Get a particular art type for an item.

Parameters

type	type of art to fetch.

Returns

the art URL, if available, else empty.

GetArt() [2/2]

const CGUIListItem::ArtMap & CGUIListItem::GetArt

(

)

const

get artwork for an item Retrieves artwork in a type:url map

Returns

a type:url map for artwork

See also

SetArt

HasArt()

bool CGUIListItem::HasArt

(

const std::string &

type

)

const

Check whether an item has a particular piece of art Equivalent to !GetArt(type).empty()

Parameters

type	type of art to set.

Returns

true if the item has that art set, false otherwise.

SetArt() [1/2]

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

Set a particular art type for an item.

Parameters

type	type of art to set.
url	the url of the art.

SetArt() [2/2]

void CGUIListItem::SetArt

(

const ArtMap &

art

)

set artwork for an item

Parameters

art	a type:url map for artwork

See also

GetArt

SetArtFallback()

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

set a fallback image for art

Parameters

from	the type to fallback from
to	the type to fallback to

See also

SetArt

SetCurrentItem()

void CGUIListItem::SetCurrentItem

(

unsigned int

position

)

Set the current item number within it's container Our container classes will set this member with the items position in the container starting at 1.

Parameters

position

Position of the item in the container starting at 1.

---

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

• xbmc/guilib/GUIListItem.h
• xbmc/guilib/GUIListItem.cpp