Stamp info back only for float buffer. (next commit add unsigned char).
[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         static EnumPropertyItem list_type_items[] = {
91                 {0, "DEFAULT", 0, "None", ""},
92                 {'c', "COMPACT", 0, "Compact", ""},
93                 {'i', "ICONS", 0, "Icons", ""},
94                 {0, NULL, 0, NULL, NULL}};
95
96         /* simple layout specifiers */
97         func= RNA_def_function(srna, "row", "uiLayoutRow");
98         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
99         RNA_def_function_return(func, parm);
100         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
101
102         func= RNA_def_function(srna, "column", "uiLayoutColumn");
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         func= RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
108         parm= RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic.", 0, INT_MAX);
109         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
110         RNA_def_function_return(func, parm);
111         RNA_def_boolean(func, "align", 0, "", "Align buttons to each other.");
112
113         /* box layout */
114         func= RNA_def_function(srna, "box", "uiLayoutBox");
115         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
116         RNA_def_function_return(func, parm);
117
118         /* split layout */
119         func= RNA_def_function(srna, "split", "uiLayoutSplit");
120         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
121         RNA_def_function_return(func, parm);
122         RNA_def_float(func, "percentage", 0.0f, 0.0f, 1.0f, "Percentage", "Percentage of width to split at.", 0.0f, 1.0f);
123
124         /* items */
125         func= RNA_def_function(srna, "itemR", "uiItemR");
126         api_ui_item_common(func);
127         api_ui_item_rna_common(func);
128         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
129         RNA_def_boolean(func, "slider", 0, "", "Use slider widget for numeric values.");
130         RNA_def_boolean(func, "toggle", 0, "", "Use toggle widget for boolean values.");
131
132         func= RNA_def_function(srna, "items_enumR", "uiItemsEnumR");
133         api_ui_item_rna_common(func);
134
135         func= RNA_def_function(srna, "item_menu_enumR", "uiItemMenuEnumR");
136         api_ui_item_common(func);
137         api_ui_item_rna_common(func);
138
139         func= RNA_def_function(srna, "item_enumR", "uiItemEnumR_string");
140         api_ui_item_common(func);
141         api_ui_item_rna_common(func);
142         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
143         RNA_def_property_flag(parm, PROP_REQUIRED);
144
145         func= RNA_def_function(srna, "item_pointerR", "uiItemPointerR");
146         api_ui_item_common(func);
147         api_ui_item_rna_common(func);
148         parm= RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in.");
149         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
150         parm= RNA_def_string(func, "search_property", "", 0, "", "Identifier of search collection property.");
151         RNA_def_property_flag(parm, PROP_REQUIRED);
152
153         func= RNA_def_function(srna, "itemO", "uiItemO");
154         api_ui_item_op_common(func);
155
156         func= RNA_def_function(srna, "item_enumO", "uiItemEnumO_string");
157         api_ui_item_op_common(func);
158         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
159         RNA_def_property_flag(parm, PROP_REQUIRED);
160         parm= RNA_def_string(func, "value", "", 0, "", "Enum property value.");
161         RNA_def_property_flag(parm, PROP_REQUIRED);
162
163         func= RNA_def_function(srna, "items_enumO", "uiItemsEnumO");
164         parm= RNA_def_string(func, "operator", "", 0, "", "Identifier of the operator.");
165         RNA_def_property_flag(parm, PROP_REQUIRED);
166         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
167         RNA_def_property_flag(parm, PROP_REQUIRED);
168
169         func= RNA_def_function(srna, "item_menu_enumO", "uiItemMenuEnumO");
170         api_ui_item_op_common(func);
171         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
172         RNA_def_property_flag(parm, PROP_REQUIRED);
173
174         func= RNA_def_function(srna, "item_booleanO", "uiItemBooleanO");
175         api_ui_item_op_common(func);
176         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
177         RNA_def_property_flag(parm, PROP_REQUIRED);
178         parm= RNA_def_boolean(func, "value", 0, "", "Value of the property to call the operator with.");
179         RNA_def_property_flag(parm, PROP_REQUIRED);
180
181         func= RNA_def_function(srna, "item_intO", "uiItemIntO");
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_int(func, "value", 0, INT_MIN, INT_MAX, "", "Value of the property to call the operator with.", INT_MIN, INT_MAX);
186         RNA_def_property_flag(parm, PROP_REQUIRED);
187
188         func= RNA_def_function(srna, "item_floatO", "uiItemFloatO");
189         api_ui_item_op_common(func);
190         parm= RNA_def_string(func, "property", "", 0, "", "Identifier of property in operator.");
191         RNA_def_property_flag(parm, PROP_REQUIRED);
192         parm= RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "", "Value of the property to call the operator with.", -FLT_MAX, FLT_MAX);
193         RNA_def_property_flag(parm, PROP_REQUIRED);
194
195         func= RNA_def_function(srna, "item_stringO", "uiItemStringO");
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_string(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, "itemL", "uiItemL");
203         api_ui_item_common(func);
204
205         func= RNA_def_function(srna, "itemM", "uiItemM");
206         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
207         api_ui_item_common(func);
208         parm= RNA_def_string(func, "menu", "", 0, "", "Identifier of the menu.");
209         RNA_def_property_flag(parm, PROP_REQUIRED);
210
211         func= RNA_def_function(srna, "itemS", "uiItemS");
212
213         /* context */
214         func= RNA_def_function(srna, "set_context_pointer", "uiLayoutSetContextPointer");
215         parm= RNA_def_string(func, "name", "", 0, "Name", "Name of entry in the context.");
216         RNA_def_property_flag(parm, PROP_REQUIRED);
217         parm= RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context.");
218         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
219
220         /* templates */
221         func= RNA_def_function(srna, "template_header", "uiTemplateHeader");
222         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
223         RNA_def_boolean(func, "menus", 1, "", "The header has menus, and should show menu expander.");
224
225         func= RNA_def_function(srna, "template_ID", "uiTemplateID");
226         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
227         api_ui_item_rna_common(func);
228         RNA_def_string(func, "new", "", 0, "", "Operator identifier to create a new ID block.");
229         RNA_def_string(func, "unlink", "", 0, "", "Operator identifier to unlink the ID block.");
230
231         func= RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
232         parm= RNA_def_pointer(func, "data", "Modifier", "", "Modifier data.");
233         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
234         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
235         RNA_def_function_return(func, parm);
236
237         func= RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
238         parm= RNA_def_pointer(func, "data", "Constraint", "", "Constraint data.");
239         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
240         parm= RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in.");
241         RNA_def_function_return(func, parm);
242
243         func= RNA_def_function(srna, "template_preview", "uiTemplatePreview");
244         parm= RNA_def_pointer(func, "id", "ID", "", "ID datablock.");
245         RNA_def_property_flag(parm, PROP_REQUIRED);
246         parm= RNA_def_pointer(func, "parent", "ID", "", "ID datablock.");
247
248         func= RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
249         parm= RNA_def_pointer(func, "curvemap", "CurveMapping", "", "Curve mapping pointer.");
250         RNA_def_property_flag(parm, PROP_REQUIRED);
251         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display.");
252         RNA_def_boolean(func, "compact", 0, "", "Use more compact curve mapping.");
253
254         func= RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
255         parm= RNA_def_pointer(func, "ramp", "ColorRamp", "", "Color ramp pointer.");
256         RNA_def_property_flag(parm, PROP_REQUIRED);
257         RNA_def_boolean(func, "expand", 0, "", "Expand button to show more detail.");
258         
259         func= RNA_def_function(srna, "template_layers", "uiTemplateLayers");
260         api_ui_item_rna_common(func);
261         
262         func= RNA_def_function(srna, "template_triColorSet", "uiTemplateTriColorSet");
263         api_ui_item_rna_common(func);
264
265         func= RNA_def_function(srna, "template_image_layers", "uiTemplateImageLayers");
266         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
267         parm= RNA_def_pointer(func, "image", "Image", "", "");
268         RNA_def_property_flag(parm, PROP_REQUIRED);
269         parm= RNA_def_pointer(func, "image_user", "ImageUser", "", "");
270         RNA_def_property_flag(parm, PROP_REQUIRED);
271
272         func= RNA_def_function(srna, "template_list", "uiTemplateList");
273         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
274         api_ui_item_rna_common(func);
275         parm= RNA_def_pointer(func, "active_data", "AnyType", "", "Data from which to take property for the active element.");
276         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_RNAPTR);
277         parm= RNA_def_string(func, "active_property", "", 0, "", "Identifier of property in data, for the active element.");
278         RNA_def_property_flag(parm, PROP_REQUIRED);
279         parm= RNA_def_int(func, "rows", 5, 0, INT_MAX, "", "Number of rows to display.", 0, INT_MAX);
280         parm= RNA_def_enum(func, "type", list_type_items, 0, "Type", "Type of list to use.");
281         parm= RNA_def_collection(func, "items", 0, "", "Items visible in the list.");
282         RNA_def_function_return(func, parm);
283
284         func= RNA_def_function(srna, "template_running_jobs", "uiTemplateRunningJobs");
285         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
286
287         func= RNA_def_function(srna, "template_operator_search", "uiTemplateOperatorSearch");
288
289         func= RNA_def_function(srna, "template_header_3D", "uiTemplateHeader3D");
290         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
291
292         func= RNA_def_function(srna, "view3d_select_metaballmenu", "uiTemplate_view3d_select_metaballmenu");
293         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
294         func= RNA_def_function(srna, "view3d_select_armaturemenu", "uiTemplate_view3d_select_armaturemenu");
295         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
296         func= RNA_def_function(srna, "view3d_select_posemenu", "uiTemplate_view3d_select_posemenu");
297         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
298         func= RNA_def_function(srna, "view3d_select_faceselmenu", "uiTemplate_view3d_select_faceselmenu");
299         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
300
301         func= RNA_def_function(srna, "template_texture_image", "uiTemplateTextureImage");
302         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
303         parm= RNA_def_pointer(func, "texture", "Texture", "", "");
304         RNA_def_property_flag(parm, PROP_REQUIRED);
305 }
306
307 #endif
308