Merge with -r 22620:23107.
[blender.git] / source / blender / makesrna / intern / rna_ui_api.c
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  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31
32 #include "RNA_define.h"
33 #include "RNA_types.h"
34
35 #include "UI_interface.h"
36 #include "UI_resources.h"
37
38 #ifdef RNA_RUNTIME
39
40 static void rna_uiItemR(uiLayout *layout, char *name, int icon, PointerRNA *ptr, char *propname, int expand, int slider, int toggle)
41 {
42         int flag= 0;
43
44         flag |= (slider)? UI_ITEM_R_SLIDER: 0;
45         flag |= (expand)? UI_ITEM_R_EXPAND: 0;
46         flag |= (toggle)? UI_ITEM_R_TOGGLE: 0;
47
48         uiItemR(layout, name, icon, ptr, propname, flag);
49 }
50
51 static PointerRNA rna_uiItemO(uiLayout *layout, char *name, int icon, char *opname, int properties)
52 {
53         int flag= (properties)? UI_ITEM_O_RETURN_PROPS: 0;
54         return uiItemFullO(layout, name, icon, opname, NULL, uiLayoutGetOperatorContext(layout), flag);
55 }
56
57 #else
58
59 #define DEF_ICON(name) {name, #name, 0, #name, ""},
60 static EnumPropertyItem icon_items[] = {
61 #include "UI_icons.h"
62                 {0, NULL, 0, NULL, NULL}};
63 #undef DEF_ICON
64
65 static void api_ui_item_common(FunctionRNA *func)
66 {
67         PropertyRNA *prop;
68
69         RNA_def_string(func, "text", "", 0, "", "Override automatic text of the item.");
70
71         prop= RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
72         RNA_def_property_enum_items(prop, icon_items);
73         RNA_def_property_ui_text(prop, "Icon", "Override automatic icon of the item.");
74
75 }
76
77 static void api_ui_item_op_common(FunctionRNA *func)
78 {
79         PropertyRNA *parm;
80
81         api_ui_item_common(func);
82         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
83         RNA_def_property_flag(parm, PROP_REQUIRED);
84 }
85
86 static void api_ui_item_rna_common(FunctionRNA *func)
87 {
88         PropertyRNA *parm;
89
90         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
91         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
92         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
93         RNA_def_property_flag(parm, PROP_REQUIRED);
94 }
95
96 void RNA_api_ui_layout(StructRNA *srna)
97 {
98         FunctionRNA *func;
99         PropertyRNA *parm;
100
101         static EnumPropertyItem curve_type_items[] = {
102                 {0, "NONE", 0, "None", ""},
103                 {'v', "VECTOR", 0, "Vector", ""},
104                 {'c', "COLOR", 0, "Color", ""},
105                 {0, NULL, 0, NULL, NULL}};
106         
107         static EnumPropertyItem list_type_items[] = {
108                 {0, "DEFAULT", 0, "None", ""},
109                 {'c', "COMPACT", 0, "Compact", ""},
110                 {'i', "ICONS", 0, "Icons", ""},
111                 {0, NULL, 0, NULL, NULL}};
112
113         /* simple layout specifiers */
114         func= RNA_def_function(srna, "row", "uiLayoutRow");
115         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
116         RNA_def_function_return(func, parm);
117         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
118
119         func= RNA_def_function(srna, "column", "uiLayoutColumn");
120         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
121         RNA_def_function_return(func, parm);
122         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
123
124         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
125         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
126         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
127         RNA_def_function_return(func, parm);
128         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
129
130         /* box layout */
131         func= RNA_def_function(srna, "box", "uiLayoutBox");
132         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
133         RNA_def_function_return(func, parm);
134
135         /* split layout */
136         func= RNA_def_function(srna, "split", "uiLayoutSplit");
137         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
138         RNA_def_function_return(func, parm);
139         RNA_def_float(func, "percentage", 0.0f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
140
141         /* items */
142         func= RNA_def_function(srna, "itemR", "rna_uiItemR");
143         api_ui_item_common(func);
144         api_ui_item_rna_common(func);
145         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
146         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
147         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
148
149         func= RNA_def_function(srna, "items_enumR", "uiItemsEnumR");
150         api_ui_item_rna_common(func);
151
152         func= RNA_def_function(srna, "item_menu_enumR", "uiItemMenuEnumR");
153         api_ui_item_common(func);
154         api_ui_item_rna_common(func);
155
156         func= RNA_def_function(srna, "item_enumR", "uiItemEnumR_string");
157         api_ui_item_common(func);
158         api_ui_item_rna_common(func);
159         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
160         RNA_def_property_flag(parm, PROP_REQUIRED);
161
162         func= RNA_def_function(srna, "item_pointerR", "uiItemPointerR");
163         api_ui_item_common(func);
164         api_ui_item_rna_common(func);
165         parm= RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in.");
166         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
167         parm= RNA_def_string(func, "search_property", "", 0, "", "Identifier of search collection property.");
168         RNA_def_property_flag(parm, PROP_REQUIRED);
169
170         func= RNA_def_function(srna, "itemO", "rna_uiItemO");
171         api_ui_item_op_common(func);
172         parm= RNA_def_boolean(func, "properties", 0, "Properties", "Return operator properties to fill in manually.");
173         parm= RNA_def_pointer(func, "return_properties", "OperatorProperties", "", "Operator properties to fill in, return when 'properties' is set to true.");
174         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
175         RNA_def_function_return(func, parm);
176
177         func= RNA_def_function(srna, "item_enumO", "uiItemEnumO_string");
178         api_ui_item_op_common(func);
179         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
180         RNA_def_property_flag(parm, PROP_REQUIRED);
181         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
182         RNA_def_property_flag(parm, PROP_REQUIRED);
183
184         func= RNA_def_function(srna, "items_enumO", "uiItemsEnumO");
185         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
186         RNA_def_property_flag(parm, PROP_REQUIRED);
187         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
188         RNA_def_property_flag(parm, PROP_REQUIRED);
189
190         func= RNA_def_function(srna, "item_menu_enumO", "uiItemMenuEnumO");
191         api_ui_item_op_common(func);
192         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
193         RNA_def_property_flag(parm, PROP_REQUIRED);
194
195         func= RNA_def_function(srna, "item_booleanO", "uiItemBooleanO");
196         api_ui_item_op_common(func);
197         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
198         RNA_def_property_flag(parm, PROP_REQUIRED);
199         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
200         RNA_def_property_flag(parm, PROP_REQUIRED);
201
202         func= RNA_def_function(srna, "item_intO", "uiItemIntO");
203         api_ui_item_op_common(func);
204         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
205         RNA_def_property_flag(parm, PROP_REQUIRED);
206         parm= RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
207         RNA_def_property_flag(parm, PROP_REQUIRED);
208
209         func= RNA_def_function(srna, "item_floatO", "uiItemFloatO");
210         api_ui_item_op_common(func);
211         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
212         RNA_def_property_flag(parm, PROP_REQUIRED);
213         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
214         RNA_def_property_flag(parm, PROP_REQUIRED);
215
216         func= RNA_def_function(srna, "item_stringO", "uiItemStringO");
217         api_ui_item_op_common(func);
218         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
219         RNA_def_property_flag(parm, PROP_REQUIRED);
220         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
221         RNA_def_property_flag(parm, PROP_REQUIRED);
222
223         func= RNA_def_function(srna, "itemL", "uiItemL");
224         api_ui_item_common(func);
225
226         func= RNA_def_function(srna, "itemM", "uiItemM");
227         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
228         api_ui_item_common(func);
229         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
230         RNA_def_property_flag(parm, PROP_REQUIRED);
231
232         func= RNA_def_function(srna, "itemS", "uiItemS");
233
234         /* context */
235         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
236         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
237         RNA_def_property_flag(parm, PROP_REQUIRED);
238         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
239         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
240
241         /* templates */
242         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
243         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
244         RNA_def_boolean(func, "menus", 1, "", "The header has menus, and should show menu expander.");
245
246         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
247         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
248         api_ui_item_rna_common(func);
249         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
250         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a file for creating a new ID block.");
251         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
252
253         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
254         parm= RNA_def_pointer(func, "data", "Modifier", "", "Modifier data.");
255         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
256         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
257         RNA_def_function_return(func, parm);
258
259         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
260         parm= RNA_def_pointer(func, "data", "Constraint", "", "Constraint data.");
261         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
262         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
263         RNA_def_function_return(func, parm);
264
265         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
266         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
267         RNA_def_property_flag(parm, PROP_REQUIRED);
268         parm= RNA_def_pointer(func, "parent", "ID", "", "ID datablock.");
269         parm= RNA_def_pointer(func, "slot", "TextureSlot", "", "Texture slot.");
270
271         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
272         parm= RNA_def_pointer(func, "curvemap", "CurveMapping", "", "Curve mapping pointer.");
273         RNA_def_property_flag(parm, PROP_REQUIRED);
274         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
275         RNA_def_boolean(func, "compact", 0, "", "Use more compact curve mapping.");
276
277         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
278         parm= RNA_def_pointer(func, "ramp", "ColorRamp", "", "Color ramp pointer.");
279         RNA_def_property_flag(parm, PROP_REQUIRED);
280         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
281         
282         func= RNA_def_function(srna, "template_layers", "uiTemplateLayers");
283         api_ui_item_rna_common(func);
284         
285         func= RNA_def_function(srna, "template_triColorSet", "uiTemplateTriColorSet");
286         api_ui_item_rna_common(func);
287
288         func= RNA_def_function(srna, "template_image_layers", "uiTemplateImageLayers");
289         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
290         parm= RNA_def_pointer(func, "image", "Image", "", "");
291         RNA_def_property_flag(parm, PROP_REQUIRED);
292         parm= RNA_def_pointer(func, "image_user", "ImageUser", "", "");
293         RNA_def_property_flag(parm, PROP_REQUIRED);
294
295         func= RNA_def_function(srna, "template_list", "uiTemplateList");
296         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
297         api_ui_item_rna_common(func);
298         parm= RNA_def_pointer(func, "active_data", "AnyType", "", "Data from which to take property for the active element.");
299         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
300         parm= RNA_def_string(func, "active_property", "", 0, "", "Identifier of property in data, for the active element.");
301         RNA_def_property_flag(parm, PROP_REQUIRED);
302         parm= RNA_def_int(func, "rows", 5, 0, INT_MAX, "", "Number of rows to display.", 0, INT_MAX);
303         parm= RNA_def_enum(func, "type", list_type_items, 0, "Type", "Type of list to use.");
304         parm= RNA_def_collection(func, "items", 0, "", "Items visible in the list.");
305         RNA_def_function_return(func, parm);
306
307         func= RNA_def_function(srna, "template_running_jobs", "uiTemplateRunningJobs");
308         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
309
310         func= RNA_def_function(srna, "template_operator_search", "uiTemplateOperatorSearch");
311
312         func= RNA_def_function(srna, "template_header_3D", "uiTemplateHeader3D");
313         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
314
315         func= RNA_def_function(srna, "view3d_select_faceselmenu", "uiTemplate_view3d_select_faceselmenu");
316         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
317
318         func= RNA_def_function(srna, "template_texture_image", "uiTemplateTextureImage");
319         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
320         parm= RNA_def_pointer(func, "texture", "Texture", "", "");
321         RNA_def_property_flag(parm, PROP_REQUIRED);
322 }
323
324 #endif
325