Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CSubtitlesJob Class Reference

simple job to retrieve a directory and store a string (language) More...

Inheritance diagram for CSubtitlesJob:
CJob

Public Member Functions

 CSubtitlesJob (const CURL &url, const std::string &language)
 
 ~CSubtitlesJob () override
 
bool DoWork () override
 Main workhorse function of CJob instances.
 
bool operator== (const CJob *job) const override
 
const CFileItemListGetItems () const
 
const CURLGetURL () const
 
const std::string & GetLanguage () const
 
- Public Member Functions inherited from CJob
 CJob ()
 
virtual ~CJob ()=default
 Destructor for job objects.
 
virtual const char * GetType () const
 Function that returns the type of job.
 
virtual bool ShouldCancel (unsigned int progress, unsigned int total) const
 Function for longer jobs to report progress and check whether they have been cancelled.
 

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

Detailed Description

simple job to retrieve a directory and store a string (language)

Constructor & Destructor Documentation

◆ CSubtitlesJob()

CSubtitlesJob::CSubtitlesJob ( const CURL & url,
const std::string & language )
inline

◆ ~CSubtitlesJob()

CSubtitlesJob::~CSubtitlesJob ( )
inlineoverride

Member Function Documentation

◆ DoWork()

bool CSubtitlesJob::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 CFileItemList * CSubtitlesJob::GetItems ( ) const
inline

◆ GetLanguage()

const std::string & CSubtitlesJob::GetLanguage ( ) const
inline

◆ GetURL()

const CURL & CSubtitlesJob::GetURL ( ) const
inline

◆ operator==()

bool CSubtitlesJob::operator== ( const CJob * job) const
inlineoverridevirtual

Reimplemented from CJob.


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