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

Combined base implementation of a music library job with a progress bar. More...

#include <MusicLibraryProgressJob.h>

Inheritance diagram for CMusicLibraryProgressJob:
CProgressJob CMusicLibraryJob CJob CJob CMusicLibraryCleaningJob CMusicLibraryExportJob CMusicLibraryImportJob

Public Member Functions

 ~CMusicLibraryProgressJob () override
 
bool DoWork () override
 Main workhorse function of CJob instances.
 
const char * GetType () const override
 Function that returns the type of job.
 
bool operator== (const CJob *job) const override
 
- Public Member Functions inherited from CProgressJob
 ~CProgressJob () override
 
const char * GetType () const override
 Function that returns the type of job.
 
bool operator== (const CJob *job) const override
 
bool ShouldCancel (unsigned int progress, unsigned int total) const override
 Function for longer jobs to report progress and check whether they have been cancelled.
 
bool DoModal ()
 Executes the job showing a modal progress dialog.
 
void SetProgressIndicators (CGUIDialogProgressBarHandle *progressBar, CGUIDialogProgress *progressDialog, bool updateProgress=true, bool updateInformation=true)
 Sets the given progress indicators to be used during execution of the job.
 
bool HasProgressIndicator () const
 
- Public Member Functions inherited from CJob
 CJob ()
 
virtual ~CJob ()=default
 Destructor for job objects.
 
- Public Member Functions inherited from CMusicLibraryJob
 ~CMusicLibraryJob () override
 
virtual bool CanBeCancelled () const
 Whether the job can be cancelled or not.
 
virtual bool Cancel ()
 Tries to cancel the running job.
 

Protected Member Functions

 CMusicLibraryProgressJob (CGUIDialogProgressBarHandle *progressBar)
 
- Protected Member Functions inherited from CProgressJob
 CProgressJob ()
 
 CProgressJob (CGUIDialogProgressBarHandle *progressBar)
 
bool IsModal () const
 Whether the job is being run modally or in the background.
 
CGUIDialogProgressBarHandleGetProgressBar () const
 Returns the progress bar indicating the progress of the job.
 
void SetProgressBar (CGUIDialogProgressBarHandle *progress)
 Sets the progress bar indicating the progress of the job.
 
CGUIDialogProgressGetProgressDialog () const
 Returns the progress dialog indicating the progress of the job.
 
void SetProgressDialog (CGUIDialogProgress *progressDialog)
 Sets the progress bar indicating the progress of the job.
 
bool GetAutoClose ()
 Whether to automatically close the progress indicator in MarkFinished().
 
void SetAutoClose (bool autoClose)
 Set whether to automatically close the progress indicator in MarkFinished().
 
bool GetUpdateProgress ()
 Whether to update the progress bar or not.
 
void SetUpdateProgress (bool updateProgress)
 Set whether to update the progress bar or not.
 
bool GetUpdateInformation ()
 Whether to update the progress information or not.
 
void SetUpdateInformation (bool updateInformation)
 Set whether to update the progress information or not.
 
void ShowProgressDialog () const
 Makes sure that the modal dialog is being shown.
 
void SetTitle (const std::string &title)
 Sets the given title as the title of the progress bar.
 
void SetText (const std::string &text)
 Sets the given text as the description of the progress bar.
 
void SetProgress (float percentage) const
 Sets the progress of the progress bar to the given value in percentage.
 
void SetProgress (int currentStep, int totalSteps) const
 Sets the progress of the progress bar to the given value.
 
void MarkFinished ()
 Marks the progress as finished by setting it to 100%.
 
bool IsCancelled () const
 Checks if the progress dialog has been cancelled.
 
- Protected Member Functions inherited from CMusicLibraryJob
 CMusicLibraryJob ()
 
virtual bool Work (CMusicDatabase &db)=0
 Worker method to be implemented by an actual implementation.
 

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

Combined base implementation of a music library job with a progress bar.

Constructor & Destructor Documentation

◆ ~CMusicLibraryProgressJob()

CMusicLibraryProgressJob::~CMusicLibraryProgressJob ( )
overridedefault

◆ CMusicLibraryProgressJob()

CMusicLibraryProgressJob::CMusicLibraryProgressJob ( CGUIDialogProgressBarHandle * progressBar)
explicitprotected

Member Function Documentation

◆ DoWork()

bool CMusicLibraryProgressJob::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 * CMusicLibraryProgressJob::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.

◆ operator==()

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

Reimplemented from CJob.


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