Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_SystemPathsCocoa.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) 2010 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup GHOST
21  */
22
23
24 #ifndef __GHOST_SYSTEMPATHSCOCOA_H__
25 #define __GHOST_SYSTEMPATHSCOCOA_H__
26
27 #ifndef __APPLE__
28 #error Apple OSX only!
29 #endif // __APPLE__
30
31
32 #include "GHOST_SystemPaths.h"
33
34
35 class GHOST_SystemPathsCocoa : public GHOST_SystemPaths {
36 public:
37         /**
38          * Constructor.
39          */
40         GHOST_SystemPathsCocoa();
41
42         /**
43          * Destructor.
44          */
45         ~GHOST_SystemPathsCocoa();
46
47         /**
48          * Determine the base dir in which shared resources are located. It will first try to use
49          * "unpack and run" path, then look for properly installed path, including versioning.
50          * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
51          */
52         const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
53
54         /**
55          * Determine the base dir in which user configuration is stored, including versioning.
56          * If needed, it will create the base directory.
57          * \return Unsigned char string pointing to user dir (eg ~/.blender/).
58          */
59         const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
60
61         /**
62          * Determine the directory of the current binary
63          * \return Unsigned char string pointing to the binary dir
64          */
65         const GHOST_TUns8 *getBinaryDir() const;
66
67         /**
68          * Add the file to the operating system most recently used files
69          */
70         void addToSystemRecentFiles(const char *filename) const;
71 };
72
73 #endif // __GHOST_SYSTEMPATHSCOCOA_H__