svn merge ^/trunk/blender -r40379:40381
[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 /** \file BKE_idcode.h
34  *  \ingroup bke
35  */
36
37 /**
38  * Convert an idcode into a name.
39  * 
40  * @param code The code to convert.
41  * @return A static string representing the name of
42  * the code.
43  */
44 const char *BKE_idcode_to_name(int code);
45
46 /**
47  * Convert an idcode into a name (plural).
48  * 
49  * @param code The code to convert.
50  * @return A static string representing the name of
51  * the code.
52  */
53 const char *BKE_idcode_to_name_plural(int code);
54
55 /**
56  * Convert a name into an idcode (ie. ID_SCE)
57  * 
58  * @param name The name to convert.
59  * @return The code for the name, or 0 if invalid.
60  */
61 int BKE_idcode_from_name(const char *name);
62
63 /**
64  * Return non-zero when an ID type is linkable.
65  * 
66  * @param code The code to check.
67  * @return Boolean, 0 when non linkable.
68  */
69 int BKE_idcode_is_linkable(int code);
70
71 /**
72  * Return if the ID code is a valid ID code.
73  * 
74  * @param code The code to check.
75  * @return Boolean, 0 when invalid.
76  */
77 int BKE_idcode_is_valid(int code);
78
79 /**
80  * Return an ID code and steps the index forward 1.
81  *
82  * @param index, start as 0.
83  * @return the code, 0 when all codes have been returned.
84  */
85 int BKE_idcode_iter_step(int *index);
86
87 #endif