Blender  V3.3
Public Member Functions | List of all members
GHOST_SystemPathsUnix Class Reference

#include <GHOST_SystemPathsUnix.h>

Inheritance diagram for GHOST_SystemPathsUnix:
GHOST_SystemPaths GHOST_ISystemPaths

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 *filename) const
 

Additional Inherited Members

- Static Public Member Functions inherited from GHOST_ISystemPaths
static GHOST_TSuccess create ()
 
static GHOST_TSuccess dispose ()
 
static GHOST_ISystemPathsget ()
 
- 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 13 of file GHOST_SystemPathsUnix.h.

Constructor & Destructor Documentation

◆ GHOST_SystemPathsUnix()

GHOST_SystemPathsUnix::GHOST_SystemPathsUnix ( )

Constructor this class should only be instantiated by GHOST_ISystem.

Definition at line 34 of file GHOST_SystemPathsUnix.cpp.

◆ ~GHOST_SystemPathsUnix()

GHOST_SystemPathsUnix::~GHOST_SystemPathsUnix ( )

Destructor.

Definition at line 38 of file GHOST_SystemPathsUnix.cpp.

Member Function Documentation

◆ addToSystemRecentFiles()

void GHOST_SystemPathsUnix::addToSystemRecentFiles ( const char *  filename) const
virtual

Add the file to the operating system most recently used files

Implements GHOST_SystemPaths.

Definition at line 173 of file GHOST_SystemPathsUnix.cpp.

◆ getBinaryDir()

const char * GHOST_SystemPathsUnix::getBinaryDir ( ) const
virtual

Determine the directory of the current binary

Returns
Unsigned char string pointing to the binary dir

Implements GHOST_SystemPaths.

Definition at line 168 of file GHOST_SystemPathsUnix.cpp.

◆ getSystemDir()

const char * GHOST_SystemPathsUnix::getSystemDir ( int  version,
const char *  versionstr 
) const
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_SystemPaths.

Definition at line 42 of file GHOST_SystemPathsUnix.cpp.

References static_path.

◆ getUserDir()

const char * GHOST_SystemPathsUnix::getUserDir ( int  version,
const char *  versionstr 
) const
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 ~/.config/.blender/).

Implements GHOST_SystemPaths.

Definition at line 53 of file GHOST_SystemPathsUnix.cpp.

◆ 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 dir (eg ~/Documents/).

Implements GHOST_ISystemPaths.

Definition at line 95 of file GHOST_SystemPathsUnix.cpp.

References Freestyle::c, GHOST_ASSERT, GHOST_kUserSpecialDirCaches, GHOST_kUserSpecialDirDesktop, GHOST_kUserSpecialDirDocuments, GHOST_kUserSpecialDirDownloads, GHOST_kUserSpecialDirMusic, GHOST_kUserSpecialDirPictures, GHOST_kUserSpecialDirVideos, and type.


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