doxygen: add newline after \file
[blender.git] / intern / ghost / intern / GHOST_SystemPaths.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup GHOST
22  */
23
24 #ifndef __GHOST_SYSTEMPATHS_H__
25 #define __GHOST_SYSTEMPATHS_H__
26
27 #include "GHOST_ISystemPaths.h"
28
29 class GHOST_SystemPaths : public GHOST_ISystemPaths
30 {
31 protected:
32         /**
33          * Constructor.
34          * Protected default constructor to force use of static createSystem member.
35          */
36         GHOST_SystemPaths() {}
37
38         /**
39          * Destructor.
40          * Protected default constructor to force use of static dispose member.
41          */
42         virtual ~GHOST_SystemPaths() {}
43
44 public:
45
46         /**
47          * Determine the base dir in which shared resources are located. It will first try to use
48          * "unpack and run" path, then look for properly installed path, including versioning.
49          * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
50          */
51         virtual const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const = 0;
52
53         /**
54          * Determine the base dir in which user configuration is stored, including versioning.
55          * If needed, it will create the base directory.
56          * \return Unsigned char string pointing to user dir (eg ~/.blender/).
57          */
58         virtual const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const = 0;
59
60         /**
61          * Determine the directory of the current binary
62          * \return Unsigned char string pointing to the binary dir
63          */
64         virtual const GHOST_TUns8 *getBinaryDir() const = 0;
65
66         /**
67          * Add the file to the operating system most recently used files
68          */
69         virtual void addToSystemRecentFiles(const char *filename) const = 0;
70 };
71
72 #endif