added "description" and "readonly" properties to RNA Structs (also accessible via...
[blender.git] / source / blender / makesrna / intern / rna_internal_types.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef RNA_INTERNAL_TYPES
26 #define RNA_INTERNAL_TYPES
27
28 #include "DNA_listBase.h"
29
30 struct BlenderRNA;
31 struct StructRNA;
32 struct PropertyRNA;
33 struct PointerRNA;
34 struct CollectionPropertyIterator;
35 struct bContext;
36
37 /* Function Callbacks */
38
39 typedef void (*NotifyFunc)(struct bContext *C, struct PointerRNA *ptr);
40 typedef int (*EditableFunc)(struct PointerRNA *ptr);
41 typedef struct StructRNA *(*StructRefineFunc)(struct PointerRNA *ptr);
42
43 typedef int (*PropBooleanGetFunc)(struct PointerRNA *ptr);
44 typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, int value);
45 typedef int (*PropBooleanArrayGetFunc)(struct PointerRNA *ptr, int index);
46 typedef void (*PropBooleanArraySetFunc)(struct PointerRNA *ptr, int index, int value);
47 typedef int (*PropIntGetFunc)(struct PointerRNA *ptr);
48 typedef void (*PropIntSetFunc)(struct PointerRNA *ptr, int value);
49 typedef int (*PropIntArrayGetFunc)(struct PointerRNA *ptr, int index);
50 typedef void (*PropIntArraySetFunc)(struct PointerRNA *ptr, int index, int value);
51 typedef void (*PropIntRangeFunc)(struct PointerRNA *ptr, int *min, int *max);
52 typedef float (*PropFloatGetFunc)(struct PointerRNA *ptr);
53 typedef void (*PropFloatSetFunc)(struct PointerRNA *ptr, float value);
54 typedef float (*PropFloatArrayGetFunc)(struct PointerRNA *ptr, int index);
55 typedef void (*PropFloatArraySetFunc)(struct PointerRNA *ptr, int index, float value);
56 typedef void (*PropFloatRangeFunc)(struct PointerRNA *ptr, float *min, float *max);
57 typedef void (*PropStringGetFunc)(struct PointerRNA *ptr, char *value);
58 typedef int (*PropStringLengthFunc)(struct PointerRNA *ptr);
59 typedef void (*PropStringSetFunc)(struct PointerRNA *ptr, const char *value);
60 typedef int (*PropEnumGetFunc)(struct PointerRNA *ptr);
61 typedef void (*PropEnumSetFunc)(struct PointerRNA *ptr, int value);
62 typedef void* (*PropPointerGetFunc)(struct PointerRNA *ptr);
63 typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, void *value);
64 typedef struct StructRNA* (*PropPointerTypeFunc)(struct PointerRNA *ptr);
65 typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
66 typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
67 typedef void (*PropCollectionEndFunc)(struct CollectionPropertyIterator *iter);
68 typedef void* (*PropCollectionGetFunc)(struct CollectionPropertyIterator *iter);
69 typedef struct StructRNA* (*PropCollectionTypeFunc)(struct CollectionPropertyIterator *iter);
70 typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
71 typedef void* (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key, struct StructRNA **type);
72 typedef void* (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key, struct StructRNA **type);
73
74 struct PropertyRNA {
75         struct PropertyRNA *next, *prev;
76
77         /* magic bytes to distinguish with IDProperty */
78         int magic;
79
80         /* unique identifier */
81         const char *identifier;
82         /* various options */
83         int flag;
84
85         /* user readable name */
86         const char *name;
87         /* single line description, displayed in the tooltip for example */
88         const char *description;
89
90         /* property type as it appears to the outside */
91         PropertyType type;
92         /* subtype, 'interpretation' of the property */
93         PropertySubType subtype;
94         /* if an array this is > 0, specifying the length */
95         unsigned int arraylength;
96         
97         /* callback for notifys on change */
98         NotifyFunc notify;
99
100         /* callback for testing if editable/evaluated */
101         EditableFunc editable;
102 };
103
104 /* Property Types */
105
106 typedef struct BooleanPropertyRNA {
107         PropertyRNA property;
108
109         PropBooleanGetFunc get;
110         PropBooleanSetFunc set;
111
112         PropBooleanArrayGetFunc getarray;
113         PropBooleanArraySetFunc setarray;
114
115         int defaultvalue;
116         const int *defaultarray;
117 } BooleanPropertyRNA;
118
119 typedef struct IntPropertyRNA {
120         PropertyRNA property;
121
122         PropIntGetFunc get;
123         PropIntSetFunc set;
124
125         PropIntArrayGetFunc getarray;
126         PropIntArraySetFunc setarray;
127
128         PropIntRangeFunc range;
129
130         int softmin, softmax;
131         int hardmin, hardmax;
132         int step;
133
134         int defaultvalue;
135         const int *defaultarray;
136 } IntPropertyRNA;
137
138 typedef struct FloatPropertyRNA {
139         PropertyRNA property;
140
141         PropFloatGetFunc get;
142         PropFloatSetFunc set;
143
144         PropFloatArrayGetFunc getarray;
145         PropFloatArraySetFunc setarray;
146
147         PropFloatRangeFunc range;
148
149         float softmin, softmax;
150         float hardmin, hardmax;
151         float step;
152         int precision;
153
154         float defaultvalue;
155         const float *defaultarray;
156 } FloatPropertyRNA;
157
158 typedef struct StringPropertyRNA {
159         PropertyRNA property;
160
161         PropStringGetFunc get;
162         PropStringLengthFunc length;
163         PropStringSetFunc set;
164
165         int maxlength;  /* includes string terminator! */
166
167         const char *defaultvalue;
168 } StringPropertyRNA;
169
170 typedef struct EnumPropertyRNA {
171         PropertyRNA property;
172
173         PropEnumGetFunc get;
174         PropEnumSetFunc set;
175
176         const EnumPropertyItem *item;
177         int totitem;
178
179         int defaultvalue;
180 } EnumPropertyRNA;
181
182 typedef struct PointerPropertyRNA {
183         PropertyRNA property;
184
185         PropPointerGetFunc get;
186         PropPointerSetFunc set;
187         PropPointerTypeFunc type;       /* optional */
188
189         struct StructRNA *structtype;
190 } PointerPropertyRNA;
191
192 typedef struct CollectionPropertyRNA {
193         PropertyRNA property;
194
195         PropCollectionBeginFunc begin;
196         PropCollectionNextFunc next;
197         PropCollectionEndFunc end;                                              /* optional */
198         PropCollectionGetFunc get;
199         PropCollectionTypeFunc type;                                    /* optional */
200         PropCollectionLengthFunc length;                                /* optional */
201         PropCollectionLookupIntFunc lookupint;                  /* optional */
202         PropCollectionLookupStringFunc lookupstring;    /* optional */
203
204         struct StructRNA *structtype;
205 } CollectionPropertyRNA;
206
207 struct StructRNA {
208         struct StructRNA *next, *prev;
209
210         /* unique identifier */
211         const char *identifier;
212         /* various options */
213         int flag;
214
215         /* user readable name */
216         const char *name;
217         /* single line description, displayed in the tooltip for example */
218         const char *description;
219         
220         /* property that defines the name */
221         PropertyRNA *nameproperty;
222
223         /* property to iterate over properties */
224         PropertyRNA *iteratorproperty;
225
226         /* struct this is derivedfrom */
227         struct StructRNA *from;
228
229         /* callback for notifys on change */
230         NotifyFunc notify;
231
232         /* function to give the more specific type */
233         StructRefineFunc refine; 
234
235         /* properties of this struct */
236         ListBase properties; 
237 };
238
239 /* Blender RNA
240  *
241  * Root RNA data structure that lists all struct types. */
242
243 struct BlenderRNA {
244         ListBase structs;
245 };
246
247 #endif /* RNA_INTERNAL_TYPES */
248