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