![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
#include <DirectoryProvider.h>
Public Types | |
enum | UpdateState { OK , INVALIDATED , DONE } |
enum class | BrowseMode { NEVER , AUTO , ALWAYS } |
Public Member Functions | |
CDirectoryProvider (const TiXmlElement *element, int parentID) | |
CDirectoryProvider (const CDirectoryProvider &other) | |
~CDirectoryProvider () override | |
std::unique_ptr< IListProvider > | Clone () override |
Create an instance of the derived class. Allows for polymorphic copies. | |
bool | Update (bool forceRefresh) override |
Update the list content. | |
void | Announce (ANNOUNCEMENT::AnnouncementFlag flag, const std::string &sender, const std::string &message, const CVariant &data) override |
void | Fetch (std::vector< std::shared_ptr< CGUIListItem > > &items) override |
Fetch the current list of items. | |
void | Reset () override |
Reset the current list of items. Derived classes may choose to ignore this. | |
bool | OnClick (const std::shared_ptr< CGUIListItem > &item) override |
Click event on an item. | |
bool | OnPlay (const std::shared_ptr< CGUIListItem > &item) override |
Play event on an item. | |
bool | OnInfo (const std::shared_ptr< CGUIListItem > &item) override |
Open the info dialog for an item provided by this IListProvider. | |
bool | OnContextMenu (const std::shared_ptr< CGUIListItem > &item) override |
Open the context menu for an item provided by this IListProvider. | |
bool | IsUpdating () const override |
Check whether the list provider is updating content. | |
void | FreeResources (bool immediately) override |
Free all GUI resources allocated by the items. | |
void | OnJobComplete (unsigned int jobID, bool success, CJob *job) override |
The callback used when a job completes. | |
![]() | |
IListProvider (int parentID) | |
IListProvider (const IListProvider &other)=default | |
virtual | ~IListProvider ()=default |
virtual void | SetDefaultItem (int item, bool always) |
Set the default item to focus. For backwards compatibility. | |
virtual int | GetDefaultItem () const |
The default item to focus. | |
virtual bool | AlwaysFocusDefaultItem () const |
Whether to always focus the default item. | |
![]() | |
virtual | ~IJobCallback ()=default |
Destructor for job call back objects. | |
virtual void | OnJobAbort (unsigned int jobID, CJob *job) |
An optional callback function used when a job will be aborted. | |
virtual void | OnJobProgress (unsigned int jobID, unsigned int progress, unsigned int total, const CJob *job) |
An optional callback function that a job may call while processing. | |
![]() | |
IAnnouncer ()=default | |
virtual | ~IAnnouncer ()=default |
Additional Inherited Members | |
![]() | |
static std::unique_ptr< IListProvider > | Create (const TiXmlNode *parent, int parentID) |
Factory to create list providers. | |
static std::unique_ptr< IListProvider > | CreateSingle (const TiXmlNode *content, int parentID) |
Factory to create list providers. Cannot create a multi-provider. | |
![]() | |
int | m_parentID |
|
strong |
CDirectoryProvider::CDirectoryProvider | ( | const TiXmlElement * | element, |
int | parentID ) |
|
explicit |
|
override |
|
overridevirtual |
Implements ANNOUNCEMENT::IAnnouncer.
|
overridevirtual |
Create an instance of the derived class. Allows for polymorphic copies.
Implements IListProvider.
|
overridevirtual |
Fetch the current list of items.
items | [out] the list to be filled. |
Implements IListProvider.
Free all GUI resources allocated by the items.
immediately | true to free resources immediately, free resources async later otherwise. |
Reimplemented from IListProvider.
|
overridevirtual |
Check whether the list provider is updating content.
Reimplemented from IListProvider.
|
overridevirtual |
Click event on an item.
item | the item that was clicked. |
Implements IListProvider.
|
overridevirtual |
Open the context menu for an item provided by this IListProvider.
item | the item that was clicked. |
Implements IListProvider.
|
overridevirtual |
Open the info dialog for an item provided by this IListProvider.
item | the item that was clicked. |
Implements IListProvider.
|
overridevirtual |
The callback used when a job completes.
OnJobComplete is called at the completion of the job's DoWork() function, and is used to return information to the caller on the result of the job. On returning form this function the CJobManager will destroy this job.
jobID | the unique id of the job (as retrieved from CJobManager::AddJob) |
success | the result from the DoWork call |
job | the job that has been processed. The job will be destroyed after this function returns |
Implements IJobCallback.
|
overridevirtual |
Play event on an item.
item | the item to play. |
Reimplemented from IListProvider.
|
overridevirtual |
Reset the current list of items. Derived classes may choose to ignore this.
Reimplemented from IListProvider.
Update the list content.
Implements IListProvider.