FIFE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
FIFE::DirectoryProvider Class Reference

Provider for OS directories. More...

#include <directoryprovider.h>

+ Inheritance diagram for FIFE::DirectoryProvider:
+ Collaboration diagram for FIFE::DirectoryProvider:

Public Member Functions

 DirectoryProvider ()
 
virtual bool isReadable (const std::string &path) const
 Check if a given directory is readable. More...
 
virtual VFSSourcecreateSource (const std::string &path) const
 Create a new instance of a VFSSource initialized with the given directory This will only pass if the path is readable and recognized as a directory as per the description of isReadable. More...
 
- Public Member Functions inherited from FIFE::VFSSourceProvider
 VFSSourceProvider (const std::string &name)
 
virtual ~VFSSourceProvider ()
 
const std::string & getName () const
 Returns the name of this VFSSourceProvider. More...
 
void setVFS (VFS *vfs)
 Get the VFS this provider is using. More...
 
VFSgetVFS () const
 

Private Attributes

std::string m_name
 

Detailed Description

Provider for OS directories.

Definition at line 42 of file directoryprovider.h.

Constructor & Destructor Documentation

FIFE::DirectoryProvider::DirectoryProvider ( )
inline

Definition at line 44 of file directoryprovider.h.

Member Function Documentation

FIFE::VFSSource * FIFE::DirectoryProvider::createSource ( const std::string &  path) const
virtual

Create a new instance of a VFSSource initialized with the given directory This will only pass if the path is readable and recognized as a directory as per the description of isReadable.

Parameters
paththe directory to open
Returns
the new VFSSource

Implements FIFE::VFSSourceProvider.

Definition at line 42 of file directoryprovider.cpp.

References FIFE::VFSSourceProvider::getVFS(), and isReadable().

bool FIFE::DirectoryProvider::isReadable ( const std::string &  path) const
virtual

Check if a given directory is readable.

The path must either be an absolute path or relative to the current working directory where the client was launched

Parameters
paththe filename to check
Returns
true if readable, false otherwise

Implements FIFE::VFSSourceProvider.

Definition at line 38 of file directoryprovider.cpp.

Referenced by createSource().

+ Here is the caller graph for this function:

Member Data Documentation

std::string FIFE::DirectoryProvider::m_name
private

Definition at line 65 of file directoryprovider.h.


The documentation for this class was generated from the following files: