sbAlbumArtScanner Class Reference

#include <sbAlbumArtScanner.h>

Inheritance diagram for sbAlbumArtScanner:
[legend]
Collaboration diagram for sbAlbumArtScanner:
[legend]

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_SBIALBUMARTSCANNER
NS_DECL_NSICLASSINFO
NS_DECL_SBIJOBPROGRESS
NS_DECL_SBIJOBPROGRESSUI
NS_DECL_SBIJOBCANCELABLE
NS_DECL_NSITIMERCALLBACK
NS_DECL_SBIALBUMARTLISTENER 
sbAlbumArtScanner ()
 
virtual ~sbAlbumArtScanner ()
 
nsresult Initialize ()
 
- Public Member Functions inherited from sbIAlbumArtScanner
void scanListForArtwork (in sbIMediaList aMediaList)
 
- Public Member Functions inherited from sbIJobProgress
nsIStringEnumerator getErrorMessages ()
 Enumerate all the errors encountered during the job. More...
 
void addJobProgressListener (in sbIJobProgressListener aListener)
 Add a listener to be notified when significant job progress has been made. More...
 
void removeJobProgressListener (in sbIJobProgressListener aListener)
 Remove a previously added listener. More...
 
- Public Member Functions inherited from sbIJobCancelable
void cancel ()
 Attempt to cancel the job Throws NS_ERROR_FAILURE if canceling fails. More...
 
- Public Member Functions inherited from sbIAlbumArtListener
void onChangeFetcher (in sbIAlbumArtFetcher aFetcher)
 onChangeFetcher - Notifies the listener when the fetcher being used has changed. This is used from the sbIAlbumArtFetcherSet component. More...
 
void onTrackResult (in nsIURI aImageLocation, in sbIMediaItem aMediaItem)
 onTrackResult - Notifies the listener when either an image has or has not been found. aImageLocation will be null if the operation failed to get artwork. More...
 
void onAlbumResult (in nsIURI aImageLocation, in nsIArray aMediaItems)
 onAlbumResult - Notifies the listener when either an image has or has not been found for a list of items. aImageLocation will be null if the operation failed to get artwork. More...
 
void onSearchComplete (in nsIArray aMediaItems)
 onSearchComplete - Notifies the listener that the search for artwork has been completed. More...
 

Additional Inherited Members

- Public Attributes inherited from sbIAlbumArtScanner
attribute boolean updateArtwork
 If true, update any artwork already present in media items. More...
 
- Public Attributes inherited from sbIJobProgressUI
readonly attribute DOMString crop
 
- Public Attributes inherited from sbIJobProgress
const unsigned short STATUS_FAILED = 0x00
 Constant indicating that the job has completed with errors. More...
 
const unsigned short STATUS_SUCCEEDED = 0x10
 Constant indicating that the job has completed. More...
 
const unsigned short STATUS_RUNNING = 0x20
 Constant indicating that the job is active. More...
 
readonly attribute unsigned short status
 Current status of the job. More...
 
readonly attribute boolean blocked
 If true, progress of job is blocked (e.g., due to locked resource). More...
 
readonly attribute AString statusText
 Localized message describing the status of the job. More...
 
readonly attribute AString titleText
 Localized message describing the type or purpose of the job. More...
 
readonly attribute unsigned long progress
 Number of work units completed. More...
 
readonly attribute unsigned long total
 Total number of work units to be completed May be set to 0 if the job length is indeterminate. More...
 
readonly attribute unsigned long errorCount
 Number of errors that have been encountered. More...
 
- Public Attributes inherited from sbIJobCancelable
readonly attribute boolean canCancel
 True if it is possible to cancel the job. More...
 

Detailed Description

This class implements the album art scanner component.

Definition at line 111 of file sbAlbumArtScanner.h.

Constructor & Destructor Documentation

sbAlbumArtScanner::sbAlbumArtScanner ( )

Construct an album art scanner instance.

Definition at line 663 of file sbAlbumArtScanner.cpp.

sbAlbumArtScanner::~sbAlbumArtScanner ( )
virtual

Destroy an album art scanner instance.

Definition at line 686 of file sbAlbumArtScanner.cpp.

Member Function Documentation

nsresult sbAlbumArtScanner::Initialize ( )

Initialize the album art scanner.

Definition at line 705 of file sbAlbumArtScanner.cpp.

Here is the call graph for this function:


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