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