5b51dacec769dc1dcd7c128d8f8ccf1feb437ff6
[blender.git] / source / blender / makesrna / intern / rna_ui_api.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/makesrna/intern/rna_ui_api.c
28  *  \ingroup RNA
29  */
30
31
32 #include <stdlib.h>
33 #include <stdio.h>
34
35 #include "BLI_utildefines.h"
36
37 #include "BLT_translation.h"
38
39 #include "RNA_define.h"
40 #include "RNA_enum_types.h"
41
42 #include "DNA_screen_types.h"
43
44 #include "UI_resources.h"
45 #include "UI_interface.h"
46 #include "UI_interface_icons.h"
47
48 #include "rna_internal.h"
49
50 #define DEF_ICON(name) {ICON_##name, (#name), 0, (#name), ""},
51 #define DEF_ICON_VECTOR(name) {ICON_##name, (#name), 0, (#name), ""},
52 #define DEF_ICON_COLOR(name) {ICON_##name, (#name), 0, (#name), ""},
53 #define DEF_ICON_BLANK(name)
54 const EnumPropertyItem rna_enum_icon_items[] = {
55 #include "UI_icons.h"
56         {0, NULL, 0, NULL, NULL}
57 };
58
59 #ifdef RNA_RUNTIME
60
61 const char *rna_translate_ui_text(
62         const char *text, const char *text_ctxt, StructRNA *type, PropertyRNA *prop, bool translate)
63 {
64         /* Also return text if UI labels translation is disabled. */
65         if (!text || !text[0] || !translate || !BLT_translate_iface()) {
66                 return text;
67         }
68
69         /* If a text_ctxt is specified, use it! */
70         if (text_ctxt && text_ctxt[0]) {
71                 return BLT_pgettext(text_ctxt, text);
72         }
73
74         /* Else, if an RNA type or property is specified, use its context. */
75 #if 0
76         /* XXX Disabled for now. Unfortunately, their is absolutely no way from py code to get the RNA struct corresponding
77          *     to the 'data' (in functions like prop() & co), as this is pure runtime data. Hence, messages extraction
78          *     script can't determine the correct context it should use for such 'text' messages...
79          *     So for now, one have to explicitly specify the 'text_ctxt' when using prop() etc. functions,
80          *     if default context is not suitable.
81          */
82         if (prop) {
83                 return BLT_pgettext(RNA_property_translation_context(prop), text);
84         }
85 #else
86         (void)prop;
87 #endif
88         if (type) {
89                 return BLT_pgettext(RNA_struct_translation_context(type), text);
90         }
91
92         /* Else, default context! */
93         return BLT_pgettext(BLT_I18NCONTEXT_DEFAULT, text);
94 }
95
96 static void rna_uiItemR(
97         uiLayout *layout, PointerRNA *ptr, const char *propname, const char *name, const char *text_ctxt,
98         bool translate, int icon, bool expand, bool slider, bool toggle, bool icon_only, bool event,
99         bool full_event, bool emboss, int index, int icon_value)
100 {
101         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
102         int flag = 0;
103
104         if (!prop) {
105                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
106                 return;
107         }
108
109         if (icon_value && !icon) {
110                 icon = icon_value;
111         }
112
113         /* Get translated name (label). */
114         name = rna_translate_ui_text(name, text_ctxt, NULL, prop, translate);
115
116         flag |= (slider) ? UI_ITEM_R_SLIDER : 0;
117         flag |= (expand) ? UI_ITEM_R_EXPAND : 0;
118         flag |= (toggle) ? UI_ITEM_R_TOGGLE : 0;
119         flag |= (icon_only) ? UI_ITEM_R_ICON_ONLY : 0;
120         flag |= (event) ? UI_ITEM_R_EVENT : 0;
121         flag |= (full_event) ? UI_ITEM_R_FULL_EVENT : 0;
122         flag |= (emboss) ? 0 : UI_ITEM_R_NO_BG;
123
124         uiItemFullR(layout, ptr, prop, index, 0, flag, name, icon);
125 }
126
127 static void rna_uiItemMenuEnumR(
128         uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name,
129         const char *text_ctxt, bool translate, int icon)
130 {
131         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
132
133         if (!prop) {
134                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
135                 return;
136         }
137
138         /* Get translated name (label). */
139         name = rna_translate_ui_text(name, text_ctxt, NULL, prop, translate);
140         uiItemMenuEnumR_prop(layout, ptr, prop, name, icon);
141 }
142
143 static void rna_uiItemTabsEnumR(
144         uiLayout *layout, bContext *C,
145         struct PointerRNA *ptr, const char *propname,
146         bool icon_only)
147 {
148         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
149
150         if (!prop) {
151                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
152                 return;
153         }
154         if (RNA_property_type(prop) != PROP_ENUM) {
155                 RNA_warning("property is not an enum: %s.%s", RNA_struct_identifier(ptr->type), propname);
156                 return;
157         }
158
159         uiItemTabsEnumR_prop(layout, C, ptr, prop, icon_only);
160 }
161
162 static void rna_uiItemEnumR_string(
163         uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *value,
164         const char *name, const char *text_ctxt, bool translate, int icon)
165 {
166         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
167
168         if (!prop) {
169                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
170                 return;
171         }
172
173         /* Get translated name (label). */
174         name = rna_translate_ui_text(name, text_ctxt, NULL, prop, translate);
175
176         uiItemEnumR_string_prop(layout, ptr, prop, value, name, icon);
177 }
178
179 static void rna_uiItemPointerR(
180         uiLayout *layout, struct PointerRNA *ptr, const char *propname,
181         struct PointerRNA *searchptr, const char *searchpropname,
182         const char *name, const char *text_ctxt, bool translate, int icon)
183 {
184         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
185         if (!prop) {
186                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
187                 return;
188         }
189         PropertyRNA *searchprop = RNA_struct_find_property(searchptr, searchpropname);
190         if (!searchprop) {
191                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(searchptr->type), searchpropname);
192                 return;
193         }
194
195         /* Get translated name (label). */
196         name = rna_translate_ui_text(name, text_ctxt, NULL, prop, translate);
197
198         uiItemPointerR_prop(layout, ptr, prop, searchptr, searchprop, name, icon);
199 }
200
201 static PointerRNA rna_uiItemO(
202         uiLayout *layout, const char *opname, const char *name, const char *text_ctxt,
203         bool translate, int icon, bool emboss, bool depress, int icon_value)
204 {
205         wmOperatorType *ot;
206
207         ot = WM_operatortype_find(opname, 0); /* print error next */
208         if (!ot || !ot->srna) {
209                 RNA_warning("%s '%s'", ot ? "unknown operator" : "operator missing srna", opname);
210                 return PointerRNA_NULL;
211         }
212
213         /* Get translated name (label). */
214         name = rna_translate_ui_text(name, text_ctxt, ot->srna, NULL, translate);
215
216         if (icon_value && !icon) {
217                 icon = icon_value;
218         }
219         int flag = (emboss) ? 0 : UI_ITEM_R_NO_BG;
220         flag |= (depress) ? UI_ITEM_O_DEPRESS : 0;
221
222         PointerRNA opptr;
223         uiItemFullO_ptr(layout, ot, name, icon, NULL, uiLayoutGetOperatorContext(layout), flag, &opptr);
224         return opptr;
225 }
226
227 static PointerRNA rna_uiItemOMenuHold(
228         uiLayout *layout, const char *opname, const char *name, const char *text_ctxt,
229         bool translate, int icon, bool emboss, bool depress, int icon_value,
230         const char *menu)
231 {
232         wmOperatorType *ot = WM_operatortype_find(opname, 0); /* print error next */
233         if (!ot || !ot->srna) {
234                 RNA_warning("%s '%s'", ot ? "unknown operator" : "operator missing srna", opname);
235                 return PointerRNA_NULL;
236         }
237
238         /* Get translated name (label). */
239         name = rna_translate_ui_text(name, text_ctxt, ot->srna, NULL, translate);
240         if (icon_value && !icon) {
241                 icon = icon_value;
242         }
243         int flag = (emboss) ? 0 : UI_ITEM_R_NO_BG;
244         flag |= (depress) ? UI_ITEM_O_DEPRESS : 0;
245
246         PointerRNA opptr;
247         uiItemFullOMenuHold_ptr(layout, ot, name, icon, NULL, uiLayoutGetOperatorContext(layout), flag, menu, &opptr);
248         return opptr;
249 }
250
251
252 static void rna_uiItemMenuEnumO(
253         uiLayout *layout, bContext *C, const char *opname, const char *propname, const char *name,
254         const char *text_ctxt, bool translate, int icon)
255 {
256         wmOperatorType *ot = WM_operatortype_find(opname, 0); /* print error next */
257
258         if (!ot || !ot->srna) {
259                 RNA_warning("%s '%s'", ot ? "unknown operator" : "operator missing srna", opname);
260                 return;
261         }
262
263         /* Get translated name (label). */
264         name = rna_translate_ui_text(name, text_ctxt, ot->srna, NULL, translate);
265
266         uiItemMenuEnumO_ptr(layout, C, ot, propname, name, icon);
267 }
268
269 static void rna_uiItemL(
270         uiLayout *layout, const char *name, const char *text_ctxt, bool translate,
271         int icon, int icon_value)
272 {
273         /* Get translated name (label). */
274         name = rna_translate_ui_text(name, text_ctxt, NULL, NULL, translate);
275
276         if (icon_value && !icon) {
277                 icon = icon_value;
278         }
279
280         uiItemL(layout, name, icon);
281 }
282
283 static void rna_uiItemM(
284         uiLayout *layout, const char *menuname, const char *name, const char *text_ctxt,
285         bool translate, int icon, int icon_value)
286 {
287         /* Get translated name (label). */
288         name = rna_translate_ui_text(name, text_ctxt, NULL, NULL, translate);
289
290         if (icon_value && !icon) {
291                 icon = icon_value;
292         }
293
294         uiItemM(layout, menuname, name, icon);
295 }
296
297 static void rna_uiItemPopoverPanel(
298         uiLayout *layout, bContext *C,
299         const char *panel_type, const char *name, const char *text_ctxt,
300         bool translate, int icon, int icon_value)
301 {
302         /* Get translated name (label). */
303         name = rna_translate_ui_text(name, text_ctxt, NULL, NULL, translate);
304
305         if (icon_value && !icon) {
306                 icon = icon_value;
307         }
308
309         uiItemPopoverPanel(layout, C, panel_type, name, icon);
310 }
311
312 static void rna_uiItemPopoverPanelFromGroup(
313         uiLayout *layout, bContext *C,
314         int space_id, int region_id, const char *context, const char *category)
315 {
316         uiItemPopoverPanelFromGroup(layout, C, space_id, region_id, context, category);
317 }
318
319 static void rna_uiTemplateAnyID(
320         uiLayout *layout, PointerRNA *ptr, const char *propname, const char *proptypename,
321         const char *name, const char *text_ctxt, bool translate)
322 {
323         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
324
325         if (!prop) {
326                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
327                 return;
328         }
329
330         /* Get translated name (label). */
331         name = rna_translate_ui_text(name, text_ctxt, NULL, prop, translate);
332
333         /* XXX This will search property again :( */
334         uiTemplateAnyID(layout, ptr, propname, proptypename, name);
335 }
336
337 static void rna_uiTemplatePathBuilder(
338         uiLayout *layout, PointerRNA *ptr, const char *propname, PointerRNA *root_ptr,
339         const char *name, const char *text_ctxt, bool translate)
340 {
341         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
342
343         if (!prop) {
344                 RNA_warning("property not found: %s.%s", RNA_struct_identifier(ptr->type), propname);
345                 return;
346         }
347
348         /* Get translated name (label). */
349         name = rna_translate_ui_text(name, text_ctxt, NULL, prop, translate);
350
351         /* XXX This will search property again :( */
352         uiTemplatePathBuilder(layout, ptr, propname, root_ptr, name);
353 }
354
355 static int rna_ui_get_rnaptr_icon(bContext *C, PointerRNA *ptr_icon)
356 {
357         return UI_rnaptr_icon_get(C, ptr_icon, RNA_struct_ui_icon(ptr_icon->type), false);
358 }
359
360 static const char *rna_ui_get_enum_name(bContext *C, PointerRNA *ptr, const char *propname, const char *identifier)
361 {
362         PropertyRNA *prop = NULL;
363         const EnumPropertyItem *items = NULL, *item;
364         bool free;
365         const char *name = "";
366
367         prop = RNA_struct_find_property(ptr, propname);
368         if (!prop || (RNA_property_type(prop) != PROP_ENUM)) {
369                 RNA_warning("Property not found or not an enum: %s.%s", RNA_struct_identifier(ptr->type), propname);
370                 return name;
371         }
372
373         RNA_property_enum_items_gettexted(C, ptr, prop, &items, NULL, &free);
374
375         if (items) {
376                 for (item = items; item->identifier; item++) {
377                         if (item->identifier[0] && STREQ(item->identifier, identifier)) {
378                                 name = item->name;
379                                 break;
380                         }
381                 }
382                 if (free) {
383                         MEM_freeN((void *)items);
384                 }
385         }
386
387         return name;
388 }
389
390 static const char *rna_ui_get_enum_description(
391         bContext *C, PointerRNA *ptr, const char *propname,
392         const char *identifier)
393 {
394         PropertyRNA *prop = NULL;
395         const EnumPropertyItem *items = NULL, *item;
396         bool free;
397         const char *desc = "";
398
399         prop = RNA_struct_find_property(ptr, propname);
400         if (!prop || (RNA_property_type(prop) != PROP_ENUM)) {
401                 RNA_warning("Property not found or not an enum: %s.%s", RNA_struct_identifier(ptr->type), propname);
402                 return desc;
403         }
404
405         RNA_property_enum_items_gettexted(C, ptr, prop, &items, NULL, &free);
406
407         if (items) {
408                 for (item = items; item->identifier; item++) {
409                         if (item->identifier[0] && STREQ(item->identifier, identifier)) {
410                                 desc = item->description;
411                                 break;
412                         }
413                 }
414                 if (free) {
415                         MEM_freeN((void *)items);
416                 }
417         }
418
419         return desc;
420 }
421
422 static int rna_ui_get_enum_icon(bContext *C, PointerRNA *ptr, const char *propname, const char *identifier)
423 {
424         PropertyRNA *prop = NULL;
425         const EnumPropertyItem *items = NULL, *item;
426         bool free;
427         int icon = ICON_NONE;
428
429         prop = RNA_struct_find_property(ptr, propname);
430         if (!prop || (RNA_property_type(prop) != PROP_ENUM)) {
431                 RNA_warning("Property not found or not an enum: %s.%s", RNA_struct_identifier(ptr->type), propname);
432                 return icon;
433         }
434
435         RNA_property_enum_items(C, ptr, prop, &items, NULL, &free);
436
437         if (items) {
438                 for (item = items; item->identifier; item++) {
439                         if (item->identifier[0] && STREQ(item->identifier, identifier)) {
440                                 icon = item->icon;
441                                 break;
442                         }
443                 }
444                 if (free) {
445                         MEM_freeN((void *)items);
446                 }
447         }
448
449         return icon;
450 }
451
452 #else
453
454 static void api_ui_item_common_text(FunctionRNA *func)
455 {
456         RNA_def_string(func, "text", NULL, 0, "", "Override automatic text of the item");
457         RNA_def_string(func, "text_ctxt", NULL, 0, "", "Override automatic translation context of the given text");
458         RNA_def_boolean(func, "translate", true, "", "Translate the given text, when UI translation is enabled");
459 }
460
461 static void api_ui_item_common(FunctionRNA *func)
462 {
463         PropertyRNA *prop;
464
465         api_ui_item_common_text(func);
466
467         prop = RNA_def_property(func, "icon", PROP_ENUM, PROP_NONE);
468         RNA_def_property_enum_items(prop, rna_enum_icon_items);
469         RNA_def_property_ui_text(prop, "Icon", "Override automatic icon of the item");
470 }
471
472 static void api_ui_item_op(FunctionRNA *func)
473 {
474         PropertyRNA *parm;
475         parm = RNA_def_string(func, "operator", NULL, 0, "", "Identifier of the operator");
476         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
477 }
478
479 static void api_ui_item_op_common(FunctionRNA *func)
480 {
481         api_ui_item_op(func);
482         api_ui_item_common(func);
483 }
484
485 static void api_ui_item_rna_common(FunctionRNA *func)
486 {
487         PropertyRNA *parm;
488
489         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property");
490         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
491         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in data");
492         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
493 }
494
495 void RNA_api_ui_layout(StructRNA *srna)
496 {
497         FunctionRNA *func;
498         PropertyRNA *parm;
499
500         static const EnumPropertyItem curve_type_items[] = {
501                 {0, "NONE", 0, "None", ""},
502                 {'v', "VECTOR", 0, "Vector", ""},
503                 {'c', "COLOR", 0, "Color", ""},
504                 {'h', "HUE", 0, "Hue", ""},
505                 {0, NULL, 0, NULL, NULL}
506         };
507
508         static const EnumPropertyItem id_template_filter_items[] = {
509                 {UI_TEMPLATE_ID_FILTER_ALL, "ALL", 0, "All", ""},
510                 {UI_TEMPLATE_ID_FILTER_AVAILABLE, "AVAILABLE", 0, "Available", ""},
511                 {0, NULL, 0, NULL, NULL}
512         };
513
514         static float node_socket_color_default[] = { 0.0f, 0.0f, 0.0f, 1.0f };
515
516         /* simple layout specifiers */
517         func = RNA_def_function(srna, "row", "uiLayoutRow");
518         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
519         RNA_def_function_return(func, parm);
520         RNA_def_function_ui_description(func,
521                                         "Sub-layout. Items placed in this sublayout are placed next to each other "
522                                         "in a row");
523         RNA_def_boolean(func, "align", false, "", "Align buttons to each other");
524
525         func = RNA_def_function(srna, "column", "uiLayoutColumn");
526         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
527         RNA_def_function_return(func, parm);
528         RNA_def_function_ui_description(func,
529                                         "Sub-layout. Items placed in this sublayout are placed under each other "
530                                         "in a column");
531         RNA_def_boolean(func, "align", false, "", "Align buttons to each other");
532
533         func = RNA_def_function(srna, "column_flow", "uiLayoutColumnFlow");
534         RNA_def_int(func, "columns", 0, 0, INT_MAX, "", "Number of columns, 0 is automatic", 0, INT_MAX);
535         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
536         RNA_def_function_return(func, parm);
537         RNA_def_boolean(func, "align", false, "", "Align buttons to each other");
538
539         func = RNA_def_function(srna, "grid_flow", "uiLayoutGridFlow");
540         RNA_def_boolean(func, "row_major", false, "", "Fill row by row, instead of column by column");
541         RNA_def_int(func, "columns", 0, INT_MIN, INT_MAX, "",
542                     "Number of columns, positive are absolute fixed numbers, 0 is automatic, negative are "
543                     "automatic multiple numbers along major axis (e.g. -2 will only produce 2, 4, 6 etc. "
544                     "columns for row major layout, and 2, 4, 6 etc. rows for column major layout)",
545                     INT_MIN, INT_MAX);
546         RNA_def_boolean(func, "even_columns", false, "", "All columns will have the same width");
547         RNA_def_boolean(func, "even_rows", false, "", "All rows will have the same height");
548         RNA_def_boolean(func, "align", false, "", "Align buttons to each other");
549         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
550         RNA_def_function_return(func, parm);
551
552         /* box layout */
553         func = RNA_def_function(srna, "box", "uiLayoutBox");
554         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
555         RNA_def_function_return(func, parm);
556         RNA_def_function_ui_description(func, "Sublayout (items placed in this sublayout are placed "
557                                         "under each other in a column and are surrounded by a box)");
558
559         /* split layout */
560         func = RNA_def_function(srna, "split", "uiLayoutSplit");
561         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
562         RNA_def_function_return(func, parm);
563         RNA_def_float(
564                 func, "factor", 0.0f, 0.0f, 1.0f, "Percentage",
565                 "Percentage of width to split at (leave unset for automatic calculation)",
566                 0.0f, 1.0f);
567         RNA_def_boolean(func, "align", false, "", "Align buttons to each other");
568
569         /* radial/pie layout */
570         func = RNA_def_function(srna, "menu_pie", "uiLayoutRadial");
571         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
572         RNA_def_function_return(func, parm);
573         RNA_def_function_ui_description(func, "Sublayout. Items placed in this sublayout are placed "
574                                         "in a radial fashion around the menu center)");
575
576         /* Icon of a rna pointer */
577         func = RNA_def_function(srna, "icon", "rna_ui_get_rnaptr_icon");
578         parm = RNA_def_int(func, "icon_value", ICON_NONE, 0, INT_MAX, "", "Icon identifier", 0, INT_MAX);
579         RNA_def_function_return(func, parm);
580         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
581         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take the icon");
582         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
583         RNA_def_function_ui_description(func, "Return the custom icon for this data, "
584                                               "use it e.g. to get materials or texture icons");
585
586         /* UI name, description and icon of an enum item */
587         func = RNA_def_function(srna, "enum_item_name", "rna_ui_get_enum_name");
588         parm = RNA_def_string(func, "name", NULL, 0, "", "UI name of the enum item");
589         RNA_def_function_return(func, parm);
590         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
591         api_ui_item_rna_common(func);
592         parm = RNA_def_string(func, "identifier", NULL, 0, "", "Identifier of the enum item");
593         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
594         RNA_def_function_ui_description(func, "Return the UI name for this enum item");
595
596         func = RNA_def_function(srna, "enum_item_description", "rna_ui_get_enum_description");
597         parm = RNA_def_string(func, "description", NULL, 0, "", "UI description of the enum item");
598         RNA_def_function_return(func, parm);
599         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
600         api_ui_item_rna_common(func);
601         parm = RNA_def_string(func, "identifier", NULL, 0, "", "Identifier of the enum item");
602         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
603         RNA_def_function_ui_description(func, "Return the UI description for this enum item");
604
605         func = RNA_def_function(srna, "enum_item_icon", "rna_ui_get_enum_icon");
606         parm = RNA_def_int(func, "icon_value", ICON_NONE, 0, INT_MAX, "", "Icon identifier", 0, INT_MAX);
607         RNA_def_function_return(func, parm);
608         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
609         api_ui_item_rna_common(func);
610         parm = RNA_def_string(func, "identifier", NULL, 0, "", "Identifier of the enum item");
611         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
612         RNA_def_function_ui_description(func, "Return the icon for this enum item");
613
614         /* items */
615         func = RNA_def_function(srna, "prop", "rna_uiItemR");
616         RNA_def_function_ui_description(func, "Item. Exposes an RNA item and places it into the layout");
617         api_ui_item_rna_common(func);
618         api_ui_item_common(func);
619         RNA_def_boolean(func, "expand", false, "", "Expand button to show more detail");
620         RNA_def_boolean(func, "slider", false, "", "Use slider widget for numeric values");
621         RNA_def_boolean(func, "toggle", false, "", "Use toggle widget for boolean values");
622         RNA_def_boolean(func, "icon_only", false, "", "Draw only icons in buttons, no text");
623         RNA_def_boolean(func, "event", false, "", "Use button to input key events");
624         RNA_def_boolean(func, "full_event", false, "", "Use button to input full events including modifiers");
625         RNA_def_boolean(func, "emboss", true, "", "Draw the button itself, not just the icon/text");
626         RNA_def_int(func, "index", -1, -2, INT_MAX, "",
627                     "The index of this button, when set a single member of an array can be accessed, "
628                     "when set to -1 all array members are used", -2, INT_MAX); /* RNA_NO_INDEX == -1 */
629         parm = RNA_def_property(func, "icon_value", PROP_INT, PROP_UNSIGNED);
630         RNA_def_property_ui_text(parm, "Icon Value", "Override automatic icon of the item");
631
632         func = RNA_def_function(srna, "props_enum", "uiItemsEnumR");
633         api_ui_item_rna_common(func);
634
635         func = RNA_def_function(srna, "prop_menu_enum", "rna_uiItemMenuEnumR");
636         api_ui_item_rna_common(func);
637         api_ui_item_common(func);
638
639         func = RNA_def_function(srna, "prop_tabs_enum", "rna_uiItemTabsEnumR");
640         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
641         api_ui_item_rna_common(func);
642         RNA_def_boolean(func, "icon_only", false, "", "Draw only icons in tabs, no text");
643
644         func = RNA_def_function(srna, "prop_enum", "rna_uiItemEnumR_string");
645         api_ui_item_rna_common(func);
646         parm = RNA_def_string(func, "value", NULL, 0, "", "Enum property value");
647         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
648         api_ui_item_common(func);
649
650         func = RNA_def_function(srna, "prop_search", "rna_uiItemPointerR");
651         api_ui_item_rna_common(func);
652         parm = RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in");
653         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
654         parm = RNA_def_string(func, "search_property", NULL, 0, "", "Identifier of search collection property");
655         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
656         api_ui_item_common(func);
657
658         for (int is_menu_hold = 0; is_menu_hold < 2; is_menu_hold++) {
659                 func = (is_menu_hold) ?
660                         RNA_def_function(srna, "operator_menu_hold", "rna_uiItemOMenuHold") :
661                         RNA_def_function(srna, "operator", "rna_uiItemO");
662                 api_ui_item_op_common(func);
663                 RNA_def_boolean(func, "emboss", true, "", "Draw the button itself, not just the icon/text");
664                 RNA_def_boolean(func, "depress", false, "", "Draw pressed in");
665                 parm = RNA_def_property(func, "icon_value", PROP_INT, PROP_UNSIGNED);
666                 RNA_def_property_ui_text(parm, "Icon Value", "Override automatic icon of the item");
667                 if (is_menu_hold) {
668                         parm = RNA_def_string(func, "menu", NULL, 0, "", "Identifier of the menu");
669                         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
670                 }
671                 parm = RNA_def_pointer(func, "properties", "OperatorProperties", "", "Operator properties to fill in");
672                 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR);
673                 RNA_def_function_return(func, parm);
674                 RNA_def_function_ui_description(func, "Item. Places a button into the layout to call an Operator");
675         }
676
677         func = RNA_def_function(srna, "operator_enum", "uiItemsEnumO");
678         parm = RNA_def_string(func, "operator", NULL, 0, "", "Identifier of the operator");
679         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
680         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in operator");
681         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
682
683         func = RNA_def_function(srna, "operator_menu_enum", "rna_uiItemMenuEnumO");
684         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
685         api_ui_item_op(func); /* cant use api_ui_item_op_common because property must come right after */
686         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in operator");
687         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
688         api_ui_item_common(func);
689
690         /* useful in C but not in python */
691 #if 0
692
693         func = RNA_def_function(srna, "operator_enum_single", "uiItemEnumO_string");
694         api_ui_item_op_common(func);
695         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in operator");
696         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
697         parm = RNA_def_string(func, "value", NULL, 0, "", "Enum property value");
698         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
699
700         func = RNA_def_function(srna, "operator_boolean", "uiItemBooleanO");
701         api_ui_item_op_common(func);
702         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in operator");
703         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
704         parm = RNA_def_boolean(func, "value", false, "", "Value of the property to call the operator with");
705         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); */
706
707         func = RNA_def_function(srna, "operator_int", "uiItemIntO");
708         api_ui_item_op_common(func);
709         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in operator");
710         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
711         parm = RNA_def_int(func, "value", 0, INT_MIN, INT_MAX, "",
712                           "Value of the property to call the operator with", INT_MIN, INT_MAX);
713         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); */
714
715         func = RNA_def_function(srna, "operator_float", "uiItemFloatO");
716         api_ui_item_op_common(func);
717         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in operator");
718         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
719         parm = RNA_def_float(func, "value", 0, -FLT_MAX, FLT_MAX, "",
720                             "Value of the property to call the operator with", -FLT_MAX, FLT_MAX);
721         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); */
722
723         func = RNA_def_function(srna, "operator_string", "uiItemStringO");
724         api_ui_item_op_common(func);
725         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in operator");
726         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
727         parm = RNA_def_string(func, "value", NULL, 0, "", "Value of the property to call the operator with");
728         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
729 #endif
730
731         func = RNA_def_function(srna, "label", "rna_uiItemL");
732         RNA_def_function_ui_description(func, "Item. Displays text and/or icon in the layout");
733         api_ui_item_common(func);
734         parm = RNA_def_property(func, "icon_value", PROP_INT, PROP_UNSIGNED);
735         RNA_def_property_ui_text(parm, "Icon Value", "Override automatic icon of the item");
736
737         func = RNA_def_function(srna, "menu", "rna_uiItemM");
738         parm = RNA_def_string(func, "menu", NULL, 0, "", "Identifier of the menu");
739         api_ui_item_common(func);
740         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
741         parm = RNA_def_property(func, "icon_value", PROP_INT, PROP_UNSIGNED);
742         RNA_def_property_ui_text(parm, "Icon Value", "Override automatic icon of the item");
743
744         func = RNA_def_function(srna, "popover", "rna_uiItemPopoverPanel");
745         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
746         parm = RNA_def_string(func, "panel", NULL, 0, "", "Identifier of the panel");
747         api_ui_item_common(func);
748         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
749         parm = RNA_def_property(func, "icon_value", PROP_INT, PROP_UNSIGNED);
750         RNA_def_property_ui_text(parm, "Icon Value", "Override automatic icon of the item");
751
752         func = RNA_def_function(srna, "popover_group", "rna_uiItemPopoverPanelFromGroup");
753         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
754         parm = RNA_def_enum(func, "space_type", rna_enum_space_type_items, 0, "Space Type", "");
755         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
756         parm = RNA_def_enum(func, "region_type", rna_enum_region_type_items, RGN_TYPE_WINDOW, "Region Type", "");
757         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
758         parm = RNA_def_string(func, "context", NULL, 0, "", "panel type context");
759         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
760         parm = RNA_def_string(func, "category", NULL, 0, "", "panel type category");
761         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
762
763         func = RNA_def_function(srna, "separator", "uiItemS_ex");
764         RNA_def_function_ui_description(func, "Item. Inserts empty space into the layout between items");
765         RNA_def_float(
766                 func, "factor", 1.0f, 0.0f, FLT_MAX, "Percentage",
767                 "Percentage of width to space (leave unset for default space)",
768                 0.0f, FLT_MAX);
769
770         func = RNA_def_function(srna, "separator_spacer", "uiItemSpacer");
771         RNA_def_function_ui_description(func, "Item. Inserts horizontal spacing empty space into the layout between items");
772
773         /* context */
774         func = RNA_def_function(srna, "context_pointer_set", "uiLayoutSetContextPointer");
775         parm = RNA_def_string(func, "name", NULL, 0, "Name", "Name of entry in the context");
776         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
777         parm = RNA_def_pointer(func, "data", "AnyType", "", "Pointer to put in context");
778         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR);
779
780         /* templates */
781         func = RNA_def_function(srna, "template_header", "uiTemplateHeader");
782         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
783         RNA_def_function_ui_description(func, "Inserts common Space header UI (editor type selector)");
784
785         func = RNA_def_function(srna, "template_ID", "uiTemplateID");
786         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
787         api_ui_item_rna_common(func);
788         RNA_def_string(func, "new", NULL, 0, "", "Operator identifier to create a new ID block");
789         RNA_def_string(func, "open", NULL, 0, "", "Operator identifier to open a file for creating a new ID block");
790         RNA_def_string(func, "unlink", NULL, 0, "", "Operator identifier to unlink the ID block");
791         RNA_def_enum(func, "filter", id_template_filter_items, UI_TEMPLATE_ID_FILTER_ALL,
792                      "", "Optionally limit the items which can be selected");
793         RNA_def_boolean(func, "live_icon", false, "", "Show preview instead of fixed icon");
794
795         func = RNA_def_function(srna, "template_ID_preview", "uiTemplateIDPreview");
796         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
797         api_ui_item_rna_common(func);
798         RNA_def_string(func, "new", NULL, 0, "", "Operator identifier to create a new ID block");
799         RNA_def_string(func, "open", NULL, 0, "", "Operator identifier to open a file for creating a new ID block");
800         RNA_def_string(func, "unlink", NULL, 0, "", "Operator identifier to unlink the ID block");
801         RNA_def_int(func, "rows", 0, 0, INT_MAX, "Number of thumbnail preview rows to display", "", 0, INT_MAX);
802         RNA_def_int(func, "cols", 0, 0, INT_MAX, "Number of thumbnail preview columns to display", "", 0, INT_MAX);
803         RNA_def_enum(func, "filter", id_template_filter_items, UI_TEMPLATE_ID_FILTER_ALL,
804                      "", "Optionally limit the items which can be selected");
805
806         func = RNA_def_function(srna, "template_any_ID", "rna_uiTemplateAnyID");
807         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property");
808         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
809         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in data");
810         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
811         parm = RNA_def_string(func, "type_property", NULL, 0, "",
812                               "Identifier of property in data giving the type of the ID-blocks to use");
813         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
814         api_ui_item_common_text(func);
815
816         func = RNA_def_function(srna, "template_ID_tabs", "uiTemplateIDTabs");
817         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
818         api_ui_item_rna_common(func);
819         RNA_def_string(func, "new", NULL, 0, "", "Operator identifier to create a new ID block");
820         RNA_def_string(func, "menu", NULL, 0, "", "Context menu identifier");
821         RNA_def_enum(func, "filter", id_template_filter_items, UI_TEMPLATE_ID_FILTER_ALL,
822                      "", "Optionally limit the items which can be selected");
823
824         func = RNA_def_function(srna, "template_search", "uiTemplateSearch");
825         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
826         api_ui_item_rna_common(func);
827         parm = RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in");
828         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
829         parm = RNA_def_string(func, "search_property", NULL, 0, "", "Identifier of search collection property");
830         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
831         RNA_def_string(func, "new", NULL, 0, "", "Operator identifier to create a new item for the collection");
832         RNA_def_string(func, "unlink", NULL, 0, "", "Operator identifier to unlink or delete the active "
833                        "item from the collection");
834
835         func = RNA_def_function(srna, "template_search_preview", "uiTemplateSearchPreview");
836         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
837         api_ui_item_rna_common(func);
838         parm = RNA_def_pointer(func, "search_data", "AnyType", "", "Data from which to take collection to search in");
839         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
840         parm = RNA_def_string(func, "search_property", NULL, 0, "", "Identifier of search collection property");
841         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
842         RNA_def_string(func, "new", NULL, 0, "", "Operator identifier to create a new item for the collection");
843         RNA_def_string(func, "unlink", NULL, 0, "", "Operator identifier to unlink or delete the active "
844                        "item from the collection");
845         RNA_def_int(func, "rows", 0, 0, INT_MAX, "Number of thumbnail preview rows to display", "", 0, INT_MAX);
846         RNA_def_int(func, "cols", 0, 0, INT_MAX, "Number of thumbnail preview columns to display", "", 0, INT_MAX);
847
848         func = RNA_def_function(srna, "template_path_builder", "rna_uiTemplatePathBuilder");
849         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property");
850         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
851         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in data");
852         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
853         parm = RNA_def_pointer(func, "root", "ID", "", "ID-block from which path is evaluated from");
854         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR);
855         api_ui_item_common_text(func);
856
857         func = RNA_def_function(srna, "template_modifier", "uiTemplateModifier");
858         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
859         RNA_def_function_ui_description(func, "Generates the UI layout for modifiers");
860         parm = RNA_def_pointer(func, "data", "Modifier", "", "Modifier data");
861         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
862         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
863         RNA_def_function_return(func, parm);
864
865         func = RNA_def_function(srna, "template_greasepencil_modifier", "uiTemplateGpencilModifier");
866         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
867         RNA_def_function_ui_description(func, "Generates the UI layout for grease pencil modifiers");
868         parm = RNA_def_pointer(func, "data", "GpencilModifier", "", "Modifier data");
869         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
870         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
871         RNA_def_function_return(func, parm);
872
873         func = RNA_def_function(srna, "template_shaderfx", "uiTemplateShaderFx");
874         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
875         RNA_def_function_ui_description(func, "Generates the UI layout for shader effect");
876         parm = RNA_def_pointer(func, "data", "ShaderFx", "", "Shader data");
877         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
878         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
879         RNA_def_function_return(func, parm);
880
881         func = RNA_def_function(srna, "template_greasepencil_color", "uiTemplateGpencilColorPreview");
882         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
883         api_ui_item_rna_common(func);
884         RNA_def_int(func, "rows", 0, 0, INT_MAX, "Number of thumbnail preview rows to display", "", 0, INT_MAX);
885         RNA_def_int(func, "cols", 0, 0, INT_MAX, "Number of thumbnail preview columns to display", "", 0, INT_MAX);
886         RNA_def_float(func, "scale", 1.0f, 0.1f, 1.5f, "Scale of the image thumbnails", "", 0.5f, 1.0f);
887         RNA_def_enum(func, "filter", id_template_filter_items, UI_TEMPLATE_ID_FILTER_ALL,
888                 "", "Optionally limit the items which can be selected");
889
890         func = RNA_def_function(srna, "template_constraint", "uiTemplateConstraint");
891         RNA_def_function_ui_description(func, "Generates the UI layout for constraints");
892         parm = RNA_def_pointer(func, "data", "Constraint", "", "Constraint data");
893         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
894         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Sub-layout to put items in");
895         RNA_def_function_return(func, parm);
896
897         func = RNA_def_function(srna, "template_preview", "uiTemplatePreview");
898         RNA_def_function_ui_description(func, "Item. A preview window for materials, textures, lights or worlds");
899         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
900         parm = RNA_def_pointer(func, "id", "ID", "", "ID data-block");
901         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
902         RNA_def_boolean(func, "show_buttons", true, "", "Show preview buttons?");
903         RNA_def_pointer(func, "parent", "ID", "", "ID data-block");
904         RNA_def_pointer(func, "slot", "TextureSlot", "", "Texture slot");
905         RNA_def_string(func, "preview_id", NULL, 0, "",
906                        "Identifier of this preview widget, if not set the ID type will be used "
907                        "(i.e. all previews of materials without explicit ID will have the same size...)");
908
909         func = RNA_def_function(srna, "template_curve_mapping", "uiTemplateCurveMapping");
910         RNA_def_function_ui_description(func, "Item. A curve mapping widget used for e.g falloff curves for lights");
911         api_ui_item_rna_common(func);
912         RNA_def_enum(func, "type", curve_type_items, 0, "Type", "Type of curves to display");
913         RNA_def_boolean(func, "levels", false, "", "Show black/white levels");
914         RNA_def_boolean(func, "brush", false, "", "Show brush options");
915         RNA_def_boolean(func, "use_negative_slope", false, "", "Use a negative slope by default");
916         RNA_def_boolean(func, "show_tone", false, "", "Show tone options");
917
918         func = RNA_def_function(srna, "template_color_ramp", "uiTemplateColorRamp");
919         RNA_def_function_ui_description(func, "Item. A color ramp widget");
920         api_ui_item_rna_common(func);
921         RNA_def_boolean(func, "expand", false, "", "Expand button to show more detail");
922
923         func = RNA_def_function(srna, "template_icon", "uiTemplateIcon");
924         RNA_def_function_ui_description(func, "Display a large icon");
925         parm = RNA_def_int(func, "icon_value", 0, 0, INT_MAX, "Icon to display", "", 0, INT_MAX);
926         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
927         RNA_def_float(func, "scale", 1.0f, 1.0f, 100.0f, "Scale", "Scale the icon size (by the button size)", 1.0f, 100.0f);
928
929         func = RNA_def_function(srna, "template_icon_view", "uiTemplateIconView");
930         RNA_def_function_ui_description(func, "Enum. Large widget showing Icon previews");
931         api_ui_item_rna_common(func);
932         RNA_def_boolean(func, "show_labels", false, "", "Show enum label in preview buttons");
933         RNA_def_float(func, "scale", 5.0f, 1.0f, 100.0f, "Scale", "Scale the icon size (by the button size)", 1.0f, 100.0f);
934
935         func = RNA_def_function(srna, "template_histogram", "uiTemplateHistogram");
936         RNA_def_function_ui_description(func, "Item. A histogramm widget to analyze imaga data");
937         api_ui_item_rna_common(func);
938
939         func = RNA_def_function(srna, "template_waveform", "uiTemplateWaveform");
940         RNA_def_function_ui_description(func, "Item. A waveform widget to analyze imaga data");
941         api_ui_item_rna_common(func);
942
943         func = RNA_def_function(srna, "template_vectorscope", "uiTemplateVectorscope");
944         RNA_def_function_ui_description(func, "Item. A vectorscope widget to analyze imaga data");
945         api_ui_item_rna_common(func);
946
947         func = RNA_def_function(srna, "template_layers", "uiTemplateLayers");
948         api_ui_item_rna_common(func);
949         parm = RNA_def_pointer(func, "used_layers_data", "AnyType", "", "Data from which to take property");
950         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR);
951         parm = RNA_def_string(func, "used_layers_property", NULL, 0, "", "Identifier of property in data");
952         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
953         parm = RNA_def_int(func, "active_layer", 0, 0, INT_MAX, "Active Layer", "", 0, INT_MAX);
954         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
955
956         func = RNA_def_function(srna, "template_color_picker", "uiTemplateColorPicker");
957         RNA_def_function_ui_description(func, "Item. A color wheel widget to pick colors");
958         api_ui_item_rna_common(func);
959         RNA_def_boolean(func, "value_slider", false, "", "Display the value slider to the right of the color wheel");
960         RNA_def_boolean(func, "lock", false, "", "Lock the color wheel display to value 1.0 regardless of actual color");
961         RNA_def_boolean(func, "lock_luminosity", false, "", "Keep the color at its original vector length");
962         RNA_def_boolean(func, "cubic", false, "", "Cubic saturation for picking values close to white");
963
964         func = RNA_def_function(srna, "template_palette", "uiTemplatePalette");
965         RNA_def_function_ui_description(func, "Item. A palette used to pick colors");
966         api_ui_item_rna_common(func);
967         RNA_def_boolean(func, "color", 0, "", "Display the colors as colors or values");
968
969         func = RNA_def_function(srna, "template_image_layers", "uiTemplateImageLayers");
970         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
971         parm = RNA_def_pointer(func, "image", "Image", "", "");
972         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
973         parm = RNA_def_pointer(func, "image_user", "ImageUser", "", "");
974         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
975
976         func = RNA_def_function(srna, "template_image", "uiTemplateImage");
977         RNA_def_function_ui_description(func, "Item(s). User interface for selecting images and their source paths");
978         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
979         api_ui_item_rna_common(func);
980         parm = RNA_def_pointer(func, "image_user", "ImageUser", "", "");
981         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
982         RNA_def_boolean(func, "compact", false, "", "Use more compact layout");
983         RNA_def_boolean(func, "multiview", false, "", "Expose Multi-View options");
984
985         func = RNA_def_function(srna, "template_image_settings", "uiTemplateImageSettings");
986         RNA_def_function_ui_description(func, "User interface for setting image format options");
987         parm = RNA_def_pointer(func, "image_settings", "ImageFormatSettings", "", "");
988         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
989         RNA_def_boolean(func, "color_management", false, "", "Show color management settings");
990
991         func = RNA_def_function(srna, "template_image_stereo_3d", "uiTemplateImageStereo3d");
992         RNA_def_function_ui_description(func, "User interface for setting image stereo 3d options");
993         parm = RNA_def_pointer(func, "stereo_3d_format", "Stereo3dFormat", "", "");
994         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
995
996         func = RNA_def_function(srna, "template_image_views", "uiTemplateImageViews");
997         RNA_def_function_ui_description(func, "User interface for setting image views output options");
998         parm = RNA_def_pointer(func, "image_settings", "ImageFormatSettings", "", "");
999         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1000
1001         func = RNA_def_function(srna, "template_movieclip", "uiTemplateMovieClip");
1002         RNA_def_function_ui_description(func, "Item(s). User interface for selecting movie clips and their source paths");
1003         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1004         api_ui_item_rna_common(func);
1005         RNA_def_boolean(func, "compact", false, "", "Use more compact layout");
1006
1007         func = RNA_def_function(srna, "template_track", "uiTemplateTrack");
1008         RNA_def_function_ui_description(func, "Item. A movie-track widget to preview tracking image.");
1009         api_ui_item_rna_common(func);
1010
1011         func = RNA_def_function(srna, "template_marker", "uiTemplateMarker");
1012         RNA_def_function_ui_description(func, "Item. A widget to control single marker settings.");
1013         api_ui_item_rna_common(func);
1014         parm = RNA_def_pointer(func, "clip_user", "MovieClipUser", "", "");
1015         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1016         parm = RNA_def_pointer(func, "track", "MovieTrackingTrack", "", "");
1017         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1018         RNA_def_boolean(func, "compact", false, "", "Use more compact layout");
1019
1020         func = RNA_def_function(srna, "template_movieclip_information", "uiTemplateMovieclipInformation");
1021         RNA_def_function_ui_description(func, "Item. Movie clip information data.");
1022         api_ui_item_rna_common(func);
1023         parm = RNA_def_pointer(func, "clip_user", "MovieClipUser", "", "");
1024         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1025
1026         func = RNA_def_function(srna, "template_list", "uiTemplateList");
1027         RNA_def_function_ui_description(func, "Item. A list widget to display data, e.g. vertexgroups.");
1028         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1029         parm = RNA_def_string(func, "listtype_name", NULL, 0, "", "Identifier of the list type to use");
1030         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1031         parm = RNA_def_string(func, "list_id", NULL, 0, "",
1032                               "Identifier of this list widget (mandatory when using default \"" UI_UL_DEFAULT_CLASS_NAME
1033                               "\" class). "
1034                               "If this not an empty string, the uilist gets a custom ID, otherwise it takes the "
1035                               "name of the class used to define the uilist (for example, if the "
1036                               "class name is \"OBJECT_UL_vgroups\", and list_id is not set by the "
1037                               "script, then bl_idname = \"OBJECT_UL_vgroups\")");
1038         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1039         parm = RNA_def_pointer(func, "dataptr", "AnyType", "", "Data from which to take the Collection property");
1040         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR);
1041         parm = RNA_def_string(func, "propname", NULL, 0, "", "Identifier of the Collection property in data");
1042         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1043         parm = RNA_def_pointer(func, "active_dataptr", "AnyType", "",
1044                                "Data from which to take the integer property, index of the active item");
1045         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1046         parm = RNA_def_string(func, "active_propname", NULL, 0, "",
1047                               "Identifier of the integer property in active_data, index of the active item");
1048         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1049         RNA_def_string(func, "item_dyntip_propname", NULL, 0, "",
1050                        "Identifier of a string property in items, to use as tooltip content");
1051         RNA_def_int(func, "rows", 5, 0, INT_MAX, "", "Default and minimum number of rows to display", 0, INT_MAX);
1052         RNA_def_int(func, "maxrows", 5, 0, INT_MAX, "", "Default maximum number of rows to display", 0, INT_MAX);
1053         RNA_def_enum(func, "type", rna_enum_uilist_layout_type_items, UILST_LAYOUT_DEFAULT, "Type", "Type of layout to use");
1054         RNA_def_int(func, "columns", 9, 0, INT_MAX, "", "Number of items to display per row, for GRID layout", 0, INT_MAX);
1055         RNA_def_boolean(func, "reverse", false, "", "Display items in reverse order");
1056
1057         func = RNA_def_function(srna, "template_running_jobs", "uiTemplateRunningJobs");
1058         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1059
1060         RNA_def_function(srna, "template_operator_search", "uiTemplateOperatorSearch");
1061
1062         func = RNA_def_function(srna, "template_header_3D", "uiTemplateHeader3D");
1063         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1064         RNA_def_function_ui_description(func, "Inserts common 3DView header UI (selectors for context mode, shading, etc.)");
1065
1066         func = RNA_def_function(srna, "template_header_3D_mode", "uiTemplateHeader3D_mode");
1067         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1068         RNA_def_function_ui_description(func, "");
1069
1070         func = RNA_def_function(srna, "template_edit_mode_selection", "uiTemplateEditModeSelection");
1071         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1072         RNA_def_function_ui_description(func, "Inserts common 3DView Edit modes header UI (selector for selection mode)");
1073
1074         func = RNA_def_function(srna, "template_reports_banner", "uiTemplateReportsBanner");
1075         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1076
1077         func = RNA_def_function(srna, "template_input_status", "uiTemplateInputStatus");
1078         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1079
1080         func = RNA_def_function(srna, "template_node_link", "uiTemplateNodeLink");
1081         parm = RNA_def_pointer(func, "ntree", "NodeTree", "", "");
1082         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1083         parm = RNA_def_pointer(func, "node", "Node", "", "");
1084         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1085         parm = RNA_def_pointer(func, "socket", "NodeSocket", "", "");
1086         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1087
1088         func = RNA_def_function(srna, "template_node_view", "uiTemplateNodeView");
1089         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1090         parm = RNA_def_pointer(func, "ntree", "NodeTree", "", "");
1091         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1092         parm = RNA_def_pointer(func, "node", "Node", "", "");
1093         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1094         parm = RNA_def_pointer(func, "socket", "NodeSocket", "", "");
1095         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1096
1097         func = RNA_def_function(srna, "template_texture_user", "uiTemplateTextureUser");
1098         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1099
1100         func = RNA_def_function(srna, "template_keymap_item_properties", "uiTemplateKeymapItemProperties");
1101         parm = RNA_def_pointer(func, "item", "KeyMapItem", "", "");
1102         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1103
1104         func = RNA_def_function(srna, "template_component_menu", "uiTemplateComponentMenu");
1105         RNA_def_function_ui_description(func, "Item. Display expanded property in a popup menu");
1106         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take property");
1107         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR);
1108         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in data");
1109         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1110         RNA_def_string(func, "name", NULL, 0, "", "");
1111
1112         /* color management templates */
1113         func = RNA_def_function(srna, "template_colorspace_settings", "uiTemplateColorspaceSettings");
1114         RNA_def_function_ui_description(func, "Item. A widget to control input color space settings.");
1115         api_ui_item_rna_common(func);
1116
1117         func = RNA_def_function(srna, "template_colormanaged_view_settings", "uiTemplateColormanagedViewSettings");
1118         RNA_def_function_ui_description(func, "Item. A widget to control color managed view settings settings.");
1119         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1120         api_ui_item_rna_common(func);
1121         /* RNA_def_boolean(func, "show_global_settings", false, "", "Show widgets to control global color management settings"); */
1122
1123         /* node socket icon */
1124         func = RNA_def_function(srna, "template_node_socket", "uiTemplateNodeSocket");
1125         RNA_def_function_ui_description(func, "Node Socket Icon");
1126         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1127         RNA_def_float_array(func, "color", 4, node_socket_color_default, 0.0f, 1.0f, "Color", "", 0.0f, 1.0f);
1128
1129         func = RNA_def_function(srna, "template_cache_file", "uiTemplateCacheFile");
1130         RNA_def_function_ui_description(func, "Item(s). User interface for selecting cache files and their source paths");
1131         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1132         api_ui_item_rna_common(func);
1133
1134         func = RNA_def_function(srna, "template_recent_files", "uiTemplateRecentFiles");
1135         RNA_def_function_ui_description(func, "Show list of recently saved .blend files");
1136         RNA_def_int(func, "rows", 5, 1, INT_MAX, "", "Maximum number of items to show", 1, INT_MAX);
1137         parm = RNA_def_int(func, "found", 0, 0, INT_MAX, "", "Number of items drawn", 0, INT_MAX);
1138         RNA_def_function_return(func, parm);
1139 }
1140
1141 #endif