IListProvider Class Reference

An interface for providing lists to UI containers. More...

#include <IListProvider.h>

Inheritance diagram for IListProvider:

Collaboration diagram for IListProvider:

Public Member Functions
	IListProvider (int parentID)
	IListProvider (const IListProvider &other)=default
virtual std::unique_ptr< IListProvider >	Clone ()=0
	Create an instance of the derived class. Allows for polymorphic copies.
virtual bool	Update (bool forceRefresh)=0
	Update the list content. More...
virtual void	Fetch (std::vector< CGUIListItemPtr > &items)=0
	Fetch the current list of items. More...
virtual bool	IsUpdating () const
	Check whether the list provider is updating content. More...
virtual void	Reset ()
	Reset the current list of items. Derived classes may choose to ignore this.
virtual void	FreeResources (bool immediately)
	Free all GUI resources allocated by the items. More...
virtual bool	OnClick (const CGUIListItemPtr &item)=0
	Click event on an item. More...
virtual bool	OnPlay (const CGUIListItemPtr &item)
	Play event on an item. More...
virtual bool	OnInfo (const CGUIListItemPtr &item)=0
	Open the info dialog for an item provided by this IListProvider. More...
virtual bool	OnContextMenu (const CGUIListItemPtr &item)=0
	Open the context menu for an item provided by this IListProvider. More...
virtual void	SetDefaultItem (int item, bool always)
	Set the default item to focus. For backwards compatibility. More...
virtual int	GetDefaultItem () const
	The default item to focus. More...
virtual bool	AlwaysFocusDefaultItem () const
	Whether to always focus the default item. More...

Static Public Member Functions
static std::unique_ptr< IListProvider >	Create (const TiXmlNode *parent, int parentID)
	Factory to create list providers. More...
static std::unique_ptr< IListProvider >	CreateSingle (const TiXmlNode *content, int parentID)
	Factory to create list providers. Cannot create a multi-provider. More...

Protected Attributes
int	m_parentID

Detailed Description

An interface for providing lists to UI containers.

Member Function Documentation

AlwaysFocusDefaultItem()

virtual bool IListProvider::AlwaysFocusDefaultItem ( ) const

inlinevirtual

Whether to always focus the default item.

Returns

true if the default item should always be the one to receive focus.

See also

GetDefaultItem, SetDefaultItem

Reimplemented in CStaticListProvider.

Create()

std::unique_ptr< IListProvider > IListProvider::Create ( const TiXmlNode *  parent, int  parentID  )

static

Factory to create list providers.

Parameters

parent	a parent TiXmlNode for the container.
parentID	id of parent window for context.

Returns

the list provider, empty pointer if none.

CreateSingle()

std::unique_ptr< IListProvider > IListProvider::CreateSingle ( const TiXmlNode *  content, int  parentID  )

static

Factory to create list providers. Cannot create a multi-provider.

Parameters

content	the TiXmlNode for the content to create.
parentID	id of parent window for context.

Returns

the list provider, empty pointer if none.

Fetch()

virtual void IListProvider::Fetch ( std::vector< CGUIListItemPtr > &  items )

pure virtual

Fetch the current list of items.

Parameters

items

[out] the list to be filled.

Implemented in CDirectoryProvider, CMultiProvider, and CStaticListProvider.

FreeResources()

virtual void IListProvider::FreeResources ( bool  immediately )

inlinevirtual

Free all GUI resources allocated by the items.

Parameters

immediately

true to free resources immediately, free resources async later otherwise.

Reimplemented in CDirectoryProvider.

GetDefaultItem()

virtual int IListProvider::GetDefaultItem ( ) const

inlinevirtual

The default item to focus.

Returns

the item to focus by default. -1 for none.

See also

SetDefaultItem, AlwaysFocusDefaultItem

Reimplemented in CStaticListProvider.

IsUpdating()

virtual bool IListProvider::IsUpdating ( ) const

inlinevirtual

Check whether the list provider is updating content.

Returns

true if in the processing of updating, false otherwise.

Reimplemented in CDirectoryProvider, and CMultiProvider.

OnClick()

virtual bool IListProvider::OnClick ( const CGUIListItemPtr &  item )

pure virtual

Click event on an item.

Parameters

item	the item that was clicked.

Returns

true if the click was handled, false otherwise.

Implemented in CDirectoryProvider, CMultiProvider, and CStaticListProvider.

OnContextMenu()

virtual bool IListProvider::OnContextMenu ( const CGUIListItemPtr &  item )

pure virtual

Open the context menu for an item provided by this IListProvider.

Parameters

item	the item that was clicked.

Returns

true if the click was handled, false otherwise.

Implemented in CDirectoryProvider, CMultiProvider, and CStaticListProvider.

OnInfo()

virtual bool IListProvider::OnInfo ( const CGUIListItemPtr &  item )

pure virtual

Open the info dialog for an item provided by this IListProvider.

Parameters

item	the item that was clicked.

Returns

true if the dialog was shown, false otherwise.

Implemented in CDirectoryProvider, CMultiProvider, and CStaticListProvider.

OnPlay()

virtual bool IListProvider::OnPlay ( const CGUIListItemPtr &  item )

inlinevirtual

Play event on an item.

Parameters

item	the item to play.

Returns

true if the event was handled, false otherwise.

Reimplemented in CDirectoryProvider.

SetDefaultItem()

virtual void IListProvider::SetDefaultItem ( int  item, bool  always  )

inlinevirtual

Set the default item to focus. For backwards compatibility.

Parameters

item	the item to focus.
always	whether this item should always be used on first focus.

See also

GetDefaultItem, AlwaysFocusDefaultItem

Reimplemented in CStaticListProvider.

Update()

virtual bool IListProvider::Update ( bool  forceRefresh )

pure virtual

Update the list content.

Returns

true if the content has changed, false otherwise.

Implemented in CDirectoryProvider, CMultiProvider, and CStaticListProvider.

---

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

• xbmc/listproviders/IListProvider.h
• xbmc/listproviders/IListProvider.cpp