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