Merging r44140 through r44226 from trunk into soc-2011-tomato
[blender.git] / source / blender / python / generic / idprop_py_api.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  * Contributor(s): Joseph Eagar, Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/generic/idprop_py_api.h
24  *  \ingroup pygen
25  */
26
27
28 #ifndef __IDPROP_PY_API_H__
29 #define __IDPROP_PY_API_H__
30
31 struct ID;
32 struct IDProperty;
33 struct BPy_IDGroup_Iter;
34
35 typedef struct BPy_IDProperty {
36         PyObject_VAR_HEAD
37         struct ID *id;
38         struct IDProperty *prop; /* must be second member */
39         struct IDProperty *parent;
40         PyObject *data_wrap;
41 } BPy_IDProperty;
42
43 typedef struct BPy_IDArray {
44         PyObject_VAR_HEAD
45         struct ID *id;
46         struct IDProperty *prop;  /* must be second member */
47 } BPy_IDArray;
48
49 typedef struct BPy_IDGroup_Iter {
50         PyObject_VAR_HEAD
51         BPy_IDProperty *group;
52         struct IDProperty *cur;
53         int mode;
54 } BPy_IDGroup_Iter;
55
56 PyObject *BPy_Wrap_GetKeys(struct IDProperty *prop);
57 PyObject *BPy_Wrap_GetValues(struct ID *id, struct IDProperty *prop);
58 PyObject *BPy_Wrap_GetItems(struct ID *id, struct IDProperty *prop);
59 int BPy_Wrap_SetMapItem(struct IDProperty *prop, PyObject *key, PyObject *val);
60
61
62 PyObject *BPy_IDGroup_WrapData(struct ID *id, struct IDProperty *prop, struct IDProperty *parent);
63 const char *BPy_IDProperty_Map_ValidateAndCreate(PyObject *key, struct IDProperty *group, PyObject *ob);
64
65 void IDProp_Init_Types(void);
66
67 #define IDPROP_ITER_KEYS        0
68 #define IDPROP_ITER_ITEMS       1
69
70 #endif /* __IDPROP_PY_API_H__ */