GHOST_SystemPathsCocoa Class Reference

#include <GHOST_SystemPathsCocoa.hh>

Inherits GHOST_SystemPaths.

Public Member Functions
	GHOST_SystemPathsCocoa ()=default
	~GHOST_SystemPathsCocoa () override=default
const char *	getSystemDir (int version, const char *versionstr) const override
const char *	getUserDir (int version, const char *versionstr) const override
std::optional< std::string >	getUserSpecialDir (GHOST_TUserSpecialDirTypes type) const override
const char *	getBinaryDir () const override
void	addToSystemRecentFiles (const char *filepath) const override

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 ()
	~GHOST_SystemPaths () override=default
Protected Member Functions inherited from GHOST_ISystemPaths
	GHOST_ISystemPaths ()
virtual	~GHOST_ISystemPaths ()=default

Detailed Description

Definition at line 20 of file GHOST_SystemPathsCocoa.hh.

Constructor & Destructor Documentation

GHOST_SystemPathsCocoa()

GHOST_SystemPathsCocoa::GHOST_SystemPathsCocoa ( )

default

Constructor.

~GHOST_SystemPathsCocoa()

GHOST_SystemPathsCocoa::~GHOST_SystemPathsCocoa ( )

overridedefault

Destructor.

Member Function Documentation

addToSystemRecentFiles()

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

overridevirtual

Add the file to the operating system most recently used files

Implements GHOST_SystemPaths.

Definition at line 128 of file GHOST_SystemPathsCocoa.mm.

getBinaryDir()

const char * GHOST_SystemPathsCocoa::getBinaryDir ( ) const

overridevirtual

Determine the directory of the current binary.

Returns

Unsigned char string pointing to the binary directory.

Implements GHOST_SystemPaths.

Definition at line 107 of file GHOST_SystemPathsCocoa.mm.

References MIN.

getSystemDir()

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

overridevirtual

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 40 of file GHOST_SystemPathsCocoa.mm.

References GetApplicationSupportDir().

getUserDir()

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

overridevirtual

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_SystemPaths.

Definition at line 46 of file GHOST_SystemPathsCocoa.mm.

References GetApplicationSupportDir().

getUserSpecialDir()

std::optional< std::string > GHOST_SystemPathsCocoa::getUserSpecialDir ( GHOST_TUserSpecialDirTypes type ) const

overridevirtual

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

Returns

If successfull, a string containing the user directory path (eg ~/Documents/).

Implements GHOST_ISystemPaths.

Definition at line 52 of file GHOST_SystemPathsCocoa.mm.

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

---

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

• GHOST_SystemPathsCocoa.hh
• GHOST_SystemPathsCocoa.mm