Files::FixedPath< P > Struct Template Reference

#include <fixedpath.hpp>

List of all members.

Public Types
typedef P	PathType
Public Member Functions
	FixedPath (const std::string &application_name)
	Path constructor.
const boost::filesystem::path &	getUserConfigPath () const
	Return path pointing to the user local configuration directory.
const boost::filesystem::path &	getUserDataPath () const
const boost::filesystem::path &	getGlobalConfigPath () const
	Return path pointing to the global (system) configuration directory.
const boost::filesystem::path &	getLocalPath () const
	Return path pointing to the directory where application was started.
const boost::filesystem::path &	getInstallPath () const
const boost::filesystem::path &	getGlobalDataPath () const
const boost::filesystem::path &	getCachePath () const
Private Attributes
PathType	mPath
boost::filesystem::path	mUserConfigPath
boost::filesystem::path	mUserDataPath
boost::filesystem::path	mGlobalConfigPath
boost::filesystem::path	mLocalPath
boost::filesystem::path	mGlobalDataPath
boost::filesystem::path	mCachePath
boost::filesystem::path	mInstallPath

template<class P = TargetPathType>
struct Files::FixedPath< P >

---

Member Typedef Documentation

template<class P = TargetPathType>

typedef P Files::FixedPath< P >::PathType

---

Constructor & Destructor Documentation

template<class P = TargetPathType>

Files::FixedPath< P >::FixedPath

(

const std::string &

application_name

)

[inline]

Path constructor.

Parameters:

[in]

application_name

- Name of the application

---

Member Function Documentation

template<class P = TargetPathType>

const boost::filesystem::path& Files::FixedPath< P >::getCachePath

(

)

const [inline]

template<class P = TargetPathType>

const boost::filesystem::path& Files::FixedPath< P >::getGlobalConfigPath

(

)

const [inline]

Return path pointing to the global (system) configuration directory.

template<class P = TargetPathType>

const boost::filesystem::path& Files::FixedPath< P >::getGlobalDataPath

(

)

const [inline]

template<class P = TargetPathType>

const boost::filesystem::path& Files::FixedPath< P >::getInstallPath

(

)

const [inline]

template<class P = TargetPathType>

const boost::filesystem::path& Files::FixedPath< P >::getLocalPath

(

)

const [inline]

Return path pointing to the directory where application was started.

template<class P = TargetPathType>

const boost::filesystem::path& Files::FixedPath< P >::getUserConfigPath

(

)

const [inline]

Return path pointing to the user local configuration directory.

template<class P = TargetPathType>

const boost::filesystem::path& Files::FixedPath< P >::getUserDataPath

(

)

const [inline]

---

Member Data Documentation

template<class P = TargetPathType>

boost::filesystem::path Files::FixedPath< P >::mCachePath [private]

template<class P = TargetPathType>

boost::filesystem::path Files::FixedPath< P >::mGlobalConfigPath [private]

Global path

template<class P = TargetPathType>

boost::filesystem::path Files::FixedPath< P >::mGlobalDataPath [private]

Global application data path

template<class P = TargetPathType>

boost::filesystem::path Files::FixedPath< P >::mInstallPath [private]

template<class P = TargetPathType>

boost::filesystem::path Files::FixedPath< P >::mLocalPath [private]

It is the same directory where application was run

template<class P = TargetPathType>

PathType Files::FixedPath< P >::mPath [private]

template<class P = TargetPathType>

boost::filesystem::path Files::FixedPath< P >::mUserConfigPath [private]

User path

template<class P = TargetPathType>

boost::filesystem::path Files::FixedPath< P >::mUserDataPath [private]

---

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

• components/files/fixedpath.hpp