Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_keyconfig.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 #ifndef __BKE_KEYCONFIG_H__
17 #define __BKE_KEYCONFIG_H__
18
19 /** \file \ingroup bke
20  */
21
22 /** Based on #BKE_addon_pref_type_init and friends */
23
24 struct UserDef;
25 struct wmKeyConfigPref;
26
27 /** Actual data is stored in #wmKeyConfigPref. */
28 #if defined(__RNA_TYPES_H__)
29 typedef struct wmKeyConfigPrefType_Runtime {
30         char idname[64];
31
32         /* RNA integration */
33         ExtensionRNA ext;
34 } wmKeyConfigPrefType_Runtime;
35
36 #else
37 typedef struct wmKeyConfigPrefType_Runtime wmKeyConfigPrefType_Runtime;
38 #endif
39
40 /* KeyConfig preferenes (UserDef). */
41 struct wmKeyConfigPref *BKE_keyconfig_pref_ensure(struct UserDef *userdef, const char *kc_idname);
42
43 /* KeyConfig preferenes (RNA). */
44 struct wmKeyConfigPrefType_Runtime *BKE_keyconfig_pref_type_find(const char *idname, bool quiet);
45 void BKE_keyconfig_pref_type_add(struct wmKeyConfigPrefType_Runtime *kpt_rt);
46 void BKE_keyconfig_pref_type_remove(const struct wmKeyConfigPrefType_Runtime *kpt_rt);
47
48 void BKE_keyconfig_pref_set_select_mouse(struct UserDef *userdef, int value, bool override);
49
50 void BKE_keyconfig_pref_type_init(void);
51 void BKE_keyconfig_pref_type_free(void);
52
53 #endif  /* __BKE_KEYCONFIG_H__ */