Back to index

lightning-sunbird  0.9+nobinonly
inIFileSearch.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2001
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Joe Hewitt <hewitt@netscape.com> (original author)
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "inISearchProcess.idl"
00039 
00040 interface nsIFile;
00041 interface nsISupportsArray;
00042 
00043 [scriptable, uuid(EFA53257-526D-4350-9088-343A510346B8)]
00044 interface inIFileSearch : inISearchProcess {
00045     // the base url for all returned URL results, if returnRelativePaths is true
00046   attribute wstring basePath; 
00047   
00048   // strip off the basePath for all results through getStringResultAt if true
00049   attribute boolean returnRelativePaths;
00050 
00051   unsigned long getDirectoryDepth(in nsIFile aDir);
00052   nsISupportsArray getSubDirectories(in nsIFile aDir);
00053 
00054   // criteria 
00055   attribute wstring filenameCriteria;
00056   attribute wstring textCriteria;
00057   attribute nsIFile searchPath;
00058   attribute boolean searchRecursive;
00059   
00060   // results
00061   readonly attribute unsigned long directoriesSearched;
00062   readonly attribute nsIFile currentDirectory;
00063     
00064   nsIFile getFileResultAt(in long aIndex);
00065 };