CDirectoryJob Class Reference

Inheritance diagram for CDirectoryJob:

Public Member Functions
	CDirectoryJob (const std::string &url, SortDescription sort, int limit, int parentID)
	~CDirectoryJob () override=default
const char *	GetType () const override
	Function that returns the type of job. More...
bool	operator== (const CJob *job) const override
bool	DoWork () override
	Main workhorse function of CJob instances. More...
std::shared_ptr< CThumbLoader >	getThumbLoader (CGUIStaticItemPtr &item)
template<class CThumbLoaderClass >
void	initThumbLoader (InfoTagType type)
const std::vector< CGUIStaticItemPtr > &	GetItems () const
const std::string &	GetTarget () const
std::vector< InfoTagType >	GetItemTypes (std::vector< InfoTagType > &itemTypes) const
Public Member Functions inherited from CJob
	CJob ()
virtual	~CJob ()=default
	Destructor for job objects. More...
virtual bool	ShouldCancel (unsigned int progress, unsigned int total) const
	Function for longer jobs to report progress and check whether they have been cancelled. More...

Additional Inherited Members
Public Types inherited from CJob
enum	PRIORITY {   PRIORITY_LOW_PAUSABLE = 0 , PRIORITY_LOW , PRIORITY_NORMAL , PRIORITY_HIGH ,   PRIORITY_DEDICATED }
	Priority levels for jobs, specified by clients when adding jobs to the CJobManager. More...

Constructor & Destructor Documentation

CDirectoryJob()

CDirectoryJob::CDirectoryJob ( const std::string &  url, SortDescription  sort, int  limit, int  parentID  )

inline

~CDirectoryJob()

CDirectoryJob::~CDirectoryJob ( )

overridedefault

Member Function Documentation

DoWork()

bool CDirectoryJob::DoWork ( )

inlineoverridevirtual

Main workhorse function of CJob instances.

All CJob subclasses must implement this function, performing all processing. Once this function is complete, the OnJobComplete() callback is called, and the job is then destroyed.

See also

CJobManager, IJobCallback::OnJobComplete()

Implements CJob.

GetItems()

const std::vector< CGUIStaticItemPtr > & CDirectoryJob::GetItems ( ) const

inline

GetItemTypes()

std::vector< InfoTagType > CDirectoryJob::GetItemTypes ( std::vector< InfoTagType > &  itemTypes ) const

inline

GetTarget()

const std::string & CDirectoryJob::GetTarget ( ) const

inline

getThumbLoader()

std::shared_ptr< CThumbLoader > CDirectoryJob::getThumbLoader ( CGUIStaticItemPtr &  item )

inline

GetType()

const char * CDirectoryJob::GetType ( ) const

inlineoverridevirtual

Function that returns the type of job.

CJob subclasses may optionally implement this function to specify the type of job. This is useful for the CJobManager::AddLIFOJob() routine, which preempts similar jobs with the new job.

Returns

a unique character string describing the job.

See also

CJobManager

Reimplemented from CJob.

initThumbLoader()

template<class CThumbLoaderClass >

void CDirectoryJob::initThumbLoader ( InfoTagType  type )

inline

operator==()

bool CDirectoryJob::operator== ( const CJob *  job ) const

inlineoverridevirtual

Reimplemented from CJob.

---

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

• DirectoryProvider.cpp