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