#include <GUIListItem.h>

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 (void)

	CGUIListItem (const CGUIListItem &item)

	CGUIListItem (const std::string &strLabel)

virtual	~CGUIListItem (void)

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, bool bOnOff=false)

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 (CGUIListItemLayoutPtr layout)

CGUIListItemLayout *	GetLayout ()

void	SetFocusedLayout (CGUIListItemLayoutPtr 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. More...

Public Attributes
bool	m_bIsFolder
	is item a folder or a file More...

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

Protected Attributes
std::string	m_strLabel2

GUIIconOverlay	m_overlayIcon

CGUIListItemLayoutPtr	m_layout

CGUIListItemLayoutPtr	m_focusedLayout

bool	m_bSelected

unsigned int	m_currentItem

PropertyMap	m_mapProperties

Member Typedef Documentation

◆ ArtMap

typedef std::map<std::string, std::string> CGUIListItem::ArtMap

◆ PropertyMap

typedef std::map<std::string, CVariant, icompare> CGUIListItem::PropertyMap

protected

Constructor & Destructor Documentation

◆ CGUIListItem() [1/3]

CGUIListItem::CGUIListItem ( void )

◆ CGUIListItem() [2/3]

CGUIListItem::CGUIListItem ( const CGUIListItem & item )

◆ CGUIListItem() [3/3]

CGUIListItem::CGUIListItem ( const std::string & strLabel )

explicit

◆ ~CGUIListItem()

CGUIListItem::~CGUIListItem ( void )

virtual

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.

◆ Archive()

void CGUIListItem::Archive ( CArchive & ar )

◆ ClearArt()

void CGUIListItem::ClearArt ( )

clear art on an item

See also: SetArt

◆ ClearProperties()

void CGUIListItem::ClearProperties ( )

◆ ClearProperty()

void CGUIListItem::ClearProperty ( const std::string & strKey )

◆ Clone()

virtual CGUIListItem * CGUIListItem::Clone ( ) const

inlinevirtual

Reimplemented in CFileItem, and CGUIStaticItem.

◆ FreeIcons()

void CGUIListItem::FreeIcons ( )

◆ FreeMemory()

void CGUIListItem::FreeMemory ( bool immediately = false )

◆ GetArt() [1/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

◆ GetArt() [2/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.

◆ GetCurrentItem()

unsigned int CGUIListItem::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.

◆ GetFocusedLayout()

CGUIListItemLayout * CGUIListItem::GetFocusedLayout ( )

◆ GetLabel()

const std::string & CGUIListItem::GetLabel ( ) const

◆ GetLabel2()

const std::string & CGUIListItem::GetLabel2 ( ) const

◆ GetLayout()

CGUIListItemLayout * CGUIListItem::GetLayout ( )

◆ GetOverlayImage()

std::string CGUIListItem::GetOverlayImage ( ) const

◆ GetProperty()

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

◆ GetSortLabel()

const std::wstring & CGUIListItem::GetSortLabel ( ) const

◆ 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.

◆ HasOverlay()

bool CGUIListItem::HasOverlay ( ) const

◆ HasProperties()

bool CGUIListItem::HasProperties ( ) const

inline

◆ HasProperty()

bool CGUIListItem::HasProperty ( const std::string & strKey ) const

◆ IncrementProperty() [1/3]

void CGUIListItem::IncrementProperty	(	const std::string &	strKey,
		double	dVal
	)

◆ IncrementProperty() [2/3]

void CGUIListItem::IncrementProperty	(	const std::string &	strKey,
		int	nVal
	)

◆ IncrementProperty() [3/3]

void CGUIListItem::IncrementProperty	(	const std::string &	strKey,
		int64_t	nVal
	)

◆ IsFileItem()

virtual bool CGUIListItem::IsFileItem ( ) const

inlinevirtual

Reimplemented in CFileItem.

◆ IsSelected()

bool CGUIListItem::IsSelected ( ) const

◆ operator=()

CGUIListItem & CGUIListItem::operator= ( const CGUIListItem & item )

◆ Select()

void CGUIListItem::Select ( bool bOnOff )

◆ Serialize()

void CGUIListItem::Serialize ( CVariant & value )

◆ SetArt() [1/2]

void CGUIListItem::SetArt ( const ArtMap & art )

set artwork for an item

Parameters

art	a type:url map for artwork

See also: GetArt

◆ SetArt() [2/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.

◆ 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.

◆ SetFocusedLayout()

void CGUIListItem::SetFocusedLayout ( CGUIListItemLayoutPtr layout )

◆ SetInvalid()

void CGUIListItem::SetInvalid ( )

◆ SetLabel()

void CGUIListItem::SetLabel ( const std::string & strLabel )

virtual

Reimplemented in CFileItem.

◆ SetLabel2()

void CGUIListItem::SetLabel2 ( const std::string & strLabel )

◆ SetLayout()

void CGUIListItem::SetLayout ( CGUIListItemLayoutPtr layout )

◆ SetOverlayImage()

void CGUIListItem::SetOverlayImage	(	GUIIconOverlay	icon,
		bool	bOnOff = `false`
	)

◆ SetProperty()

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

◆ SetSortLabel() [1/2]

void CGUIListItem::SetSortLabel ( const std::string & label )

◆ SetSortLabel() [2/2]

void CGUIListItem::SetSortLabel ( const std::wstring & label )

Member Data Documentation

◆ m_bIsFolder

bool CGUIListItem::m_bIsFolder

is item a folder or a file

◆ m_bSelected

bool CGUIListItem::m_bSelected

protected

◆ m_currentItem

unsigned int CGUIListItem::m_currentItem

protected

◆ m_focusedLayout

CGUIListItemLayoutPtr CGUIListItem::m_focusedLayout

protected

◆ m_layout

CGUIListItemLayoutPtr CGUIListItem::m_layout

protected

◆ m_mapProperties

PropertyMap CGUIListItem::m_mapProperties

protected

◆ m_overlayIcon

GUIIconOverlay CGUIListItem::m_overlayIcon

protected

◆ m_strLabel2

std::string CGUIListItem::m_strLabel2

protected

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

Classes

Public Types

Public Member Functions

Public Attributes

Protected Types

Protected Attributes

Member Typedef Documentation

◆ ArtMap

◆ PropertyMap

Constructor & Destructor Documentation

◆ CGUIListItem() [1/3]

◆ CGUIListItem() [2/3]

◆ CGUIListItem() [3/3]

◆ ~CGUIListItem()

Member Function Documentation

◆ AppendArt()

◆ AppendProperties()

◆ Archive()

◆ ClearArt()

◆ ClearProperties()

◆ ClearProperty()

◆ Clone()

◆ FreeIcons()

◆ FreeMemory()

◆ GetArt() [1/2]

◆ GetArt() [2/2]

◆ GetCurrentItem()

◆ GetFocusedLayout()

◆ GetLabel()

◆ GetLabel2()

◆ GetLayout()

◆ GetOverlayImage()

◆ GetProperty()

◆ GetSortLabel()

◆ HasArt()

◆ HasOverlay()

◆ HasProperties()

◆ HasProperty()

◆ IncrementProperty() [1/3]

◆ IncrementProperty() [2/3]

◆ IncrementProperty() [3/3]

◆ IsFileItem()

◆ IsSelected()

◆ operator=()

◆ Select()

◆ Serialize()

◆ SetArt() [1/2]

◆ SetArt() [2/2]

◆ SetArtFallback()

◆ SetCurrentItem()

◆ SetFocusedLayout()

◆ SetInvalid()

◆ SetLabel()

◆ SetLabel2()

◆ SetLayout()

◆ SetOverlayImage()

◆ SetProperty()

◆ SetSortLabel() [1/2]

◆ SetSortLabel() [2/2]

Member Data Documentation

◆ m_bIsFolder

◆ m_bSelected

◆ m_currentItem

◆ m_focusedLayout

◆ m_layout

◆ m_mapProperties

◆ m_overlayIcon

◆ m_strLabel2