doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / python / generic / IDProp.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  * Contributor(s): Joseph Eagar, Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef IDPROP_H
26 #define IDPROP_H
27
28 struct ID;
29 struct IDProperty;
30 struct BPy_IDGroup_Iter;
31
32 typedef struct BPy_IDProperty {
33         PyObject_VAR_HEAD
34         struct ID *id;
35         struct IDProperty *prop, *parent;
36         PyObject *data_wrap;
37 } BPy_IDProperty;
38
39 typedef struct BPy_IDArray {
40         PyObject_VAR_HEAD
41         struct ID *id;
42         struct IDProperty *prop;
43 } BPy_IDArray;
44
45 typedef struct BPy_IDGroup_Iter {
46         PyObject_VAR_HEAD
47         BPy_IDProperty *group;
48         struct IDProperty *cur;
49         int mode;
50 } BPy_IDGroup_Iter;
51
52 PyObject *BPy_Wrap_IDProperty(struct ID *id, struct IDProperty *prop, struct IDProperty *parent);
53 PyObject *BPy_Wrap_GetKeys(struct IDProperty *prop);
54 PyObject *BPy_Wrap_GetValues(struct ID *id, struct IDProperty *prop);
55 PyObject *BPy_Wrap_GetItems(struct ID *id, struct IDProperty *prop);
56 int BPy_Wrap_SetMapItem(struct IDProperty *prop, PyObject *key, PyObject *val);
57
58
59 PyObject *BPy_IDGroup_WrapData(struct ID *id, struct IDProperty *prop );
60 const char *BPy_IDProperty_Map_ValidateAndCreate(const char *name, struct IDProperty *group, PyObject *ob);
61
62 void IDProp_Init_Types(void);
63
64 #define IDPROP_ITER_KEYS        0
65 #define IDPROP_ITER_ITEMS       1
66
67 #endif /* IDPROP_H */