GHOST_SystemPathsUnix Class Reference

#include <GHOST_SystemPathsUnix.hh>

Inherits GHOST_SystemPaths.

Public Member Functions
	GHOST_SystemPathsUnix ()
	~GHOST_SystemPathsUnix ()
const char *	getSystemDir (int version, const char *versionstr) const
const char *	getUserDir (int version, const char *versionstr) const
const char *	getUserSpecialDir (GHOST_TUserSpecialDirTypes type) const
const char *	getBinaryDir () const
void	addToSystemRecentFiles (const char *filepath) const

Additional Inherited Members
Static Public Member Functions inherited from GHOST_ISystemPaths
static GHOST_TSuccess	create ()
static GHOST_TSuccess	dispose ()
static GHOST_ISystemPaths *	get ()
Protected Member Functions inherited from GHOST_SystemPaths
	GHOST_SystemPaths ()
virtual	~GHOST_SystemPaths ()
Protected Member Functions inherited from GHOST_ISystemPaths
	GHOST_ISystemPaths ()
virtual	~GHOST_ISystemPaths ()

Detailed Description

Definition at line 14 of file GHOST_SystemPathsUnix.hh.

Constructor & Destructor Documentation

GHOST_SystemPathsUnix()

GHOST_SystemPathsUnix::GHOST_SystemPathsUnix ( )

default

Constructor this class should only be instantiated by GHOST_ISystem.

~GHOST_SystemPathsUnix()

GHOST_SystemPathsUnix::~GHOST_SystemPathsUnix ( )

default

Destructor.

Member Function Documentation

addToSystemRecentFiles()

void GHOST_SystemPathsUnix::addToSystemRecentFiles ( const char * filepath ) const

virtual

Add the file to the operating system most recently used files

Implements GHOST_SystemPaths.

Definition at line 178 of file GHOST_SystemPathsUnix.cc.

getBinaryDir()

const char * GHOST_SystemPathsUnix::getBinaryDir ( ) const

virtual

Determine the directory of the current binary.

Returns

Unsigned char string pointing to the binary directory.

Implements GHOST_SystemPaths.

Definition at line 173 of file GHOST_SystemPathsUnix.cc.

getSystemDir()

const char * GHOST_SystemPathsUnix::getSystemDir ( int version, const char * versionstr ) const

virtual

Determine the base directory in which shared resources are located. It will first try to use "unpack and run" path, then look for properly installed path, including versioning.

Returns

Unsigned char string pointing to system directory (eg /usr/share/blender/).

Implements GHOST_SystemPaths.

Definition at line 34 of file GHOST_SystemPathsUnix.cc.

References static_path.

getUserDir()

const char * GHOST_SystemPathsUnix::getUserDir ( int version, const char * versionstr ) const

virtual

Determine the base directory in which user configuration is stored, including versioning. If needed, it will create the base directory.

Returns

Unsigned char string pointing to user directory (eg ~/.config/.blender/).

Implements GHOST_SystemPaths.

Definition at line 56 of file GHOST_SystemPathsUnix.cc.

References home_dir_get().

getUserSpecialDir()

const char * GHOST_SystemPathsUnix::getUserSpecialDir ( GHOST_TUserSpecialDirTypes type ) const

virtual

Determine a special ("well known") and easy to reach user directory.

Returns

Unsigned char string pointing to user directory (eg ~/Documents/).

Implements GHOST_ISystemPaths.

Definition at line 100 of file GHOST_SystemPathsUnix.cc.

References GHOST_ASSERT, GHOST_kUserSpecialDirCaches, GHOST_kUserSpecialDirDesktop, GHOST_kUserSpecialDirDocuments, GHOST_kUserSpecialDirDownloads, GHOST_kUserSpecialDirMusic, GHOST_kUserSpecialDirPictures, and GHOST_kUserSpecialDirVideos.

---

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

• GHOST_SystemPathsUnix.hh
• GHOST_SystemPathsUnix.cc