Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CPictureThumbLoader Class Reference

#include <PictureThumbLoader.h>

Inheritance diagram for CPictureThumbLoader:
CThumbLoader CJobQueue CBackgroundInfoLoader IJobCallback IRunnable

Public Member Functions

 CPictureThumbLoader ()
 
 ~CPictureThumbLoader () override
 
bool LoadItem (CFileItem *pItem) override
 
bool LoadItemCached (CFileItem *pItem) override
 
bool LoadItemLookup (CFileItem *pItem) override
 
void SetRegenerateThumbs (bool regenerate)
 
void OnJobComplete (unsigned int jobID, bool success, CJob *job) override
 Callback from CThumbExtractor on completion of a generated image. More...
 
- Public Member Functions inherited from CThumbLoader
 CThumbLoader ()
 
 ~CThumbLoader () override
 
void OnLoaderStart () override
 
void OnLoaderFinish () override
 
virtual bool FillLibraryArt (CFileItem &item)
 helper function to fill the art for a library item More...
 
virtual std::string GetCachedImage (const CFileItem &item, const std::string &type)
 Checks whether the given item has an image listed in the texture database. More...
 
virtual void SetCachedImage (const CFileItem &item, const std::string &type, const std::string &image)
 Associate an image with the given item in the texture database. More...
 
- Public Member Functions inherited from CBackgroundInfoLoader
 CBackgroundInfoLoader ()
 
 ~CBackgroundInfoLoader () override
 
void Load (CFileItemList &items)
 
bool IsLoading ()
 
void Run () override
 
void SetObserver (IBackgroundLoaderObserver *pObserver)
 
void SetProgressCallback (IProgressCallback *pCallback)
 
void StopThread ()
 
void StopAsync ()
 
- Public Member Functions inherited from IRunnable
virtual void Cancel ()
 
virtual ~IRunnable ()=default
 
- Public Member Functions inherited from CJobQueue
 CJobQueue (bool lifo=false, unsigned int jobsAtOnce=1, CJob::PRIORITY priority=CJob::PRIORITY_LOW)
 CJobQueue constructor. More...
 
 ~CJobQueue () override
 CJobQueue destructor Cancels any in-process jobs, and destroys the job queue. More...
 
bool AddJob (CJob *job)
 Add a job to the queue On completion of the job (or destruction of the job queue) the CJob object will be destroyed. More...
 
template<typename F >
void Submit (F &&f)
 Add a function f to this job queue. More...
 
void CancelJob (const CJob *job)
 Cancel a job in the queue Cancels a job in the queue. Any job currently being processed may complete after this call has completed, but OnJobComplete will not be performed. If the job is only queued then it will be removed from the queue and deleted. More...
 
void CancelJobs ()
 Cancel all jobs in the queue Removes all jobs from the queue. Any job currently being processed may complete after this call has completed, but OnJobComplete will not be performed. More...
 
bool IsProcessing () const
 Check whether the queue is processing a job. More...
 
void OnJobComplete (unsigned int jobID, bool success, CJob *job) override
 The callback used when a job completes. More...
 
- Public Member Functions inherited from IJobCallback
virtual ~IJobCallback ()=default
 Destructor for job call back objects. More...
 
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. More...
 

Static Public Member Functions

static void ProcessFoldersAndArchives (CFileItem *pItem)
 

Protected Member Functions

void OnLoaderFinish () override
 
- Protected Member Functions inherited from CJobQueue
bool QueueEmpty () const
 Returns if we still have jobs waiting to be processed NOTE: This function does not take into account the jobs that are currently processing. More...
 

Additional Inherited Members

- Protected Attributes inherited from CThumbLoader
CTextureDatabasem_textureDatabase
 
- Protected Attributes inherited from CBackgroundInfoLoader
CFileItemListm_pVecItems
 
std::vector< CFileItemPtrm_vecItems
 
CCriticalSection m_lock
 
volatile bool m_bIsLoading
 
volatile bool m_bStop
 
CThreadm_thread
 
IBackgroundLoaderObserverm_pObserver
 
IProgressCallbackm_pProgressCallback
 

Constructor & Destructor Documentation

◆ CPictureThumbLoader()

CPictureThumbLoader::CPictureThumbLoader ( )

◆ ~CPictureThumbLoader()

CPictureThumbLoader::~CPictureThumbLoader ( )
override

Member Function Documentation

◆ LoadItem()

bool CPictureThumbLoader::LoadItem ( CFileItem pItem)
overridevirtual

Reimplemented from CBackgroundInfoLoader.

◆ LoadItemCached()

bool CPictureThumbLoader::LoadItemCached ( CFileItem pItem)
overridevirtual

Reimplemented from CBackgroundInfoLoader.

◆ LoadItemLookup()

bool CPictureThumbLoader::LoadItemLookup ( CFileItem pItem)
overridevirtual

Reimplemented from CBackgroundInfoLoader.

◆ OnJobComplete()

void CPictureThumbLoader::OnJobComplete ( unsigned int  jobID,
bool  success,
CJob job 
)
overridevirtual

Callback from CThumbExtractor on completion of a generated image.

Performs the callbacks and updates the GUI.

See also
CImageLoader, IJobCallback

Implements IJobCallback.

◆ OnLoaderFinish()

void CPictureThumbLoader::OnLoaderFinish ( )
overrideprotectedvirtual

Reimplemented from CBackgroundInfoLoader.

◆ ProcessFoldersAndArchives()

void CPictureThumbLoader::ProcessFoldersAndArchives ( CFileItem pItem)
static

◆ SetRegenerateThumbs()

void CPictureThumbLoader::SetRegenerateThumbs ( bool  regenerate)
inline

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