Songbird / Development / Songbird Add-Ons API Documentation

sbIFileScanCallback Interface Reference

The callback to the sbIFileScanQuery interface. More...

import "sbIFileScan.idl";

List of all members.

Public Member Functions

void onFileScanStart ()
 The media scan is starting.
void onFileScanFile (in AString filePath, in PRInt32 fileCount)
 The media scan has found (yet another) file.
void onFileScanEnd ()
 The media scan is complete.


Detailed Description

The callback to the sbIFileScanQuery interface.

This interface is meant to be implemented by user code.

Create one of these objects to be informed of the progress of the media scan.

NOTE: This object's methods are called from the media scan thread. Not necessarily safe for javascript!

See also:
sbIFileScanQuery, sbIFileScan, FileScan.h

Definition at line 57 of file sbIFileScan.idl.


Member Function Documentation

void sbIFileScanCallback::onFileScanStart (  ) 

The media scan is starting.

See also:
onFileScanFile, onFileScanEnd, sbIFileScanQuery, sbIFileScan

void sbIFileScanCallback::onFileScanFile ( in AString  filePath,
in PRInt32  fileCount 
)

The media scan has found (yet another) file.

Parameters:
filePath The path to the file
fileCount The number of files found so far
See also:
onFileScanStart, onFileScanEnd, sbIFileScanQuery, sbIFileScan

void sbIFileScanCallback::onFileScanEnd (  ) 

The media scan is complete.

See also:
onFileScanStart, onFileScanFile, sbIFileScanQuery, sbIFileScan


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2