sbIFileScan.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
// 
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
// 
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
// 
// Software distributed under the License is distributed 
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
// express or implied. See the GPL for the specific language 
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this 
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc., 
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// 
// END SONGBIRD GPL
//
*/

#include "nsISupports.idl"
interface nsIArray;

[scriptable, uuid(e1cf5762-1dd1-11b2-bc1c-a0de92947c7a)]
interface sbIFileScanCallback : nsISupports
{
  void onFileScanStart(); 

  void onFileScanFile(in AString filePath, 
    in PRInt32 fileCount); 

  void onFileScanEnd(); 
};

[scriptable, uuid(E53F7F77-9576-46FC-9F25-0A5A05A7E9CA)]
interface sbIFileScanQuery : nsISupports
{
  attribute boolean searchHidden;

  void setDirectory(in AString strDirectory); 

  AString getDirectory(); 

  void setRecurse(in PRBool bRecurse); 

  PRBool getRecurse(); 

  void addFileExtension(in AString strExtension);

  void addFlaggedFileExtension(in AString strExtension);

  readonly attribute boolean flaggedExtensionsFound;

  void setCallback(in sbIFileScanCallback pCallback); 

  sbIFileScanCallback getCallback(); 

  PRUint32 getFileCount(); 

  PRUint32 getFlaggedFileCount();

  void addFilePath(in AString strFilePath); 

  AString getFilePath(in PRUint32 nIndex); 

  AString getFlaggedFilePath(in PRUint32 nIndex);

  PRBool isScanning();

  void setIsScanning(in PRBool bIsScanning);

  AString getLastFileFound();

  AString getCurrentScanPath();

  void setCurrentScanPath(in AString strScanPath);

  void cancel();

  nsIArray getResultRangeAsURIStrings(in unsigned long aStartIndex,
                                      in unsigned long aEndIndex);

  PRBool isCancelled();

  attribute boolean wantLibraryContentURIs;

};

[scriptable, uuid(27431e35-b060-486e-ba58-76c5ae7f8c24)]
interface sbIFileScan : nsISupports
{ 
  void submitQuery(in sbIFileScanQuery pQuery);
  
  void finalize();
};