Platform_Win32_FileSystem_Directory Class Reference

Inheritance diagram for Platform_Win32_FileSystem_Directory:

List of all members.

Public Member Functions
	Platform_Win32_FileSystem_Directory (const char *path)
virtual	~Platform_Win32_FileSystem_Directory ()
virtual const char *	GetPath ()
virtual bool	Exists ()
virtual void	Create ()
virtual void	Delete ()
virtual void	Rescan ()
virtual int	GetSubdirectoryCount ()
virtual const char *	GetSubdirectory (int index)
virtual int	GetFileCount ()
virtual const char *	GetFile (int index)

---

Detailed Description

Author:

Mattias Gustavsson

Definition at line 20 of file Platform_Win32_FileSystem_Directory.h.

---

Constructor & Destructor Documentation

Platform_Win32_FileSystem_Directory::Platform_Win32_FileSystem_Directory

(

const char *

path

)

Definition at line 17 of file Platform_Win32_FileSystem_Directory.cpp.

Platform_Win32_FileSystem_Directory::~Platform_Win32_FileSystem_Directory

(

)

[virtual]

Definition at line 40 of file Platform_Win32_FileSystem_Directory.cpp.

---

Member Function Documentation

const char * Platform_Win32_FileSystem_Directory::GetPath

(

)

[virtual]

Retrieves the path specified when this directory object was created

Returns:

The path for the directory object

Implements Platform_FileSystem_Directory.

Definition at line 63 of file Platform_Win32_FileSystem_Directory.cpp.

bool Platform_Win32_FileSystem_Directory::Exists

(

)

[virtual]

Checks if the directory which this directory object represents exists.

Returns:

True if the directory exists, false if it doesn't

Implements Platform_FileSystem_Directory.

Definition at line 71 of file Platform_Win32_FileSystem_Directory.cpp.

void Platform_Win32_FileSystem_Directory::Create

(

)

[virtual]

Creates the directory which this directory object represent, if it doesn't already exist.

Implements Platform_FileSystem_Directory.

Definition at line 93 of file Platform_Win32_FileSystem_Directory.cpp.

void Platform_Win32_FileSystem_Directory::Delete

(

)

[virtual]

Deletes the directory which this directory object represent, if it exists.

Implements Platform_FileSystem_Directory.

Definition at line 104 of file Platform_Win32_FileSystem_Directory.cpp.

void Platform_Win32_FileSystem_Directory::Rescan

(

)

[virtual]

When the directory object is first created, it will scan the directory (if it exists) for sub-directories and files. These lists can be updated by calling this method, if you have reason to believe that the contents of the directory might have changed.

Implements Platform_FileSystem_Directory.

Definition at line 115 of file Platform_Win32_FileSystem_Directory.cpp.

int Platform_Win32_FileSystem_Directory::GetSubdirectoryCount

(

)

[virtual]

Retrieves the number of sub-directories in the directory which this directory object represents.

Returns:

The number of sub-directories to this directory

Implements Platform_FileSystem_Directory.

Definition at line 214 of file Platform_Win32_FileSystem_Directory.cpp.

const char * Platform_Win32_FileSystem_Directory::GetSubdirectory

(

int

index

)

[virtual]

Retrieves the path to the specified sub-directory.

Returns:

The sub-directory at the specified index

Implements Platform_FileSystem_Directory.

Definition at line 222 of file Platform_Win32_FileSystem_Directory.cpp.

int Platform_Win32_FileSystem_Directory::GetFileCount

(

)

[virtual]

Retrieves the number of files in the directory which this directory object represents.

Returns:

The number of files in this directory

Implements Platform_FileSystem_Directory.

Definition at line 235 of file Platform_Win32_FileSystem_Directory.cpp.

const char * Platform_Win32_FileSystem_Directory::GetFile

(

int

index

)

[virtual]

Retrieves the path of the specified file

Returns:

The file at the specified index

Implements Platform_FileSystem_Directory.

Definition at line 243 of file Platform_Win32_FileSystem_Directory.cpp.