07c4d9c826e1ff2112f8f55b9c74b3961845fa7f
[blender-staging.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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, int icon_only, int event, int full_event, int no_bg, int index)
41 {
42         PropertyRNA *prop= RNA_struct_find_property(ptr, propname);
43         int flag= 0;
44
45         if(!prop) {
46                 printf("rna_uiItemR: property not found: %s\n", propname);
47                 return;
48         }
49
50         flag |= (slider)? UI_ITEM_R_SLIDER: 0;
51         flag |= (expand)? UI_ITEM_R_EXPAND: 0;
52         flag |= (toggle)? UI_ITEM_R_TOGGLE: 0;
53         flag |= (icon_only)? UI_ITEM_R_ICON_ONLY: 0;
54         flag |= (event)? UI_ITEM_R_EVENT: 0;
55         flag |= (full_event)? UI_ITEM_R_FULL_EVENT: 0;
56         flag |= (no_bg)? UI_ITEM_R_NO_BG: 0;
57
58         uiItemFullR(layout, name, icon, ptr, prop, index, 0, flag);
59 }
60
61 static PointerRNA rna_uiItemO(uiLayout *layout, char *name, int icon, char *opname)
62 {
63         return uiItemFullO(layout, name, icon, opname, NULL, uiLayoutGetOperatorContext(layout), UI_ITEM_O_RETURN_PROPS);
64 }
65
66 #else
67
68 #define DEF_ICON(name) {name, (#name)+5, 0, (#name)+5, ""},
69 static EnumPropertyItem icon_items[] = {
70 #include "UI_icons.h"
71                 {0, NULL, 0, NULL, NULL}};
72 #undef DEF_ICON
73
74 static void api_ui_item_common(FunctionRNA *func)
75 {
76         PropertyRNA *prop;
77
78         RNA_def_string(func, "text", "", 0, "", "Override automatic text of the item.");
79
80         prop= RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
81         RNA_def_property_enum_items(prop, icon_items);
82         RNA_def_property_ui_text(prop, "Icon", "Override automatic icon of the item");
83
84 }
85
86 static void api_ui_item_op_common(FunctionRNA *func)
87 {
88         PropertyRNA *parm;
89
90         api_ui_item_common(func);
91         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
92         RNA_def_property_flag(parm, PROP_REQUIRED);
93 }
94
95 static void api_ui_item_rna_common(FunctionRNA *func)
96 {
97         PropertyRNA *parm;
98
99         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
100         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
101         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
102         RNA_def_property_flag(parm, PROP_REQUIRED);
103 }
104
105 void RNA_api_ui_layout(StructRNA *srna)
106 {
107         FunctionRNA *func;
108         PropertyRNA *parm;
109
110         static EnumPropertyItem curve_type_items[] = {
111                 {0, "NONE", 0, "None", ""},
112                 {'v', "VECTOR", 0, "Vector", ""},
113                 {'c', "COLOR", 0, "Color", ""},
114                 {0, NULL, 0, NULL, NULL}};
115         
116         static EnumPropertyItem list_type_items[] = {
117                 {0, "DEFAULT", 0, "None", ""},
118                 {'c', "COMPACT", 0, "Compact", ""},
119                 {'i', "ICONS", 0, "Icons", ""},
120                 {0, NULL, 0, NULL, NULL}};
121
122         /* simple layout specifiers */
123         func= RNA_def_function(srna, "row", "uiLayoutRow");
124         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
125         RNA_def_function_return(func, parm);
126         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
127
128         func= RNA_def_function(srna, "column", "uiLayoutColumn");
129         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
130         RNA_def_function_return(func, parm);
131         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
132
133         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
134         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
135         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
136         RNA_def_function_return(func, parm);
137         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
138
139         /* box layout */
140         func= RNA_def_function(srna, "box", "uiLayoutBox");
141         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
142         RNA_def_function_return(func, parm);
143
144         /* split layout */
145         func= RNA_def_function(srna, "split", "uiLayoutSplit");
146         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
147         RNA_def_function_return(func, parm);
148         RNA_def_float(func, "percentage", 0.0f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
149         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
150
151         /* items */
152         func= RNA_def_function(srna, "prop", "rna_uiItemR");
153         api_ui_item_common(func);
154         api_ui_item_rna_common(func);
155         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
156         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
157         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
158         RNA_def_boolean(func, "icon_only", 0, "", "Draw only icons in buttons, no text.");
159         RNA_def_boolean(func, "event", 0, "", "Use button to input key events.");
160         RNA_def_boolean(func, "full_event", 0, "", "Use button to input full events including modifiers.");
161         RNA_def_boolean(func, "no_bg", 0, "", "Don't draw the button itself, just the icon/text.");
162         RNA_def_int(func, "index", -1, -2, INT_MAX, "", "The index of this button, when set a single member of an array can be accessed, when set to -1 all array members are used.", -2, INT_MAX); /* RNA_NO_INDEX == -1 */
163
164         func= RNA_def_function(srna, "props_enum", "uiItemsEnumR");
165         api_ui_item_rna_common(func);
166
167         func= RNA_def_function(srna, "prop_menu_enum", "uiItemMenuEnumR");
168         api_ui_item_common(func);
169         api_ui_item_rna_common(func);
170
171         func= RNA_def_function(srna, "prop_enum", "uiItemEnumR_string");
172         api_ui_item_common(func);
173         api_ui_item_rna_common(func);
174         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
175         RNA_def_property_flag(parm, PROP_REQUIRED);
176
177         func= RNA_def_function(srna, "prop_object", "uiItemPointerR");
178         api_ui_item_common(func);
179         api_ui_item_rna_common(func);
180         parm= RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in.");
181         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
182         parm= RNA_def_string(func, "search_property", "", 0, "", "Identifier of search collection property.");
183         RNA_def_property_flag(parm, PROP_REQUIRED);
184
185         func= RNA_def_function(srna, "operator", "rna_uiItemO");
186         api_ui_item_op_common(func);
187         parm= RNA_def_pointer(func, "properties", "OperatorProperties", "", "Operator properties to fill in, return when 'properties' is set to true.");
188         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
189         RNA_def_function_return(func, parm);
190
191 /*      func= RNA_def_function(srna, "operator_enum", "uiItemEnumO_string");
192         api_ui_item_op_common(func);
193         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
194         RNA_def_property_flag(parm, PROP_REQUIRED);
195         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
196         RNA_def_property_flag(parm, PROP_REQUIRED); */
197
198         func= RNA_def_function(srna, "operator_enums", "uiItemsEnumO");
199         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
200         RNA_def_property_flag(parm, PROP_REQUIRED);
201         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
202         RNA_def_property_flag(parm, PROP_REQUIRED);
203
204         func= RNA_def_function(srna, "operator_menu_enum", "uiItemMenuEnumO");
205         api_ui_item_op_common(func);
206         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
207         RNA_def_property_flag(parm, PROP_REQUIRED);
208
209 /*      func= RNA_def_function(srna, "operator_boolean", "uiItemBooleanO");
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_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
214         RNA_def_property_flag(parm, PROP_REQUIRED); */
215
216 /*      func= RNA_def_function(srna, "operator_int", "uiItemIntO");
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_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
221         RNA_def_property_flag(parm, PROP_REQUIRED); */
222
223 /*      func= RNA_def_function(srna, "operator_float", "uiItemFloatO");
224         api_ui_item_op_common(func);
225         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
226         RNA_def_property_flag(parm, PROP_REQUIRED);
227         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
228         RNA_def_property_flag(parm, PROP_REQUIRED); */
229
230 /*      func= RNA_def_function(srna, "operator_string", "uiItemStringO");
231         api_ui_item_op_common(func);
232         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
233         RNA_def_property_flag(parm, PROP_REQUIRED);
234         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
235         RNA_def_property_flag(parm, PROP_REQUIRED); */
236
237         func= RNA_def_function(srna, "label", "uiItemL");
238         api_ui_item_common(func);
239
240         func= RNA_def_function(srna, "menu", "uiItemM");
241         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
242         api_ui_item_common(func);
243         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
244         RNA_def_property_flag(parm, PROP_REQUIRED);
245
246         func= RNA_def_function(srna, "separator", "uiItemS");
247
248         /* context */
249         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
250         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
251         RNA_def_property_flag(parm, PROP_REQUIRED);
252         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
253         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
254         
255         /* templates */
256         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
257         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
258         RNA_def_boolean(func, "menus", 1, "", "The header has menus, and should show menu expander.");
259
260         func= RNA_def_function(srna, "template_dopesheet_filter", "uiTemplateDopeSheetFilter");
261         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
262         parm= RNA_def_pointer(func, "dopesheet", "DopeSheet", "", "DopeSheet settings holding filter options.");
263         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
264
265         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
266         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
267         api_ui_item_rna_common(func);
268         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
269         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a file for creating a new ID block.");
270         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
271         
272         func= RNA_def_function(srna, "template_ID_preview", "uiTemplateIDPreview");
273         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
274         api_ui_item_rna_common(func);
275         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
276         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a file for creating a new ID block.");
277         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
278         RNA_def_int(func, "rows", 0, 0, INT_MAX, "Number of thumbnail preview rows to display", "", 0, INT_MAX);
279         RNA_def_int(func, "cols", 0, 0, INT_MAX, "Number of thumbnail preview columns to display", "", 0, INT_MAX);
280         
281         func= RNA_def_function(srna, "template_any_ID", "uiTemplateAnyID");
282         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
283         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
284         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
285         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
286         RNA_def_property_flag(parm, PROP_REQUIRED);
287         parm= RNA_def_string(func, "type_property", "", 0, "", "Identifier of property in data giving the type of the ID-blocks to use.");
288         RNA_def_property_flag(parm, PROP_REQUIRED);
289         parm= RNA_def_string(func, "text", "", 0, "", "Custom label to display in UI.");
290         
291         func= RNA_def_function(srna, "template_path_builder", "uiTemplatePathBuilder");
292         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
293         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
294         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
295         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
296         RNA_def_property_flag(parm, PROP_REQUIRED);
297         parm= RNA_def_pointer(func, "root", "ID", "", "ID-block from which path is evaluated from.");
298         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
299         parm= RNA_def_string(func, "text", "", 0, "", "Custom label to display in UI.");
300         
301         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
302         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
303         parm= RNA_def_pointer(func, "data", "Modifier", "", "Modifier data.");
304         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
305         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
306         RNA_def_function_return(func, parm);
307         RNA_def_boolean(func, "compact", 0, "", "Show a smaller version of the template, split on two lines.");
308
309         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
310         parm= RNA_def_pointer(func, "data", "Constraint", "", "Constraint data.");
311         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
312         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
313         RNA_def_function_return(func, parm);
314
315         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
316         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
317         RNA_def_property_flag(parm, PROP_REQUIRED);
318         RNA_def_pointer(func, "parent", "ID", "", "ID datablock.");
319         RNA_def_pointer(func, "slot", "TextureSlot", "", "Texture slot.");
320
321         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
322         api_ui_item_rna_common(func);
323         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
324         RNA_def_boolean(func, "levels", 0, "", "Show black/white levels.");
325         RNA_def_boolean(func, "brush", 0, "", "Show brush options.");
326
327         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
328         api_ui_item_rna_common(func);
329         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
330         
331         func= RNA_def_function(srna, "template_histogram", "uiTemplateHistogram");
332         api_ui_item_rna_common(func);
333         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
334         
335         func= RNA_def_function(srna, "template_layers", "uiTemplateLayers");
336         api_ui_item_rna_common(func);
337         parm= RNA_def_pointer(func, "used_layers_data", "AnyType", "", "Data from which to take property.");
338         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
339         parm= RNA_def_string(func, "used_layers_property", "", 0, "", "Identifier of property in data.");
340         RNA_def_property_flag(parm, PROP_REQUIRED);
341         parm= RNA_def_int(func, "active_layer", 0, 0, INT_MAX, "Active Layer", "", 0, INT_MAX);
342         RNA_def_property_flag(parm, PROP_REQUIRED);
343         
344         func= RNA_def_function(srna, "template_color_wheel", "uiTemplateColorWheel");
345         api_ui_item_rna_common(func);
346         RNA_def_boolean(func, "value_slider", 0, "", "Display the value slider to the right of the color wheel");
347         RNA_def_boolean(func, "lock", 0, "", "Lock the color wheel display to value 1.0 regardless of actual color");
348         
349         func= RNA_def_function(srna, "template_triColorSet", "uiTemplateTriColorSet");
350         api_ui_item_rna_common(func);
351
352         func= RNA_def_function(srna, "template_image_layers", "uiTemplateImageLayers");
353         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
354         parm= RNA_def_pointer(func, "image", "Image", "", "");
355         RNA_def_property_flag(parm, PROP_REQUIRED);
356         parm= RNA_def_pointer(func, "image_user", "ImageUser", "", "");
357         RNA_def_property_flag(parm, PROP_REQUIRED);
358
359         func= RNA_def_function(srna, "template_image", "uiTemplateImage");
360         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
361         api_ui_item_rna_common(func);
362         parm= RNA_def_pointer(func, "image_user", "ImageUser", "", "");
363         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
364         RNA_def_boolean(func, "compact", 0, "", "Use more compact layout.");
365
366         func= RNA_def_function(srna, "template_list", "uiTemplateList");
367         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
368         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
369         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
370         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
371         RNA_def_property_flag(parm, PROP_REQUIRED);
372         parm= RNA_def_pointer(func, "active_data", "AnyType", "", "Data from which to take property for the active element.");
373         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
374         parm= RNA_def_string(func, "active_property", "", 0, "", "Identifier of property in data, for the active element.");
375         RNA_def_property_flag(parm, PROP_REQUIRED);
376         parm= RNA_def_int(func, "rows", 5, 0, INT_MAX, "", "Number of rows to display.", 0, INT_MAX);
377         parm= RNA_def_int(func, "maxrows", 5, 0, INT_MAX, "", "Maximum number of rows to display.", 0, INT_MAX);
378         parm= RNA_def_enum(func, "type", list_type_items, 0, "Type", "Type of list to use.");
379
380         func= RNA_def_function(srna, "template_running_jobs", "uiTemplateRunningJobs");
381         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
382
383         func= RNA_def_function(srna, "template_operator_search", "uiTemplateOperatorSearch");
384
385         func= RNA_def_function(srna, "template_header_3D", "uiTemplateHeader3D");
386         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
387         
388         func= RNA_def_function(srna, "template_reports_banner", "uiTemplateReportsBanner");
389         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
390         parm= RNA_def_pointer(func, "operator", "Operator", "", "");
391         RNA_def_property_flag(parm, PROP_REQUIRED);
392
393
394
395         func= RNA_def_function(srna, "introspect", "uiLayoutIntrospect");
396         parm= RNA_def_string(func, "string", "", 1024*1024, "Descr", "DESCR");
397         RNA_def_function_return(func, parm);
398 }
399 #endif
400