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

#include <GUIMultiImage.h>

Inheritance diagram for CGUIMultiImage::CMultiImageJob:
CJob

Public Member Functions

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

Public Attributes

std::vector< std::string > m_files
 
std::string m_path
 

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

◆ CMultiImageJob()

CGUIMultiImage::CMultiImageJob::CMultiImageJob ( const std::string & path)
explicit

Member Function Documentation

◆ DoWork()

bool CGUIMultiImage::CMultiImageJob::DoWork ( )
overridevirtual

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.

◆ GetType()

const char * CGUIMultiImage::CMultiImageJob::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.

Member Data Documentation

◆ m_files

std::vector<std::string> CGUIMultiImage::CMultiImageJob::m_files

◆ m_path

std::string CGUIMultiImage::CMultiImageJob::m_path

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