PropaneFS Class Reference

A class for managing storing data in a user-specific location across platforms, instead of in the program directory. Future operating systems, like OS X 10.5 and Vista, discourage storing data in the program directory. More...

#include <PropaneFS.h>

List of all members.

Public Member Functions
virtual void	createDirectory (std::string path)
	Creates a new directory in the system data path.
virtual std::string	getUserDataPath (std::string f)
	Gets the user path for save games (currently, the same as the system path).
virtual std::string	getSystemDataPath (std::string f)
	Gets the system path (usually, ~/Library or My Documents).
virtual bool	fileExists (std::string path)
	Returns true if a file exists at a given path.
virtual void	createPackageDirectories ()
	Creates directories for this FS package automatically in the user and system directories.
std::string	getDirectorySeparator ()
	Returns the directory seperator for this operating system.
virtual std::list< std::string >	getDirectoryContents (std::string d)
	Returns a list of filenames making up the files and folders in the first level of a directory.
	PropaneFS (std::string PackageName)
	Initialize with a given game package name (this is the name it will use when making new game folders).
virtual	~PropaneFS ()
	Destructor, currently unused.
Protected Attributes
std::string	m_packageName
	Internal storage for the filesystem package name.

---

Detailed Description

A class for managing storing data in a user-specific location across platforms, instead of in the program directory. Future operating systems, like OS X 10.5 and Vista, discourage storing data in the program directory.

---

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

• PropaneFS.h
• PropaneFS_AllPlatforms.cpp

---