Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_idcode.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_IDCODE_H__
29 #define __BKE_IDCODE_H__
30
31 /** \file BKE_idcode.h
32  *  \ingroup bke
33  */
34
35 const char *BKE_idcode_to_name(short idcode);
36 const char *BKE_idcode_to_name_plural(short idcode);
37 const char *BKE_idcode_to_translation_context(short idcode);
38 short       BKE_idcode_from_name(const char *name);
39 bool        BKE_idcode_is_linkable(short idcode);
40 bool        BKE_idcode_is_valid(short idcode);
41
42 int         BKE_idcode_to_idfilter(const short idcode);
43 short       BKE_idcode_from_idfilter(const int idfilter);
44
45 int BKE_idcode_to_index(const short idcode);
46
47 /**
48  * Return an ID code and steps the index forward 1.
49  *
50  * \param index: start as 0.
51  * \return the code, 0 when all codes have been returned.
52  */
53 short BKE_idcode_iter_step(int *index);
54
55 #endif