added missing files identified by jmsoler
[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 #else
41
42 #define DEF_ICON(name) {name, #name, 0, #name, ""},
43 static EnumPropertyItem icon_items[] = {
44 #include "UI_icons.h"
45                 {0, NULL, 0, NULL, NULL}};
46 #undef DEF_ICON
47
48 static void api_ui_item_common(FunctionRNA *func)
49 {
50         PropertyRNA *prop;
51
52         RNA_def_string(func, "text", "", 0, "", "Override automatic text of the item.");
53
54         prop= RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
55         RNA_def_property_enum_items(prop, icon_items);
56         RNA_def_property_ui_text(prop, "Icon", "Override automatic icon of the item.");
57
58 }
59
60 static void api_ui_item_op_common(FunctionRNA *func)
61 {
62         PropertyRNA *parm;
63
64         api_ui_item_common(func);
65         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
66         RNA_def_property_flag(parm, PROP_REQUIRED);
67 }
68
69 static void api_ui_item_rna_common(FunctionRNA *func)
70 {
71         PropertyRNA *parm;
72
73         parm= RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property.");
74         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
75         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in data.");
76         RNA_def_property_flag(parm, PROP_REQUIRED);
77 }
78
79 void RNA_api_ui_layout(StructRNA *srna)
80 {
81         FunctionRNA *func;
82         PropertyRNA *parm;
83
84         static EnumPropertyItem curve_type_items[] = {
85                 {0, "NONE", 0, "None", ""},
86                 {'v', "VECTOR", 0, "Vector", ""},
87                 {'c', "COLOR", 0, "Color", ""},
88                 {0, NULL, 0, NULL, NULL}};
89
90         /* simple layout specifiers */
91         func= RNA_def_function(srna, "row", "uiLayoutRow");
92         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
93         RNA_def_function_return(func, parm);
94         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
95
96         func= RNA_def_function(srna, "column", "uiLayoutColumn");
97         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
98         RNA_def_function_return(func, parm);
99         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
100
101         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
102         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
103         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
104         RNA_def_function_return(func, parm);
105         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
106
107         /* box layout */
108         func= RNA_def_function(srna, "box", "uiLayoutBox");
109         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
110         RNA_def_function_return(func, parm);
111
112         /* split layout */
113         func= RNA_def_function(srna, "split", "uiLayoutSplit");
114         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
115         RNA_def_function_return(func, parm);
116         RNA_def_float(func, "percentage", 0.5f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
117
118         /* items */
119         func= RNA_def_function(srna, "itemR", "uiItemR");
120         api_ui_item_common(func);
121         api_ui_item_rna_common(func);
122         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
123         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
124         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
125
126         func= RNA_def_function(srna, "items_enumR", "uiItemsEnumR");
127         api_ui_item_rna_common(func);
128
129         func= RNA_def_function(srna, "item_menu_enumR", "uiItemMenuEnumR");
130         api_ui_item_common(func);
131         api_ui_item_rna_common(func);
132
133         func= RNA_def_function(srna, "item_enumR", "uiItemEnumR_string");
134         api_ui_item_common(func);
135         api_ui_item_rna_common(func);
136         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
137         RNA_def_property_flag(parm, PROP_REQUIRED);
138
139         func= RNA_def_function(srna, "item_pointerR", "uiItemPointerR");
140         api_ui_item_common(func);
141         api_ui_item_rna_common(func);
142         parm= RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in.");
143         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
144         parm= RNA_def_string(func, "search_property", "", 0, "", "Identifier of search collection property.");
145         RNA_def_property_flag(parm, PROP_REQUIRED);
146
147         func= RNA_def_function(srna, "itemO", "uiItemO");
148         api_ui_item_op_common(func);
149
150         func= RNA_def_function(srna, "item_enumO", "uiItemEnumO_string");
151         api_ui_item_op_common(func);
152         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
153         RNA_def_property_flag(parm, PROP_REQUIRED);
154         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
155         RNA_def_property_flag(parm, PROP_REQUIRED);
156
157         func= RNA_def_function(srna, "items_enumO", "uiItemsEnumO");
158         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
159         RNA_def_property_flag(parm, PROP_REQUIRED);
160         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
161         RNA_def_property_flag(parm, PROP_REQUIRED);
162
163         func= RNA_def_function(srna, "item_menu_enumO", "uiItemMenuEnumO");
164         api_ui_item_op_common(func);
165         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
166         RNA_def_property_flag(parm, PROP_REQUIRED);
167
168         func= RNA_def_function(srna, "item_booleanO", "uiItemBooleanO");
169         api_ui_item_op_common(func);
170         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
171         RNA_def_property_flag(parm, PROP_REQUIRED);
172         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
173         RNA_def_property_flag(parm, PROP_REQUIRED);
174
175         func= RNA_def_function(srna, "item_intO", "uiItemIntO");
176         api_ui_item_op_common(func);
177         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
178         RNA_def_property_flag(parm, PROP_REQUIRED);
179         parm= RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
180         RNA_def_property_flag(parm, PROP_REQUIRED);
181
182         func= RNA_def_function(srna, "item_floatO", "uiItemFloatO");
183         api_ui_item_op_common(func);
184         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
185         RNA_def_property_flag(parm, PROP_REQUIRED);
186         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
187         RNA_def_property_flag(parm, PROP_REQUIRED);
188
189         func= RNA_def_function(srna, "item_stringO", "uiItemStringO");
190         api_ui_item_op_common(func);
191         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
192         RNA_def_property_flag(parm, PROP_REQUIRED);
193         parm= RNA_def_string(func, "value", "", 0, "", "Value of the property to call the operator with.");
194         RNA_def_property_flag(parm, PROP_REQUIRED);
195
196         func= RNA_def_function(srna, "itemL", "uiItemL");
197         api_ui_item_common(func);
198
199         func= RNA_def_function(srna, "itemM", "uiItemM");
200         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
201         api_ui_item_common(func);
202         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
203         RNA_def_property_flag(parm, PROP_REQUIRED);
204
205         func= RNA_def_function(srna, "itemS", "uiItemS");
206
207         /* context */
208         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
209         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
210         RNA_def_property_flag(parm, PROP_REQUIRED);
211         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
212         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
213
214         /* templates */
215         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
216         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
217
218         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
219         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
220         api_ui_item_rna_common(func);
221         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
222         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
223
224         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
225         parm= RNA_def_pointer(func, "data", "Modifier", "", "Modifier data.");
226         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
227         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
228         RNA_def_function_return(func, parm);
229
230         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
231         parm= RNA_def_pointer(func, "data", "Constraint", "", "Constraint data.");
232         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
233         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
234         RNA_def_function_return(func, parm);
235
236         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
237         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
238         RNA_def_property_flag(parm, PROP_REQUIRED);
239
240         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
241         parm= RNA_def_pointer(func, "curvemap", "CurveMapping", "", "Curve mapping pointer.");
242         RNA_def_property_flag(parm, PROP_REQUIRED);
243         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
244
245         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
246         parm= RNA_def_pointer(func, "ramp", "ColorRamp", "", "Color ramp pointer.");
247         RNA_def_property_flag(parm, PROP_REQUIRED);
248         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
249         
250         func= RNA_def_function(srna, "template_layers", "uiTemplateLayers");
251         api_ui_item_rna_common(func);
252
253         func= RNA_def_function(srna, "template_image_layers", "uiTemplateImageLayers");
254         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
255         parm= RNA_def_pointer(func, "image", "Image", "", "");
256         RNA_def_property_flag(parm, PROP_REQUIRED);
257         parm= RNA_def_pointer(func, "image_user", "ImageUser", "", "");
258         RNA_def_property_flag(parm, PROP_REQUIRED);
259
260         func= RNA_def_function(srna, "template_list", "uiTemplateList");
261         api_ui_item_rna_common(func);
262         parm= RNA_def_pointer(func, "active_data", "AnyType", "", "Data from which to take property for the active element.");
263         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
264         parm= RNA_def_string(func, "active_property", "", 0, "", "Identifier of property in data, for the active element.");
265         RNA_def_property_flag(parm, PROP_REQUIRED);
266         parm= RNA_def_int(func, "rows", 5, 0, INT_MAX, "", "Number of rows to display.", 0, INT_MAX);
267         parm= RNA_def_int(func, "columns", 5, 0, INT_MAX, "", "Number of columns to display.", 0, INT_MAX);
268         parm= RNA_def_boolean(func, "compact", 0, "", "Use compact, single row list template.");
269         parm= RNA_def_collection(func, "items", 0, "", "Items visible in the list.");
270         RNA_def_function_return(func, parm);
271
272         func= RNA_def_function(srna, "template_running_jobs", "uiTemplateRunningJobs");
273         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
274
275         func= RNA_def_function(srna, "template_operator_search", "uiTemplateOperatorSearch");
276
277         func= RNA_def_function(srna, "template_header_3D", "uiTemplateHeader3D");
278         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
279 }
280
281 #endif
282