AgateLib.Utility.FileProviderList Class Reference

Contains a list of IFileProvider objects that are used to search for and open files. More...

Inheritance diagram for AgateLib.Utility.FileProviderList:

AgateLib.Utility.IFileProvider

List of all members.

Public Member Functions

Stream OpenRead (string filename)
 Opens a specified file by searching backwards through the list of providers until a matching filename is found. A FileNotFoundException is thrown if the file does not exist.
IEnumerable< string > GetAllFiles (string filter)
 Returns all filenames matching the specified filter in all file providers.
IEnumerable< string > GetAllFiles ()
 Returns all filenames in all file providers.
bool FileExists (string filename)
 Returns true if the specified file exists in a file provider.
void AddPath (string path)
 Adds a path in the filesystem to the list of locations to search when openning a file.
int IndexOf (IFileProvider item)
void Insert (int index, IFileProvider item)
void RemoveAt (int index)
void Add (IFileProvider item)
void Clear ()
bool Contains (IFileProvider item)
void CopyTo (IFileProvider[] array, int arrayIndex)
bool Remove (IFileProvider item)
IEnumerator< IFileProviderGetEnumerator ()

Properties

IFileProvider this [int index] [get, set]
int Count [get]
bool IsReadOnly [get]


Detailed Description

Contains a list of IFileProvider objects that are used to search for and open files.


Member Function Documentation

void AgateLib.Utility.FileProviderList.AddPath ( string  path  ) 

Adds a path in the filesystem to the list of locations to search when openning a file.

Parameters:
path 

bool AgateLib.Utility.FileProviderList.FileExists ( string  filename  ) 

Returns true if the specified file exists in a file provider.

Parameters:
filename 
Returns:

Implements AgateLib.Utility.IFileProvider.

IEnumerable<string> AgateLib.Utility.FileProviderList.GetAllFiles (  ) 

Returns all filenames in all file providers.

Returns:

Implements AgateLib.Utility.IFileProvider.

IEnumerable<string> AgateLib.Utility.FileProviderList.GetAllFiles ( string  filter  ) 

Returns all filenames matching the specified filter in all file providers.

Parameters:
filter 
Returns:

Implements AgateLib.Utility.IFileProvider.

Stream AgateLib.Utility.FileProviderList.OpenRead ( string  filename  ) 

Opens a specified file by searching backwards through the list of providers until a matching filename is found. A FileNotFoundException is thrown if the file does not exist.

Parameters:
filename The filename to search for.
Returns:

Implements AgateLib.Utility.IFileProvider.


The documentation for this class was generated from the following file:
AgateLib
Awesome Game and Tool Engine Library
SourceForge.net Logo