GHOST_SystemPathsWin32 Class Reference

#include <GHOST_SystemPathsWin32.hh>

Inherits GHOST_SystemPaths.

Public Member Functions
	GHOST_SystemPathsWin32 ()
	~GHOST_SystemPathsWin32 () override
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

WIN32 Implementation of GHOST_SystemPaths class.

See also

GHOST_SystemPaths.

Definition at line 27 of file GHOST_SystemPathsWin32.hh.

Constructor & Destructor Documentation

GHOST_SystemPathsWin32()

GHOST_SystemPathsWin32::GHOST_SystemPathsWin32

(

)

Constructor.

Definition at line 18 of file GHOST_SystemPathsWin32.cc.

~GHOST_SystemPathsWin32()

GHOST_SystemPathsWin32::~GHOST_SystemPathsWin32 ( )

override

Destructor.

Definition at line 20 of file GHOST_SystemPathsWin32.cc.

Member Function Documentation

addToSystemRecentFiles()

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

overridevirtual

Add the file to the operating system most recently used files

Implements GHOST_SystemPaths.

Definition at line 130 of file GHOST_SystemPathsWin32.cc.

References UTF16_ENCODE, and UTF16_UN_ENCODE.

getBinaryDir()

const char * GHOST_SystemPathsWin32::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 117 of file GHOST_SystemPathsWin32.cc.

References conv_utf_16_to_8().

getSystemDir()

const char * GHOST_SystemPathsWin32::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/).

Implements GHOST_SystemPaths.

Definition at line 22 of file GHOST_SystemPathsWin32.cc.

References conv_utf_16_to_8().

getUserDir()

const char * GHOST_SystemPathsWin32::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 ~/).

Implements GHOST_SystemPaths.

Definition at line 44 of file GHOST_SystemPathsWin32.cc.

References conv_utf_16_to_8().

getUserSpecialDir()

std::optional< std::string > GHOST_SystemPathsWin32::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 65 of file GHOST_SystemPathsWin32.cc.

References conv_utf_16_to_8(), 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_SystemPathsWin32.hh
• GHOST_SystemPathsWin32.cc