more ui api changes.
[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, int icon_only, int event, int full_event)
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         flag |= (icon_only)? UI_ITEM_R_ICON_ONLY: 0;
48         flag |= (event)? UI_ITEM_R_EVENT: 0;
49         flag |= (full_event)? UI_ITEM_R_FULL_EVENT: 0;
50         
51         uiItemR(layout, name, icon, ptr, propname, flag);
52 }
53
54 static PointerRNA rna_uiItemO(uiLayout *layout, char *name, int icon, char *opname)
55 {
56         return uiItemFullO(layout, name, icon, opname, NULL, uiLayoutGetOperatorContext(layout), UI_ITEM_O_RETURN_PROPS);
57 }
58
59 #else
60
61 #define DEF_ICON(name) {name, #name, 0, #name, ""},
62 static EnumPropertyItem icon_items[] = {
63 #include "UI_icons.h"
64                 {0, NULL, 0, NULL, NULL}};
65 #undef DEF_ICON
66
67 static void api_ui_item_common(FunctionRNA *func)
68 {
69         PropertyRNA *prop;
70
71         RNA_def_string(func, "text", "", 0, "", "Override automatic text of the item.");
72
73         prop= RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
74         RNA_def_property_enum_items(prop, icon_items);
75         RNA_def_property_ui_text(prop, "Icon", "Override automatic icon of the item.");
76
77 }
78
79 static void api_ui_item_op_common(FunctionRNA *func)
80 {
81         PropertyRNA *parm;
82
83         api_ui_item_common(func);
84         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
85         RNA_def_property_flag(parm, PROP_REQUIRED);
86 }
87
88 static void api_ui_item_rna_common(FunctionRNA *func)
89 {
90         PropertyRNA *parm;
91
92         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
93         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
94         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
95         RNA_def_property_flag(parm, PROP_REQUIRED);
96 }
97
98 void RNA_api_ui_layout(StructRNA *srna)
99 {
100         FunctionRNA *func;
101         PropertyRNA *parm;
102
103         static EnumPropertyItem curve_type_items[] = {
104                 {0, "NONE", 0, "None", ""},
105                 {'v', "VECTOR", 0, "Vector", ""},
106                 {'c', "COLOR", 0, "Color", ""},
107                 {0, NULL, 0, NULL, NULL}};
108         
109         static EnumPropertyItem list_type_items[] = {
110                 {0, "DEFAULT", 0, "None", ""},
111                 {'c', "COMPACT", 0, "Compact", ""},
112                 {'i', "ICONS", 0, "Icons", ""},
113                 {0, NULL, 0, NULL, NULL}};
114
115         /* simple layout specifiers */
116         func= RNA_def_function(srna, "row", "uiLayoutRow");
117         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
118         RNA_def_function_return(func, parm);
119         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
120
121         func= RNA_def_function(srna, "column", "uiLayoutColumn");
122         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
123         RNA_def_function_return(func, parm);
124         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
125
126         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
127         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
128         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
129         RNA_def_function_return(func, parm);
130         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
131
132         /* box layout */
133         func= RNA_def_function(srna, "box", "uiLayoutBox");
134         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
135         RNA_def_function_return(func, parm);
136
137         /* split layout */
138         func= RNA_def_function(srna, "split", "uiLayoutSplit");
139         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
140         RNA_def_function_return(func, parm);
141         RNA_def_float(func, "percentage", 0.0f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
142
143         /* items */
144         func= RNA_def_function(srna, "prop", "rna_uiItemR");
145         api_ui_item_common(func);
146         api_ui_item_rna_common(func);
147         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
148         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
149         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
150         RNA_def_boolean(func, "icon_only", 0, "", "Draw only icons in buttons, no text.");
151         RNA_def_boolean(func, "event", 0, "", "Use button to input key events.");
152         RNA_def_boolean(func, "full_event", 0, "", "Use button to input full events including modifiers.");
153
154         func= RNA_def_function(srna, "props_enum", "uiItemsEnumR");
155         api_ui_item_rna_common(func);
156
157         func= RNA_def_function(srna, "prop_menu_enum", "uiItemMenuEnumR");
158         api_ui_item_common(func);
159         api_ui_item_rna_common(func);
160
161         func= RNA_def_function(srna, "prop_enum", "uiItemEnumR_string");
162         api_ui_item_common(func);
163         api_ui_item_rna_common(func);
164         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
165         RNA_def_property_flag(parm, PROP_REQUIRED);
166
167         func= RNA_def_function(srna, "prop_object", "uiItemPointerR");
168         api_ui_item_common(func);
169         api_ui_item_rna_common(func);
170         parm= RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in.");
171         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
172         parm= RNA_def_string(func, "search_property", "", 0, "", "Identifier of search collection property.");
173         RNA_def_property_flag(parm, PROP_REQUIRED);
174
175         func= RNA_def_function(srna, "operator", "rna_uiItemO");
176         api_ui_item_op_common(func);
177         parm= RNA_def_pointer(func, "properties", "OperatorProperties", "", "Operator properties to fill in, return when 'properties' is set to true.");
178         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
179         RNA_def_function_return(func, parm);
180
181 /*      func= RNA_def_function(srna, "operator_enum", "uiItemEnumO_string");
182         api_ui_item_op_common(func);
183         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
184         RNA_def_property_flag(parm, PROP_REQUIRED);
185         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
186         RNA_def_property_flag(parm, PROP_REQUIRED); */
187
188         func= RNA_def_function(srna, "operator_enums", "uiItemsEnumO");
189         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
190         RNA_def_property_flag(parm, PROP_REQUIRED);
191         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
192         RNA_def_property_flag(parm, PROP_REQUIRED);
193
194         func= RNA_def_function(srna, "operator_menu_enum", "uiItemMenuEnumO");
195         api_ui_item_op_common(func);
196         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
197         RNA_def_property_flag(parm, PROP_REQUIRED);
198
199 /*      func= RNA_def_function(srna, "operator_boolean", "uiItemBooleanO");
200         api_ui_item_op_common(func);
201         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
202         RNA_def_property_flag(parm, PROP_REQUIRED);
203         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
204         RNA_def_property_flag(parm, PROP_REQUIRED); */
205
206 /*      func= RNA_def_function(srna, "operator_int", "uiItemIntO");
207         api_ui_item_op_common(func);
208         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
209         RNA_def_property_flag(parm, PROP_REQUIRED);
210         parm= RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
211         RNA_def_property_flag(parm, PROP_REQUIRED); */
212
213 /*      func= RNA_def_function(srna, "operator_float", "uiItemFloatO");
214         api_ui_item_op_common(func);
215         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
216         RNA_def_property_flag(parm, PROP_REQUIRED);
217         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
218         RNA_def_property_flag(parm, PROP_REQUIRED); */
219
220 /*      func= RNA_def_function(srna, "operator_string", "uiItemStringO");
221         api_ui_item_op_common(func);
222         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
223         RNA_def_property_flag(parm, PROP_REQUIRED);
224         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
225         RNA_def_property_flag(parm, PROP_REQUIRED); */
226
227         func= RNA_def_function(srna, "label", "uiItemL");
228         api_ui_item_common(func);
229
230         func= RNA_def_function(srna, "menu", "uiItemM");
231         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
232         api_ui_item_common(func);
233         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
234         RNA_def_property_flag(parm, PROP_REQUIRED);
235
236         func= RNA_def_function(srna, "separator", "uiItemS");
237
238         /* context */
239         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
240         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
241         RNA_def_property_flag(parm, PROP_REQUIRED);
242         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
243         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
244
245         /* templates */
246         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
247         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
248         RNA_def_boolean(func, "menus", 1, "", "The header has menus, and should show menu expander.");
249
250         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
251         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
252         api_ui_item_rna_common(func);
253         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
254         RNA_def_string(func, "open", "", 0, "", "Operator identifier to open a file for creating a new ID block.");
255         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
256         
257         func= RNA_def_function(srna, "template_any_ID", "uiTemplateAnyID");
258         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
259         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
260         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
261         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
262         RNA_def_property_flag(parm, PROP_REQUIRED);
263         parm= RNA_def_string(func, "type_property", "", 0, "", "Identifier of property in data giving the type of the ID-blocks to use.");
264         RNA_def_property_flag(parm, PROP_REQUIRED);
265         parm= RNA_def_string(func, "text", "", 0, "", "Custom label to display in UI.");
266         
267         func= RNA_def_function(srna, "template_path_builder", "uiTemplatePathBuilder");
268         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
269         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
270         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
271         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
272         RNA_def_property_flag(parm, PROP_REQUIRED);
273         parm= RNA_def_pointer(func, "root", "ID", "", "ID-block from which path is evaluated from.");
274         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
275         parm= RNA_def_string(func, "text", "", 0, "", "Custom label to display in UI.");
276         
277         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
278         parm= RNA_def_pointer(func, "data", "Modifier", "", "Modifier data.");
279         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
280         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
281         RNA_def_function_return(func, parm);
282
283         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
284         parm= RNA_def_pointer(func, "data", "Constraint", "", "Constraint data.");
285         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
286         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
287         RNA_def_function_return(func, parm);
288
289         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
290         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
291         RNA_def_property_flag(parm, PROP_REQUIRED);
292         RNA_def_pointer(func, "parent", "ID", "", "ID datablock.");
293         RNA_def_pointer(func, "slot", "TextureSlot", "", "Texture slot.");
294
295         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
296         api_ui_item_rna_common(func);
297         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
298         RNA_def_boolean(func, "levels", 0, "", "Show black/white levels.");
299
300         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
301         api_ui_item_rna_common(func);
302         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
303         
304         func= RNA_def_function(srna, "template_layers", "uiTemplateLayers");
305         api_ui_item_rna_common(func);
306         
307         func= RNA_def_function(srna, "template_triColorSet", "uiTemplateTriColorSet");
308         api_ui_item_rna_common(func);
309
310         func= RNA_def_function(srna, "template_image_layers", "uiTemplateImageLayers");
311         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
312         parm= RNA_def_pointer(func, "image", "Image", "", "");
313         RNA_def_property_flag(parm, PROP_REQUIRED);
314         parm= RNA_def_pointer(func, "image_user", "ImageUser", "", "");
315         RNA_def_property_flag(parm, PROP_REQUIRED);
316
317         func= RNA_def_function(srna, "template_image", "uiTemplateImage");
318         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
319         api_ui_item_rna_common(func);
320         parm= RNA_def_pointer(func, "image_user", "ImageUser", "", "");
321         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
322         RNA_def_boolean(func, "compact", 0, "", "Use more compact layout.");
323
324         func= RNA_def_function(srna, "template_list", "uiTemplateList");
325         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
326         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
327         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
328         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
329         RNA_def_property_flag(parm, PROP_REQUIRED);
330         parm= RNA_def_pointer(func, "active_data", "AnyType", "", "Data from which to take property for the active element.");
331         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR|PROP_NEVER_NULL);
332         parm= RNA_def_string(func, "active_property", "", 0, "", "Identifier of property in data, for the active element.");
333         RNA_def_property_flag(parm, PROP_REQUIRED);
334         parm= RNA_def_int(func, "rows", 5, 0, INT_MAX, "", "Number of rows to display.", 0, INT_MAX);
335         parm= RNA_def_enum(func, "type", list_type_items, 0, "Type", "Type of list to use.");
336
337         func= RNA_def_function(srna, "template_running_jobs", "uiTemplateRunningJobs");
338         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
339
340         func= RNA_def_function(srna, "template_operator_search", "uiTemplateOperatorSearch");
341
342         func= RNA_def_function(srna, "template_header_3D", "uiTemplateHeader3D");
343         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
344 }
345 #endif
346