remove/comment unused defines.
[blender.git] / source / blender / blenkernel / BKE_idcode.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BKE_ID_INFO_H
31 #define BKE_ID_INFO_H
32
33 /**
34  * Convert an idcode into a name.
35  * 
36  * @param code The code to convert.
37  * @return A static string representing the name of
38  * the code.
39  */
40 const char *BKE_idcode_to_name(int code);
41
42 /**
43  * Convert an idcode into a name (plural).
44  * 
45  * @param code The code to convert.
46  * @return A static string representing the name of
47  * the code.
48  */
49 const char *BKE_idcode_to_name_plural(int code);
50
51 /**
52  * Convert a name into an idcode (ie. ID_SCE)
53  * 
54  * @param name The name to convert.
55  * @return The code for the name, or 0 if invalid.
56  */
57 int BKE_idcode_from_name(const char *name);
58
59 /**
60  * Return non-zero when an ID type is linkable.
61  * 
62  * @param code The code to check.
63  * @return Boolean, 0 when non linkable.
64  */
65 int BKE_idcode_is_linkable(int code);
66
67 /**
68  * Return if the ID code is a valid ID code.
69  * 
70  * @param code The code to check.
71  * @return Boolean, 0 when invalid.
72  */
73 int BKE_idcode_is_valid(int code);
74
75 #endif