2005-04-23 05:41:42 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
2005-04-23 05:39:51 +04:00
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
|
*
|
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
|
*
|
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
|
* License.
|
|
|
|
|
*
|
|
|
|
|
* The Original Code is the Directory Enumerator Interface.
|
|
|
|
|
*
|
|
|
|
|
* The Initial Developer of the Original Code is Google Inc.
|
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2005
|
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
|
*
|
|
|
|
|
* Contributor(s):
|
|
|
|
|
* Ben Goodger <ben@mozilla.org>
|
|
|
|
|
*
|
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
|
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
|
*
|
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
|
|
|
|
|
interface nsIFile;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* This interface provides a means for enumerating the contents of a directory.
|
|
|
|
|
* It is similar to nsISimpleEnumerator except the retrieved entries are QI'ed
|
|
|
|
|
* to nsIFile, and there is a mechanism for closing the directory when the
|
|
|
|
|
* enumeration is complete.
|
|
|
|
|
*
|
|
|
|
|
* @status UNDER_REVIEW
|
|
|
|
|
*/
|
|
|
|
|
[scriptable, uuid(31f7f4ae-6916-4f2d-a81e-926a4e3022ee)]
|
|
|
|
|
interface nsIDirectoryEnumerator : nsISupports
|
|
|
|
|
{
|
|
|
|
|
/**
|
|
|
|
|
* Retrieves the next file in the sequence. The "nextFile" element is the
|
|
|
|
|
* first element upon the first call. This attribute is null if there is no
|
|
|
|
|
* next element.
|
|
|
|
|
*/
|
|
|
|
|
readonly attribute nsIFile nextFile;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Closes the directory being enumerated, releasing the system resource.
|
|
|
|
|
* @throws NS_OK if the call succeeded and the directory was closed.
|
|
|
|
|
* NS_ERROR_FAILURE if the directory close failed.
|
|
|
|
|
* It is safe to call this function many times.
|
|
|
|
|
*/
|
|
|
|
|
void close();
|
|
|
|
|
};
|
|
|
|
|
|
