GHOST_SystemPaths Class Reference

#include <GHOST_SystemPaths.hh>

Inherits GHOST_ISystemPaths.

Inherited by GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.

Public Member Functions
const char *	getSystemDir (int version, const char *versionstr) const override=0
const char *	getUserDir (int version, const char *versionstr) const override=0
const char *	getBinaryDir () const override=0
void	addToSystemRecentFiles (const char *filepath) const override=0
Public Member Functions inherited from GHOST_ISystemPaths
virtual const char *	getUserSpecialDir (GHOST_TUserSpecialDirTypes type) const =0

Protected Member Functions
	GHOST_SystemPaths ()
	~GHOST_SystemPaths () override=default
Protected Member Functions inherited from GHOST_ISystemPaths
	GHOST_ISystemPaths ()
virtual	~GHOST_ISystemPaths ()=default

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

Detailed Description

Definition at line 13 of file GHOST_SystemPaths.hh.

Constructor & Destructor Documentation

GHOST_SystemPaths()

GHOST_SystemPaths::GHOST_SystemPaths ( )

inlineprotected

Constructor. Protected default constructor to force use of static createSystem member.

Definition at line 19 of file GHOST_SystemPaths.hh.

~GHOST_SystemPaths()

GHOST_SystemPaths::~GHOST_SystemPaths ( )

overrideprotecteddefault

Destructor. Protected default constructor to force use of static dispose member.

Member Function Documentation

addToSystemRecentFiles()

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

overridepure virtual

Add the file to the operating system most recently used files

Implements GHOST_ISystemPaths.

Implemented in GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.

getBinaryDir()

const char * GHOST_SystemPaths::getBinaryDir ( ) const

overridepure virtual

Determine the directory of the current binary.

Returns

Unsigned char string pointing to the binary directory.

Implements GHOST_ISystemPaths.

Implemented in GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.

getSystemDir()

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

overridepure 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_ISystemPaths.

Implemented in GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.

getUserDir()

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

overridepure 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 ~/.blender/).

Implements GHOST_ISystemPaths.

Implemented in GHOST_SystemPathsCocoa, GHOST_SystemPathsUnix, and GHOST_SystemPathsWin32.

---

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

• GHOST_SystemPaths.hh