sbIDirectoryEnumerator Interface Reference

import"sbIDirectoryEnumerator.idl";

Inheritance diagram for sbIDirectoryEnumerator:

Collaboration diagram for sbIDirectoryEnumerator:

Public Member Functions
void	enumerate (in nsIFile aDirectory)
	Enumerate the directory specified by aDirectory. More...
boolean	hasMoreElements ()
	Return true if more elements are available to enumerate. More...
nsIFile	getNext ()
	Return the next file in the enumeration. More...

Public Attributes
attribute unsigned long	maxDepth
	Maximum depth to which to enumerate. A depth of 0 will enumerate to an unlimited depth. A depth of 1 will enumerate only the base directory (same as getDirectoryEntries). More...
attribute boolean	directoriesOnly
	If true, only return directories in getNext. More...
attribute boolean	filesOnly
	If true, only return files in getNext. More...

Detailed Description

This interface provides support for enumerating directory contents. The order of the enumeration is not determinate.

"@songbirdnest.com/Songbird/DirectoryEnumerator;1" Use create instance with this component.

XXXeps should add depth/breadth first support.

Definition at line 47 of file sbIDirectoryEnumerator.idl.

Member Function Documentation

void sbIDirectoryEnumerator::enumerate

(

in nsIFile

aDirectory

)

Enumerate the directory specified by aDirectory.

Parameters

aDirectory

Directory to enumerate.

nsIFile sbIDirectoryEnumerator::getNext

(

)

Return the next file in the enumeration.

Returns

Next file in enumeration.

boolean sbIDirectoryEnumerator::hasMoreElements

(

)

Return true if more elements are available to enumerate.

Returns

True if more elements are available.

Member Data Documentation

attribute boolean sbIDirectoryEnumerator::directoriesOnly

If true, only return directories in getNext.

Definition at line 62 of file sbIDirectoryEnumerator.idl.

attribute boolean sbIDirectoryEnumerator::filesOnly

If true, only return files in getNext.

Definition at line 69 of file sbIDirectoryEnumerator.idl.

attribute unsigned long sbIDirectoryEnumerator::maxDepth

Maximum depth to which to enumerate. A depth of 0 will enumerate to an unlimited depth. A depth of 1 will enumerate only the base directory (same as getDirectoryEntries).

Definition at line 55 of file sbIDirectoryEnumerator.idl.

---

The documentation for this interface was generated from the following file:

• /home/martin/dev/nightingale-hacking/components/moz/fileutils/public/sbIDirectoryEnumerator.idl