Blender  V3.3
Public Member Functions | Protected Member Functions | List of all members
GHOST_SystemPaths Class Referenceabstract

#include <GHOST_SystemPaths.h>

Inheritance diagram for GHOST_SystemPaths:
GHOST_ISystemPaths GHOST_SystemPathsCocoa GHOST_SystemPathsUnix GHOST_SystemPathsWin32

Public Member Functions

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

Protected Member Functions

 GHOST_SystemPaths ()
 
virtual ~GHOST_SystemPaths ()
 
- Protected Member Functions inherited from GHOST_ISystemPaths
 GHOST_ISystemPaths ()
 
virtual ~GHOST_ISystemPaths ()
 

Additional Inherited Members

- Static Public Member Functions inherited from GHOST_ISystemPaths
static GHOST_TSuccess create ()
 
static GHOST_TSuccess dispose ()
 
static GHOST_ISystemPathsget ()
 

Detailed Description

Definition at line 12 of file GHOST_SystemPaths.h.

Constructor & Destructor Documentation

◆ GHOST_SystemPaths()

GHOST_SystemPaths::GHOST_SystemPaths ( )
inlineprotected

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

Definition at line 18 of file GHOST_SystemPaths.h.

◆ ~GHOST_SystemPaths()

virtual GHOST_SystemPaths::~GHOST_SystemPaths ( )
inlineprotectedvirtual

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

Definition at line 26 of file GHOST_SystemPaths.h.

Member Function Documentation

◆ addToSystemRecentFiles()

virtual void GHOST_SystemPaths::addToSystemRecentFiles ( const char *  filename) const
pure virtual

Add the file to the operating system most recently used files

Implements GHOST_ISystemPaths.

Implemented in GHOST_SystemPathsWin32, GHOST_SystemPathsUnix, and GHOST_SystemPathsCocoa.

◆ getBinaryDir()

virtual const char* GHOST_SystemPaths::getBinaryDir ( ) const
pure virtual

Determine the directory of the current binary

Returns
Unsigned char string pointing to the binary dir

Implements GHOST_ISystemPaths.

Implemented in GHOST_SystemPathsWin32, GHOST_SystemPathsUnix, and GHOST_SystemPathsCocoa.

◆ getSystemDir()

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

Determine the base dir 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 dir (eg /usr/share/blender/).

Implements GHOST_ISystemPaths.

Implemented in GHOST_SystemPathsWin32, GHOST_SystemPathsUnix, and GHOST_SystemPathsCocoa.

◆ getUserDir()

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

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

Returns
Unsigned char string pointing to user dir (eg ~/.blender/).

Implements GHOST_ISystemPaths.

Implemented in GHOST_SystemPathsWin32, GHOST_SystemPathsUnix, and GHOST_SystemPathsCocoa.


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