diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-04-17 07:17:24 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-04-17 07:21:24 +0300 |
commit | e12c08e8d170b7ca40f204a5b0423c23a9fbc2c1 (patch) | |
tree | 8cf3453d12edb177a218ef8009357518ec6cab6a /source/blender/makesrna/intern/rna_ui.c | |
parent | b3dabc200a4b0399ec6b81f2ff2730d07b44fcaa (diff) |
ClangFormat: apply to source, most of intern
Apply clang format as proposed in T53211.
For details on usage and instructions for migrating branches
without conflicts, see:
https://wiki.blender.org/wiki/Tools/ClangFormat
Diffstat (limited to 'source/blender/makesrna/intern/rna_ui.c')
-rw-r--r-- | source/blender/makesrna/intern/rna_ui.c | 2488 |
1 files changed, 1299 insertions, 1189 deletions
diff --git a/source/blender/makesrna/intern/rna_ui.c b/source/blender/makesrna/intern/rna_ui.c index b6e75cf3507..1941f1bc1b2 100644 --- a/source/blender/makesrna/intern/rna_ui.c +++ b/source/blender/makesrna/intern/rna_ui.c @@ -18,7 +18,6 @@ * \ingroup RNA */ - #include <stdlib.h> #include "DNA_screen_types.h" @@ -40,1513 +39,1624 @@ /* see WM_types.h */ const EnumPropertyItem rna_enum_operator_context_items[] = { - {WM_OP_INVOKE_DEFAULT, "INVOKE_DEFAULT", 0, "Invoke Default", ""}, - {WM_OP_INVOKE_REGION_WIN, "INVOKE_REGION_WIN", 0, "Invoke Region Window", ""}, - {WM_OP_INVOKE_REGION_CHANNELS, "INVOKE_REGION_CHANNELS", 0, "Invoke Region Channels", ""}, - {WM_OP_INVOKE_REGION_PREVIEW, "INVOKE_REGION_PREVIEW", 0, "Invoke Region Preview", ""}, - {WM_OP_INVOKE_AREA, "INVOKE_AREA", 0, "Invoke Area", ""}, - {WM_OP_INVOKE_SCREEN, "INVOKE_SCREEN", 0, "Invoke Screen", ""}, - {WM_OP_EXEC_DEFAULT, "EXEC_DEFAULT", 0, "Exec Default", ""}, - {WM_OP_EXEC_REGION_WIN, "EXEC_REGION_WIN", 0, "Exec Region Window", ""}, - {WM_OP_EXEC_REGION_CHANNELS, "EXEC_REGION_CHANNELS", 0, "Exec Region Channels", ""}, - {WM_OP_EXEC_REGION_PREVIEW, "EXEC_REGION_PREVIEW", 0, "Exec Region Preview", ""}, - {WM_OP_EXEC_AREA, "EXEC_AREA", 0, "Exec Area", ""}, - {WM_OP_EXEC_SCREEN, "EXEC_SCREEN", 0, "Exec Screen", ""}, - {0, NULL, 0, NULL, NULL}, + {WM_OP_INVOKE_DEFAULT, "INVOKE_DEFAULT", 0, "Invoke Default", ""}, + {WM_OP_INVOKE_REGION_WIN, "INVOKE_REGION_WIN", 0, "Invoke Region Window", ""}, + {WM_OP_INVOKE_REGION_CHANNELS, "INVOKE_REGION_CHANNELS", 0, "Invoke Region Channels", ""}, + {WM_OP_INVOKE_REGION_PREVIEW, "INVOKE_REGION_PREVIEW", 0, "Invoke Region Preview", ""}, + {WM_OP_INVOKE_AREA, "INVOKE_AREA", 0, "Invoke Area", ""}, + {WM_OP_INVOKE_SCREEN, "INVOKE_SCREEN", 0, "Invoke Screen", ""}, + {WM_OP_EXEC_DEFAULT, "EXEC_DEFAULT", 0, "Exec Default", ""}, + {WM_OP_EXEC_REGION_WIN, "EXEC_REGION_WIN", 0, "Exec Region Window", ""}, + {WM_OP_EXEC_REGION_CHANNELS, "EXEC_REGION_CHANNELS", 0, "Exec Region Channels", ""}, + {WM_OP_EXEC_REGION_PREVIEW, "EXEC_REGION_PREVIEW", 0, "Exec Region Preview", ""}, + {WM_OP_EXEC_AREA, "EXEC_AREA", 0, "Exec Area", ""}, + {WM_OP_EXEC_SCREEN, "EXEC_SCREEN", 0, "Exec Screen", ""}, + {0, NULL, 0, NULL, NULL}, }; const EnumPropertyItem rna_enum_uilist_layout_type_items[] = { - {UILST_LAYOUT_DEFAULT, "DEFAULT", 0, "Default Layout", "Use the default, multi-rows layout"}, - {UILST_LAYOUT_COMPACT, "COMPACT", 0, "Compact Layout", "Use the compact, single-row layout"}, - {UILST_LAYOUT_GRID, "GRID", 0, "Grid Layout", "Use the grid-based layout"}, - {0, NULL, 0, NULL, NULL}, + {UILST_LAYOUT_DEFAULT, "DEFAULT", 0, "Default Layout", "Use the default, multi-rows layout"}, + {UILST_LAYOUT_COMPACT, "COMPACT", 0, "Compact Layout", "Use the compact, single-row layout"}, + {UILST_LAYOUT_GRID, "GRID", 0, "Grid Layout", "Use the grid-based layout"}, + {0, NULL, 0, NULL, NULL}, }; #ifdef RNA_RUNTIME -#include <assert.h> +# include <assert.h> -#include "MEM_guardedalloc.h" +# include "MEM_guardedalloc.h" -#include "RNA_access.h" +# include "RNA_access.h" -#include "BLI_dynstr.h" +# include "BLI_dynstr.h" -#include "BKE_context.h" -#include "BKE_report.h" -#include "BKE_screen.h" +# include "BKE_context.h" +# include "BKE_report.h" +# include "BKE_screen.h" -#include "WM_api.h" +# include "WM_api.h" static ARegionType *region_type_find(ReportList *reports, int space_type, int region_type) { - SpaceType *st; - ARegionType *art; + SpaceType *st; + ARegionType *art; - st = BKE_spacetype_from_id(space_type); + st = BKE_spacetype_from_id(space_type); - for (art = (st) ? st->regiontypes.first : NULL; art; art = art->next) { - if (art->regionid == region_type) - break; - } + for (art = (st) ? st->regiontypes.first : NULL; art; art = art->next) { + if (art->regionid == region_type) + break; + } - /* region type not found? abort */ - if (art == NULL) { - BKE_report(reports, RPT_ERROR, "Region not found in space type"); - return NULL; - } + /* region type not found? abort */ + if (art == NULL) { + BKE_report(reports, RPT_ERROR, "Region not found in space type"); + return NULL; + } - return art; + return art; } /* Panel */ static bool panel_poll(const bContext *C, PanelType *pt) { - extern FunctionRNA rna_Panel_poll_func; + extern FunctionRNA rna_Panel_poll_func; - PointerRNA ptr; - ParameterList list; - FunctionRNA *func; - void *ret; - bool visible; + PointerRNA ptr; + ParameterList list; + FunctionRNA *func; + void *ret; + bool visible; - RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */ - func = &rna_Panel_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */ + RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */ + func = &rna_Panel_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */ - RNA_parameter_list_create(&list, &ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - pt->ext.call((bContext *)C, &ptr, func, &list); + RNA_parameter_list_create(&list, &ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + pt->ext.call((bContext *)C, &ptr, func, &list); - RNA_parameter_get_lookup(&list, "visible", &ret); - visible = *(bool *)ret; + RNA_parameter_get_lookup(&list, "visible", &ret); + visible = *(bool *)ret; - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); - return visible; + return visible; } static void panel_draw(const bContext *C, Panel *pnl) { - extern FunctionRNA rna_Panel_draw_func; + extern FunctionRNA rna_Panel_draw_func; - PointerRNA ptr; - ParameterList list; - FunctionRNA *func; + PointerRNA ptr; + ParameterList list; + FunctionRNA *func; - RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr); - func = &rna_Panel_draw_func; /* RNA_struct_find_function(&ptr, "draw"); */ + RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr); + func = &rna_Panel_draw_func; /* RNA_struct_find_function(&ptr, "draw"); */ - RNA_parameter_list_create(&list, &ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - pnl->type->ext.call((bContext *)C, &ptr, func, &list); + RNA_parameter_list_create(&list, &ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + pnl->type->ext.call((bContext *)C, &ptr, func, &list); - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); } static void panel_draw_header(const bContext *C, Panel *pnl) { - extern FunctionRNA rna_Panel_draw_header_func; + extern FunctionRNA rna_Panel_draw_header_func; - PointerRNA ptr; - ParameterList list; - FunctionRNA *func; + PointerRNA ptr; + ParameterList list; + FunctionRNA *func; - RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr); - func = &rna_Panel_draw_header_func; /* RNA_struct_find_function(&ptr, "draw_header"); */ + RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr); + func = &rna_Panel_draw_header_func; /* RNA_struct_find_function(&ptr, "draw_header"); */ - RNA_parameter_list_create(&list, &ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - pnl->type->ext.call((bContext *)C, &ptr, func, &list); + RNA_parameter_list_create(&list, &ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + pnl->type->ext.call((bContext *)C, &ptr, func, &list); - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); } static void panel_draw_header_preset(const bContext *C, Panel *pnl) { - extern FunctionRNA rna_Panel_draw_header_preset_func; + extern FunctionRNA rna_Panel_draw_header_preset_func; - PointerRNA ptr; - ParameterList list; - FunctionRNA *func; + PointerRNA ptr; + ParameterList list; + FunctionRNA *func; - RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr); - func = &rna_Panel_draw_header_preset_func; + RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr); + func = &rna_Panel_draw_header_preset_func; - RNA_parameter_list_create(&list, &ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - pnl->type->ext.call((bContext *)C, &ptr, func, &list); + RNA_parameter_list_create(&list, &ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + pnl->type->ext.call((bContext *)C, &ptr, func, &list); - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); } static void rna_Panel_unregister(Main *UNUSED(bmain), StructRNA *type) { - ARegionType *art; - PanelType *pt = RNA_struct_blender_type_get(type); - - if (!pt) - return; - if (!(art = region_type_find(NULL, pt->space_type, pt->region_type))) - return; - - RNA_struct_free_extension(type, &pt->ext); - RNA_struct_free(&BLENDER_RNA, type); - - if (pt->parent) { - LinkData *link = BLI_findptr(&pt->parent->children, pt, offsetof(LinkData, data)); - BLI_freelinkN(&pt->parent->children, link); - } - - WM_paneltype_remove(pt); - - for (LinkData *link = pt->children.first; link; link = link->next) { - PanelType *child_pt = link->data; - child_pt->parent = NULL; - } - - BLI_freelistN(&pt->children); - BLI_freelinkN(&art->paneltypes, pt); - - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); -} - -static StructRNA *rna_Panel_register( - Main *bmain, ReportList *reports, void *data, const char *identifier, - StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free) -{ - ARegionType *art; - PanelType *pt, *parent = NULL, dummypt = {NULL}; - Panel dummypanel = {NULL}; - PointerRNA dummyptr; - int have_function[4]; - - /* setup dummy panel & panel type to store static properties in */ - dummypanel.type = &dummypt; - RNA_pointer_create(NULL, &RNA_Panel, &dummypanel, &dummyptr); - - /* We have to set default context! Else we get a void string... */ - strcpy(dummypt.translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA); - - /* validate the python class */ - if (validate(&dummyptr, data, have_function) != 0) - return NULL; - - if (strlen(identifier) >= sizeof(dummypt.idname)) { - BKE_reportf(reports, RPT_ERROR, "Registering panel class: '%s' is too long, maximum length is %d", - identifier, (int)sizeof(dummypt.idname)); - return NULL; - } - - if ((1 << dummypt.region_type) & RGN_TYPE_HAS_CATEGORY_MASK) { - if (dummypt.category[0] == '\0') { - /* Use a fallback, otherwise an empty value will draw the panel in every category. */ - strcpy(dummypt.category, PNL_CATEGORY_FALLBACK); -#ifndef NDEBUG - printf("Registering panel class: '%s' misses category, please update the script\n", dummypt.idname); -#endif - } - } - else { - if (dummypt.category[0] != '\0') { - if ((1 << dummypt.space_type) & WM_TOOLSYSTEM_SPACE_MASK) { - BKE_reportf(reports, RPT_ERROR, "Registering panel class: '%s' has category '%s' ", - dummypt.idname, dummypt.category); - return NULL; - } - } - } - - if (!(art = region_type_find(reports, dummypt.space_type, dummypt.region_type))) - return NULL; - - /* check if we have registered this panel type before, and remove it */ - for (pt = art->paneltypes.first; pt; pt = pt->next) { - if (STREQ(pt->idname, dummypt.idname)) { - if (pt->ext.srna) - rna_Panel_unregister(bmain, pt->ext.srna); - else - BLI_freelinkN(&art->paneltypes, pt); - break; - } - - if (dummypt.parent_id[0] && STREQ(pt->idname, dummypt.parent_id)) { - parent = pt; - } - } - if (!RNA_struct_available_or_report(reports, dummypt.idname)) { - return NULL; - } - if (!RNA_struct_bl_idname_ok_or_report(reports, dummypt.idname, "_PT_")) { - return NULL; - } - if (dummypt.parent_id[0] && !parent) { - BKE_reportf(reports, RPT_ERROR, "Registering panel class: parent '%s' for '%s' not found", - dummypt.parent_id, dummypt.idname); - return NULL; - } - - /* create a new panel type */ - pt = MEM_callocN(sizeof(PanelType), "python buttons panel"); - memcpy(pt, &dummypt, sizeof(dummypt)); - - pt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, pt->idname, &RNA_Panel); - RNA_def_struct_translation_context(pt->ext.srna, pt->translation_context); - pt->ext.data = data; - pt->ext.call = call; - pt->ext.free = free; - RNA_struct_blender_type_set(pt->ext.srna, pt); - RNA_def_struct_flag(pt->ext.srna, STRUCT_NO_IDPROPERTIES); - - pt->poll = (have_function[0]) ? panel_poll : NULL; - pt->draw = (have_function[1]) ? panel_draw : NULL; - pt->draw_header = (have_function[2]) ? panel_draw_header : NULL; - pt->draw_header_preset = (have_function[3]) ? panel_draw_header_preset : NULL; - - /* XXX use "no header" flag for some ordering of panels until we have real panel ordering */ - if (pt->flag & PNL_NO_HEADER) { - PanelType *pth = art->paneltypes.first; - while (pth && pth->flag & PNL_NO_HEADER) - pth = pth->next; - - if (pth) - BLI_insertlinkbefore(&art->paneltypes, pth, pt); - else - BLI_addtail(&art->paneltypes, pt); - } - else - BLI_addtail(&art->paneltypes, pt); - - if (parent) { - pt->parent = parent; - BLI_addtail(&parent->children, BLI_genericNodeN(pt)); - } - - { - const char *owner_id = RNA_struct_state_owner_get(); - if (owner_id) { - BLI_strncpy(pt->owner_id, owner_id, sizeof(pt->owner_id)); - } - } - - WM_paneltype_add(pt); - - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); - - return pt->ext.srna; + ARegionType *art; + PanelType *pt = RNA_struct_blender_type_get(type); + + if (!pt) + return; + if (!(art = region_type_find(NULL, pt->space_type, pt->region_type))) + return; + + RNA_struct_free_extension(type, &pt->ext); + RNA_struct_free(&BLENDER_RNA, type); + + if (pt->parent) { + LinkData *link = BLI_findptr(&pt->parent->children, pt, offsetof(LinkData, data)); + BLI_freelinkN(&pt->parent->children, link); + } + + WM_paneltype_remove(pt); + + for (LinkData *link = pt->children.first; link; link = link->next) { + PanelType *child_pt = link->data; + child_pt->parent = NULL; + } + + BLI_freelistN(&pt->children); + BLI_freelinkN(&art->paneltypes, pt); + + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); +} + +static StructRNA *rna_Panel_register(Main *bmain, + ReportList *reports, + void *data, + const char *identifier, + StructValidateFunc validate, + StructCallbackFunc call, + StructFreeFunc free) +{ + ARegionType *art; + PanelType *pt, *parent = NULL, dummypt = {NULL}; + Panel dummypanel = {NULL}; + PointerRNA dummyptr; + int have_function[4]; + + /* setup dummy panel & panel type to store static properties in */ + dummypanel.type = &dummypt; + RNA_pointer_create(NULL, &RNA_Panel, &dummypanel, &dummyptr); + + /* We have to set default context! Else we get a void string... */ + strcpy(dummypt.translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA); + + /* validate the python class */ + if (validate(&dummyptr, data, have_function) != 0) + return NULL; + + if (strlen(identifier) >= sizeof(dummypt.idname)) { + BKE_reportf(reports, + RPT_ERROR, + "Registering panel class: '%s' is too long, maximum length is %d", + identifier, + (int)sizeof(dummypt.idname)); + return NULL; + } + + if ((1 << dummypt.region_type) & RGN_TYPE_HAS_CATEGORY_MASK) { + if (dummypt.category[0] == '\0') { + /* Use a fallback, otherwise an empty value will draw the panel in every category. */ + strcpy(dummypt.category, PNL_CATEGORY_FALLBACK); +# ifndef NDEBUG + printf("Registering panel class: '%s' misses category, please update the script\n", + dummypt.idname); +# endif + } + } + else { + if (dummypt.category[0] != '\0') { + if ((1 << dummypt.space_type) & WM_TOOLSYSTEM_SPACE_MASK) { + BKE_reportf(reports, + RPT_ERROR, + "Registering panel class: '%s' has category '%s' ", + dummypt.idname, + dummypt.category); + return NULL; + } + } + } + + if (!(art = region_type_find(reports, dummypt.space_type, dummypt.region_type))) + return NULL; + + /* check if we have registered this panel type before, and remove it */ + for (pt = art->paneltypes.first; pt; pt = pt->next) { + if (STREQ(pt->idname, dummypt.idname)) { + if (pt->ext.srna) + rna_Panel_unregister(bmain, pt->ext.srna); + else + BLI_freelinkN(&art->paneltypes, pt); + break; + } + + if (dummypt.parent_id[0] && STREQ(pt->idname, dummypt.parent_id)) { + parent = pt; + } + } + if (!RNA_struct_available_or_report(reports, dummypt.idname)) { + return NULL; + } + if (!RNA_struct_bl_idname_ok_or_report(reports, dummypt.idname, "_PT_")) { + return NULL; + } + if (dummypt.parent_id[0] && !parent) { + BKE_reportf(reports, + RPT_ERROR, + "Registering panel class: parent '%s' for '%s' not found", + dummypt.parent_id, + dummypt.idname); + return NULL; + } + + /* create a new panel type */ + pt = MEM_callocN(sizeof(PanelType), "python buttons panel"); + memcpy(pt, &dummypt, sizeof(dummypt)); + + pt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, pt->idname, &RNA_Panel); + RNA_def_struct_translation_context(pt->ext.srna, pt->translation_context); + pt->ext.data = data; + pt->ext.call = call; + pt->ext.free = free; + RNA_struct_blender_type_set(pt->ext.srna, pt); + RNA_def_struct_flag(pt->ext.srna, STRUCT_NO_IDPROPERTIES); + + pt->poll = (have_function[0]) ? panel_poll : NULL; + pt->draw = (have_function[1]) ? panel_draw : NULL; + pt->draw_header = (have_function[2]) ? panel_draw_header : NULL; + pt->draw_header_preset = (have_function[3]) ? panel_draw_header_preset : NULL; + + /* XXX use "no header" flag for some ordering of panels until we have real panel ordering */ + if (pt->flag & PNL_NO_HEADER) { + PanelType *pth = art->paneltypes.first; + while (pth && pth->flag & PNL_NO_HEADER) + pth = pth->next; + + if (pth) + BLI_insertlinkbefore(&art->paneltypes, pth, pt); + else + BLI_addtail(&art->paneltypes, pt); + } + else + BLI_addtail(&art->paneltypes, pt); + + if (parent) { + pt->parent = parent; + BLI_addtail(&parent->children, BLI_genericNodeN(pt)); + } + + { + const char *owner_id = RNA_struct_state_owner_get(); + if (owner_id) { + BLI_strncpy(pt->owner_id, owner_id, sizeof(pt->owner_id)); + } + } + + WM_paneltype_add(pt); + + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); + + return pt->ext.srna; } static StructRNA *rna_Panel_refine(PointerRNA *ptr) { - Panel *menu = (Panel *)ptr->data; - return (menu->type && menu->type->ext.srna) ? menu->type->ext.srna : &RNA_Panel; + Panel *menu = (Panel *)ptr->data; + return (menu->type && menu->type->ext.srna) ? menu->type->ext.srna : &RNA_Panel; } /* UIList */ static unsigned int rna_UIList_filter_const_FILTER_ITEM_get(PointerRNA *UNUSED(ptr)) { - return UILST_FLT_ITEM; + return UILST_FLT_ITEM; } static IDProperty *rna_UIList_idprops(PointerRNA *ptr, bool create) { - uiList *ui_list = (uiList *)ptr->data; - if (create && !ui_list->properties) { - IDPropertyTemplate val = {0}; - ui_list->properties = IDP_New(IDP_GROUP, &val, "RNA_UIList IDproperties group"); - } + uiList *ui_list = (uiList *)ptr->data; + if (create && !ui_list->properties) { + IDPropertyTemplate val = {0}; + ui_list->properties = IDP_New(IDP_GROUP, &val, "RNA_UIList IDproperties group"); + } - return ui_list->properties; + return ui_list->properties; } -static void uilist_draw_item(uiList *ui_list, bContext *C, uiLayout *layout, PointerRNA *dataptr, PointerRNA *itemptr, - int icon, PointerRNA *active_dataptr, const char *active_propname, int index, int flt_flag) +static void uilist_draw_item(uiList *ui_list, + bContext *C, + uiLayout *layout, + PointerRNA *dataptr, + PointerRNA *itemptr, + int icon, + PointerRNA *active_dataptr, + const char *active_propname, + int index, + int flt_flag) { - extern FunctionRNA rna_UIList_draw_item_func; + extern FunctionRNA rna_UIList_draw_item_func; - PointerRNA ul_ptr; - ParameterList list; - FunctionRNA *func; + PointerRNA ul_ptr; + ParameterList list; + FunctionRNA *func; - RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr); - func = &rna_UIList_draw_item_func; /* RNA_struct_find_function(&ul_ptr, "draw_item"); */ + RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr); + func = &rna_UIList_draw_item_func; /* RNA_struct_find_function(&ul_ptr, "draw_item"); */ - RNA_parameter_list_create(&list, &ul_ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - RNA_parameter_set_lookup(&list, "layout", &layout); - RNA_parameter_set_lookup(&list, "data", dataptr); - RNA_parameter_set_lookup(&list, "item", itemptr); - RNA_parameter_set_lookup(&list, "icon", &icon); - RNA_parameter_set_lookup(&list, "active_data", active_dataptr); - RNA_parameter_set_lookup(&list, "active_property", &active_propname); - RNA_parameter_set_lookup(&list, "index", &index); - RNA_parameter_set_lookup(&list, "flt_flag", &flt_flag); - ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list); + RNA_parameter_list_create(&list, &ul_ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + RNA_parameter_set_lookup(&list, "layout", &layout); + RNA_parameter_set_lookup(&list, "data", dataptr); + RNA_parameter_set_lookup(&list, "item", itemptr); + RNA_parameter_set_lookup(&list, "icon", &icon); + RNA_parameter_set_lookup(&list, "active_data", active_dataptr); + RNA_parameter_set_lookup(&list, "active_property", &active_propname); + RNA_parameter_set_lookup(&list, "index", &index); + RNA_parameter_set_lookup(&list, "flt_flag", &flt_flag); + ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list); - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); } static void uilist_draw_filter(uiList *ui_list, bContext *C, uiLayout *layout) { - extern FunctionRNA rna_UIList_draw_filter_func; - - PointerRNA ul_ptr; - ParameterList list; - FunctionRNA *func; - - RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr); - func = &rna_UIList_draw_filter_func; /* RNA_struct_find_function(&ul_ptr, "draw_filter"); */ - - RNA_parameter_list_create(&list, &ul_ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - RNA_parameter_set_lookup(&list, "layout", &layout); - ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list); - - RNA_parameter_list_free(&list); -} - -static void uilist_filter_items(uiList *ui_list, bContext *C, PointerRNA *dataptr, const char *propname) -{ - extern FunctionRNA rna_UIList_filter_items_func; - - PointerRNA ul_ptr; - ParameterList list; - FunctionRNA *func; - PropertyRNA *parm; - - uiListDyn *flt_data = ui_list->dyn_data; - int *filter_flags, *filter_neworder; - void *ret1, *ret2; - int ret_len; - int len = flt_data->items_len = RNA_collection_length(dataptr, propname); - - RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr); - func = &rna_UIList_filter_items_func; /* RNA_struct_find_function(&ul_ptr, "filter_items"); */ - - RNA_parameter_list_create(&list, &ul_ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - RNA_parameter_set_lookup(&list, "data", dataptr); - RNA_parameter_set_lookup(&list, "property", &propname); - - ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list); - - parm = RNA_function_find_parameter(NULL, func, "filter_flags"); - ret_len = RNA_parameter_dynamic_length_get(&list, parm); - if (ret_len != len && ret_len != 0) { - printf("%s: Error, py func returned %d items in %s, %d or none were expected.\n", __func__, - RNA_parameter_dynamic_length_get(&list, parm), "filter_flags", len); - /* Note: we cannot return here, we would let flt_data in inconsistent state... see T38356. */ - filter_flags = NULL; - } - else { - RNA_parameter_get(&list, parm, &ret1); - filter_flags = (int *)ret1; - } - - parm = RNA_function_find_parameter(NULL, func, "filter_neworder"); - ret_len = RNA_parameter_dynamic_length_get(&list, parm); - if (ret_len != len && ret_len != 0) { - printf("%s: Error, py func returned %d items in %s, %d or none were expected.\n", __func__, - RNA_parameter_dynamic_length_get(&list, parm), "filter_neworder", len); - /* Note: we cannot return here, we would let flt_data in inconsistent state... see T38356. */ - filter_neworder = NULL; - } - else { - RNA_parameter_get(&list, parm, &ret2); - filter_neworder = (int *)ret2; - } - - /* We have to do some final checks and transforms... */ - { - int i, filter_exclude = ui_list->filter_flag & UILST_FLT_EXCLUDE; - if (filter_flags) { - flt_data->items_filter_flags = MEM_mallocN(sizeof(int) * len, __func__); - memcpy(flt_data->items_filter_flags, filter_flags, sizeof(int) * len); - - if (filter_neworder) { - /* For sake of simplicity, py filtering is expected to filter all items, but we actually only want - * reordering data for shown items! - */ - int items_shown, shown_idx; - int t_idx, t_ni, prev_ni; - flt_data->items_shown = 0; - for (i = 0, shown_idx = 0; i < len; i++) { - if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) { - filter_neworder[shown_idx++] = filter_neworder[i]; - } - } - items_shown = flt_data->items_shown = shown_idx; - flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * items_shown, __func__); - /* And now, bring back new indices into the [0, items_shown[ range! - * XXX This is O(N²)... :/ - */ - for (shown_idx = 0, prev_ni = -1; shown_idx < items_shown; shown_idx++) { - for (i = 0, t_ni = len, t_idx = -1; i < items_shown; i++) { - int ni = filter_neworder[i]; - if (ni > prev_ni && ni < t_ni) { - t_idx = i; - t_ni = ni; - } - } - if (t_idx >= 0) { - prev_ni = t_ni; - flt_data->items_filter_neworder[t_idx] = shown_idx; - } - } - } - else { - /* we still have to set flt_data->items_shown... */ - flt_data->items_shown = 0; - for (i = 0; i < len; i++) { - if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) { - flt_data->items_shown++; - } - } - } - } - else { - flt_data->items_shown = len; - - if (filter_neworder) { - flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * len, __func__); - memcpy(flt_data->items_filter_neworder, filter_neworder, sizeof(int) * len); - } - } - } - - RNA_parameter_list_free(&list); + extern FunctionRNA rna_UIList_draw_filter_func; + + PointerRNA ul_ptr; + ParameterList list; + FunctionRNA *func; + + RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr); + func = &rna_UIList_draw_filter_func; /* RNA_struct_find_function(&ul_ptr, "draw_filter"); */ + + RNA_parameter_list_create(&list, &ul_ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + RNA_parameter_set_lookup(&list, "layout", &layout); + ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list); + + RNA_parameter_list_free(&list); +} + +static void uilist_filter_items(uiList *ui_list, + bContext *C, + PointerRNA *dataptr, + const char *propname) +{ + extern FunctionRNA rna_UIList_filter_items_func; + + PointerRNA ul_ptr; + ParameterList list; + FunctionRNA *func; + PropertyRNA *parm; + + uiListDyn *flt_data = ui_list->dyn_data; + int *filter_flags, *filter_neworder; + void *ret1, *ret2; + int ret_len; + int len = flt_data->items_len = RNA_collection_length(dataptr, propname); + + RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr); + func = &rna_UIList_filter_items_func; /* RNA_struct_find_function(&ul_ptr, "filter_items"); */ + + RNA_parameter_list_create(&list, &ul_ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + RNA_parameter_set_lookup(&list, "data", dataptr); + RNA_parameter_set_lookup(&list, "property", &propname); + + ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list); + + parm = RNA_function_find_parameter(NULL, func, "filter_flags"); + ret_len = RNA_parameter_dynamic_length_get(&list, parm); + if (ret_len != len && ret_len != 0) { + printf("%s: Error, py func returned %d items in %s, %d or none were expected.\n", + __func__, + RNA_parameter_dynamic_length_get(&list, parm), + "filter_flags", + len); + /* Note: we cannot return here, we would let flt_data in inconsistent state... see T38356. */ + filter_flags = NULL; + } + else { + RNA_parameter_get(&list, parm, &ret1); + filter_flags = (int *)ret1; + } + + parm = RNA_function_find_parameter(NULL, func, "filter_neworder"); + ret_len = RNA_parameter_dynamic_length_get(&list, parm); + if (ret_len != len && ret_len != 0) { + printf("%s: Error, py func returned %d items in %s, %d or none were expected.\n", + __func__, + RNA_parameter_dynamic_length_get(&list, parm), + "filter_neworder", + len); + /* Note: we cannot return here, we would let flt_data in inconsistent state... see T38356. */ + filter_neworder = NULL; + } + else { + RNA_parameter_get(&list, parm, &ret2); + filter_neworder = (int *)ret2; + } + + /* We have to do some final checks and transforms... */ + { + int i, filter_exclude = ui_list->filter_flag & UILST_FLT_EXCLUDE; + if (filter_flags) { + flt_data->items_filter_flags = MEM_mallocN(sizeof(int) * len, __func__); + memcpy(flt_data->items_filter_flags, filter_flags, sizeof(int) * len); + + if (filter_neworder) { + /* For sake of simplicity, py filtering is expected to filter all items, but we actually only want + * reordering data for shown items! + */ + int items_shown, shown_idx; + int t_idx, t_ni, prev_ni; + flt_data->items_shown = 0; + for (i = 0, shown_idx = 0; i < len; i++) { + if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) { + filter_neworder[shown_idx++] = filter_neworder[i]; + } + } + items_shown = flt_data->items_shown = shown_idx; + flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * items_shown, __func__); + /* And now, bring back new indices into the [0, items_shown[ range! + * XXX This is O(N²)... :/ + */ + for (shown_idx = 0, prev_ni = -1; shown_idx < items_shown; shown_idx++) { + for (i = 0, t_ni = len, t_idx = -1; i < items_shown; i++) { + int ni = filter_neworder[i]; + if (ni > prev_ni && ni < t_ni) { + t_idx = i; + t_ni = ni; + } + } + if (t_idx >= 0) { + prev_ni = t_ni; + flt_data->items_filter_neworder[t_idx] = shown_idx; + } + } + } + else { + /* we still have to set flt_data->items_shown... */ + flt_data->items_shown = 0; + for (i = 0; i < len; i++) { + if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) { + flt_data->items_shown++; + } + } + } + } + else { + flt_data->items_shown = len; + + if (filter_neworder) { + flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * len, __func__); + memcpy(flt_data->items_filter_neworder, filter_neworder, sizeof(int) * len); + } + } + } + + RNA_parameter_list_free(&list); } static void rna_UIList_unregister(Main *UNUSED(bmain), StructRNA *type) { - uiListType *ult = RNA_struct_blender_type_get(type); + uiListType *ult = RNA_struct_blender_type_get(type); - if (!ult) - return; + if (!ult) + return; - RNA_struct_free_extension(type, &ult->ext); - RNA_struct_free(&BLENDER_RNA, type); + RNA_struct_free_extension(type, &ult->ext); + RNA_struct_free(&BLENDER_RNA, type); - WM_uilisttype_freelink(ult); + WM_uilisttype_freelink(ult); - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); } -static StructRNA *rna_UIList_register( - Main *bmain, ReportList *reports, void *data, const char *identifier, - StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free) +static StructRNA *rna_UIList_register(Main *bmain, + ReportList *reports, + void *data, + const char *identifier, + StructValidateFunc validate, + StructCallbackFunc call, + StructFreeFunc free) { - uiListType *ult, dummyult = {NULL}; - uiList dummyuilist = {NULL}; - PointerRNA dummyul_ptr; - int have_function[3]; - size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */ + uiListType *ult, dummyult = {NULL}; + uiList dummyuilist = {NULL}; + PointerRNA dummyul_ptr; + int have_function[3]; + size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */ - /* setup dummy menu & menu type to store static properties in */ - dummyuilist.type = &dummyult; - RNA_pointer_create(NULL, &RNA_UIList, &dummyuilist, &dummyul_ptr); + /* setup dummy menu & menu type to store static properties in */ + dummyuilist.type = &dummyult; + RNA_pointer_create(NULL, &RNA_UIList, &dummyuilist, &dummyul_ptr); - /* validate the python class */ - if (validate(&dummyul_ptr, data, have_function) != 0) - return NULL; + /* validate the python class */ + if (validate(&dummyul_ptr, data, have_function) != 0) + return NULL; - if (strlen(identifier) >= sizeof(dummyult.idname)) { - BKE_reportf(reports, RPT_ERROR, "Registering uilist class: '%s' is too long, maximum length is %d", - identifier, (int)sizeof(dummyult.idname)); - return NULL; - } + if (strlen(identifier) >= sizeof(dummyult.idname)) { + BKE_reportf(reports, + RPT_ERROR, + "Registering uilist class: '%s' is too long, maximum length is %d", + identifier, + (int)sizeof(dummyult.idname)); + return NULL; + } - /* check if we have registered this uilist type before, and remove it */ - ult = WM_uilisttype_find(dummyult.idname, true); - if (ult && ult->ext.srna) { - rna_UIList_unregister(bmain, ult->ext.srna); - } - if (!RNA_struct_available_or_report(reports, dummyult.idname)) { - return NULL; - } - if (!RNA_struct_bl_idname_ok_or_report(reports, dummyult.idname, "_UL_")) { - return NULL; - } + /* check if we have registered this uilist type before, and remove it */ + ult = WM_uilisttype_find(dummyult.idname, true); + if (ult && ult->ext.srna) { + rna_UIList_unregister(bmain, ult->ext.srna); + } + if (!RNA_struct_available_or_report(reports, dummyult.idname)) { + return NULL; + } + if (!RNA_struct_bl_idname_ok_or_report(reports, dummyult.idname, "_UL_")) { + return NULL; + } - /* create a new menu type */ - ult = MEM_callocN(sizeof(uiListType) + over_alloc, "python uilist"); - memcpy(ult, &dummyult, sizeof(dummyult)); + /* create a new menu type */ + ult = MEM_callocN(sizeof(uiListType) + over_alloc, "python uilist"); + memcpy(ult, &dummyult, sizeof(dummyult)); - ult->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ult->idname, &RNA_UIList); - ult->ext.data = data; - ult->ext.call = call; - ult->ext.free = free; - RNA_struct_blender_type_set(ult->ext.srna, ult); + ult->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ult->idname, &RNA_UIList); + ult->ext.data = data; + ult->ext.call = call; + ult->ext.free = free; + RNA_struct_blender_type_set(ult->ext.srna, ult); - ult->draw_item = (have_function[0]) ? uilist_draw_item : NULL; - ult->draw_filter = (have_function[1]) ? uilist_draw_filter : NULL; - ult->filter_items = (have_function[2]) ? uilist_filter_items : NULL; + ult->draw_item = (have_function[0]) ? uilist_draw_item : NULL; + ult->draw_filter = (have_function[1]) ? uilist_draw_filter : NULL; + ult->filter_items = (have_function[2]) ? uilist_filter_items : NULL; - WM_uilisttype_add(ult); + WM_uilisttype_add(ult); - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); - return ult->ext.srna; + return ult->ext.srna; } static StructRNA *rna_UIList_refine(PointerRNA *ptr) { - uiList *ui_list = (uiList *)ptr->data; - return (ui_list->type && ui_list->type->ext.srna) ? ui_list->type->ext.srna : &RNA_UIList; + uiList *ui_list = (uiList *)ptr->data; + return (ui_list->type && ui_list->type->ext.srna) ? ui_list->type->ext.srna : &RNA_UIList; } /* Header */ static void header_draw(const bContext *C, Header *hdr) { - extern FunctionRNA rna_Header_draw_func; + extern FunctionRNA rna_Header_draw_func; - PointerRNA htr; - ParameterList list; - FunctionRNA *func; + PointerRNA htr; + ParameterList list; + FunctionRNA *func; - RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &htr); - func = &rna_Header_draw_func; /* RNA_struct_find_function(&htr, "draw"); */ + RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &htr); + func = &rna_Header_draw_func; /* RNA_struct_find_function(&htr, "draw"); */ - RNA_parameter_list_create(&list, &htr, func); - RNA_parameter_set_lookup(&list, "context", &C); - hdr->type->ext.call((bContext *)C, &htr, func, &list); + RNA_parameter_list_create(&list, &htr, func); + RNA_parameter_set_lookup(&list, "context", &C); + hdr->type->ext.call((bContext *)C, &htr, func, &list); - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); } static void rna_Header_unregister(Main *UNUSED(bmain), StructRNA *type) { - ARegionType *art; - HeaderType *ht = RNA_struct_blender_type_get(type); - - if (!ht) - return; - if (!(art = region_type_find(NULL, ht->space_type, ht->region_type))) - return; - - RNA_struct_free_extension(type, &ht->ext); - RNA_struct_free(&BLENDER_RNA, type); - - BLI_freelinkN(&art->headertypes, ht); - - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); -} - -static StructRNA *rna_Header_register( - Main *bmain, ReportList *reports, void *data, const char *identifier, - StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free) -{ - ARegionType *art; - HeaderType *ht, dummyht = {NULL}; - Header dummyheader = {NULL}; - PointerRNA dummyhtr; - int have_function[1]; - - /* setup dummy header & header type to store static properties in */ - dummyheader.type = &dummyht; - dummyht.region_type = RGN_TYPE_HEADER; /* RGN_TYPE_HEADER by default, may be overridden */ - RNA_pointer_create(NULL, &RNA_Header, &dummyheader, &dummyhtr); - - /* validate the python class */ - if (validate(&dummyhtr, data, have_function) != 0) - return NULL; - - if (strlen(identifier) >= sizeof(dummyht.idname)) { - BKE_reportf(reports, RPT_ERROR, "Registering header class: '%s' is too long, maximum length is %d", - identifier, (int)sizeof(dummyht.idname)); - return NULL; - } - - if (!(art = region_type_find(reports, dummyht.space_type, dummyht.region_type))) - return NULL; - - /* check if we have registered this header type before, and remove it */ - for (ht = art->headertypes.first; ht; ht = ht->next) { - if (STREQ(ht->idname, dummyht.idname)) { - if (ht->ext.srna) - rna_Header_unregister(bmain, ht->ext.srna); - break; - } - } - if (!RNA_struct_available_or_report(reports, dummyht.idname)) { - return NULL; - } - if (!RNA_struct_bl_idname_ok_or_report(reports, dummyht.idname, "_HT_")) { - return NULL; - } - - /* create a new header type */ - ht = MEM_callocN(sizeof(HeaderType), "python buttons header"); - memcpy(ht, &dummyht, sizeof(dummyht)); - - ht->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ht->idname, &RNA_Header); - ht->ext.data = data; - ht->ext.call = call; - ht->ext.free = free; - RNA_struct_blender_type_set(ht->ext.srna, ht); - - ht->draw = (have_function[0]) ? header_draw : NULL; - - BLI_addtail(&art->headertypes, ht); - - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); - - return ht->ext.srna; + ARegionType *art; + HeaderType *ht = RNA_struct_blender_type_get(type); + + if (!ht) + return; + if (!(art = region_type_find(NULL, ht->space_type, ht->region_type))) + return; + + RNA_struct_free_extension(type, &ht->ext); + RNA_struct_free(&BLENDER_RNA, type); + + BLI_freelinkN(&art->headertypes, ht); + + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); +} + +static StructRNA *rna_Header_register(Main *bmain, + ReportList *reports, + void *data, + const char *identifier, + StructValidateFunc validate, + StructCallbackFunc call, + StructFreeFunc free) +{ + ARegionType *art; + HeaderType *ht, dummyht = {NULL}; + Header dummyheader = {NULL}; + PointerRNA dummyhtr; + int have_function[1]; + + /* setup dummy header & header type to store static properties in */ + dummyheader.type = &dummyht; + dummyht.region_type = RGN_TYPE_HEADER; /* RGN_TYPE_HEADER by default, may be overridden */ + RNA_pointer_create(NULL, &RNA_Header, &dummyheader, &dummyhtr); + + /* validate the python class */ + if (validate(&dummyhtr, data, have_function) != 0) + return NULL; + + if (strlen(identifier) >= sizeof(dummyht.idname)) { + BKE_reportf(reports, + RPT_ERROR, + "Registering header class: '%s' is too long, maximum length is %d", + identifier, + (int)sizeof(dummyht.idname)); + return NULL; + } + + if (!(art = region_type_find(reports, dummyht.space_type, dummyht.region_type))) + return NULL; + + /* check if we have registered this header type before, and remove it */ + for (ht = art->headertypes.first; ht; ht = ht->next) { + if (STREQ(ht->idname, dummyht.idname)) { + if (ht->ext.srna) + rna_Header_unregister(bmain, ht->ext.srna); + break; + } + } + if (!RNA_struct_available_or_report(reports, dummyht.idname)) { + return NULL; + } + if (!RNA_struct_bl_idname_ok_or_report(reports, dummyht.idname, "_HT_")) { + return NULL; + } + + /* create a new header type */ + ht = MEM_callocN(sizeof(HeaderType), "python buttons header"); + memcpy(ht, &dummyht, sizeof(dummyht)); + + ht->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ht->idname, &RNA_Header); + ht->ext.data = data; + ht->ext.call = call; + ht->ext.free = free; + RNA_struct_blender_type_set(ht->ext.srna, ht); + + ht->draw = (have_function[0]) ? header_draw : NULL; + + BLI_addtail(&art->headertypes, ht); + + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); + + return ht->ext.srna; } static StructRNA *rna_Header_refine(PointerRNA *htr) { - Header *hdr = (Header *)htr->data; - return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Header; + Header *hdr = (Header *)htr->data; + return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Header; } /* Menu */ static bool menu_poll(const bContext *C, MenuType *pt) { - extern FunctionRNA rna_Menu_poll_func; + extern FunctionRNA rna_Menu_poll_func; - PointerRNA ptr; - ParameterList list; - FunctionRNA *func; - void *ret; - bool visible; + PointerRNA ptr; + ParameterList list; + FunctionRNA *func; + void *ret; + bool visible; - RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */ - func = &rna_Menu_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */ + RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */ + func = &rna_Menu_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */ - RNA_parameter_list_create(&list, &ptr, func); - RNA_parameter_set_lookup(&list, "context", &C); - pt->ext.call((bContext *)C, &ptr, func, &list); + RNA_parameter_list_create(&list, &ptr, func); + RNA_parameter_set_lookup(&list, "context", &C); + pt->ext.call((bContext *)C, &ptr, func, &list); - RNA_parameter_get_lookup(&list, "visible", &ret); - visible = *(bool *)ret; + RNA_parameter_get_lookup(&list, "visible", &ret); + visible = *(bool *)ret; - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); - return visible; + return visible; } static void menu_draw(const bContext *C, Menu *menu) { - extern FunctionRNA rna_Menu_draw_func; + extern FunctionRNA rna_Menu_draw_func; - PointerRNA mtr; - ParameterList list; - FunctionRNA *func; + PointerRNA mtr; + ParameterList list; + FunctionRNA *func; - RNA_pointer_create(&CTX_wm_screen(C)->id, menu->type->ext.srna, menu, &mtr); - func = &rna_Menu_draw_func; /* RNA_struct_find_function(&mtr, "draw"); */ + RNA_pointer_create(&CTX_wm_screen(C)->id, menu->type->ext.srna, menu, &mtr); + func = &rna_Menu_draw_func; /* RNA_struct_find_function(&mtr, "draw"); */ - RNA_parameter_list_create(&list, &mtr, func); - RNA_parameter_set_lookup(&list, "context", &C); - menu->type->ext.call((bContext *)C, &mtr, func, &list); + RNA_parameter_list_create(&list, &mtr, func); + RNA_parameter_set_lookup(&list, "context", &C); + menu->type->ext.call((bContext *)C, &mtr, func, &list); - RNA_parameter_list_free(&list); + RNA_parameter_list_free(&list); } static void rna_Menu_unregister(Main *UNUSED(bmain), StructRNA *type) { - MenuType *mt = RNA_struct_blender_type_get(type); - - if (!mt) - return; - - RNA_struct_free_extension(type, &mt->ext); - RNA_struct_free(&BLENDER_RNA, type); - - WM_menutype_freelink(mt); - - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); -} - -static StructRNA *rna_Menu_register( - Main *bmain, ReportList *reports, void *data, const char *identifier, - StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free) -{ - MenuType *mt, dummymt = {NULL}; - Menu dummymenu = {NULL}; - PointerRNA dummymtr; - int have_function[2]; - size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */ - size_t description_size = 0; - char _menu_descr[RNA_DYN_DESCR_MAX]; - - /* setup dummy menu & menu type to store static properties in */ - dummymenu.type = &dummymt; - _menu_descr[0] = '\0'; - dummymenu.type->description = _menu_descr; - RNA_pointer_create(NULL, &RNA_Menu, &dummymenu, &dummymtr); - - /* We have to set default context! Else we get a void string... */ - strcpy(dummymt.translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA); - - /* validate the python class */ - if (validate(&dummymtr, data, have_function) != 0) - return NULL; - - if (strlen(identifier) >= sizeof(dummymt.idname)) { - BKE_reportf(reports, RPT_ERROR, "Registering menu class: '%s' is too long, maximum length is %d", - identifier, (int)sizeof(dummymt.idname)); - return NULL; - } - - /* check if we have registered this menu type before, and remove it */ - mt = WM_menutype_find(dummymt.idname, true); - if (mt && mt->ext.srna) { - rna_Menu_unregister(bmain, mt->ext.srna); - } - if (!RNA_struct_available_or_report(reports, dummymt.idname)) { - return NULL; - } - if (!RNA_struct_bl_idname_ok_or_report(reports, dummymt.idname, "_MT_")) { - return NULL; - } - - /* create a new menu type */ - if (_menu_descr[0]) { - description_size = strlen(_menu_descr) + 1; - over_alloc += description_size; - } - - mt = MEM_callocN(sizeof(MenuType) + over_alloc, "python buttons menu"); - memcpy(mt, &dummymt, sizeof(dummymt)); - - if (_menu_descr[0]) { - char *buf = (char *)(mt + 1); - memcpy(buf, _menu_descr, description_size); - mt->description = buf; - } - else { - mt->description = NULL; - } - - mt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, mt->idname, &RNA_Menu); - RNA_def_struct_translation_context(mt->ext.srna, mt->translation_context); - mt->ext.data = data; - mt->ext.call = call; - mt->ext.free = free; - RNA_struct_blender_type_set(mt->ext.srna, mt); - RNA_def_struct_flag(mt->ext.srna, STRUCT_NO_IDPROPERTIES); - - mt->poll = (have_function[0]) ? menu_poll : NULL; - mt->draw = (have_function[1]) ? menu_draw : NULL; - - { - const char *owner_id = RNA_struct_state_owner_get(); - if (owner_id) { - BLI_strncpy(mt->owner_id, owner_id, sizeof(mt->owner_id)); - } - } - - WM_menutype_add(mt); - - /* update while blender is running */ - WM_main_add_notifier(NC_WINDOW, NULL); - - return mt->ext.srna; + MenuType *mt = RNA_struct_blender_type_get(type); + + if (!mt) + return; + + RNA_struct_free_extension(type, &mt->ext); + RNA_struct_free(&BLENDER_RNA, type); + + WM_menutype_freelink(mt); + + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); +} + +static StructRNA *rna_Menu_register(Main *bmain, + ReportList *reports, + void *data, + const char *identifier, + StructValidateFunc validate, + StructCallbackFunc call, + StructFreeFunc free) +{ + MenuType *mt, dummymt = {NULL}; + Menu dummymenu = {NULL}; + PointerRNA dummymtr; + int have_function[2]; + size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */ + size_t description_size = 0; + char _menu_descr[RNA_DYN_DESCR_MAX]; + + /* setup dummy menu & menu type to store static properties in */ + dummymenu.type = &dummymt; + _menu_descr[0] = '\0'; + dummymenu.type->description = _menu_descr; + RNA_pointer_create(NULL, &RNA_Menu, &dummymenu, &dummymtr); + + /* We have to set default context! Else we get a void string... */ + strcpy(dummymt.translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA); + + /* validate the python class */ + if (validate(&dummymtr, data, have_function) != 0) + return NULL; + + if (strlen(identifier) >= sizeof(dummymt.idname)) { + BKE_reportf(reports, + RPT_ERROR, + "Registering menu class: '%s' is too long, maximum length is %d", + identifier, + (int)sizeof(dummymt.idname)); + return NULL; + } + + /* check if we have registered this menu type before, and remove it */ + mt = WM_menutype_find(dummymt.idname, true); + if (mt && mt->ext.srna) { + rna_Menu_unregister(bmain, mt->ext.srna); + } + if (!RNA_struct_available_or_report(reports, dummymt.idname)) { + return NULL; + } + if (!RNA_struct_bl_idname_ok_or_report(reports, dummymt.idname, "_MT_")) { + return NULL; + } + + /* create a new menu type */ + if (_menu_descr[0]) { + description_size = strlen(_menu_descr) + 1; + over_alloc += description_size; + } + + mt = MEM_callocN(sizeof(MenuType) + over_alloc, "python buttons menu"); + memcpy(mt, &dummymt, sizeof(dummymt)); + + if (_menu_descr[0]) { + char *buf = (char *)(mt + 1); + memcpy(buf, _menu_descr, description_size); + mt->description = buf; + } + else { + mt->description = NULL; + } + + mt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, mt->idname, &RNA_Menu); + RNA_def_struct_translation_context(mt->ext.srna, mt->translation_context); + mt->ext.data = data; + mt->ext.call = call; + mt->ext.free = free; + RNA_struct_blender_type_set(mt->ext.srna, mt); + RNA_def_struct_flag(mt->ext.srna, STRUCT_NO_IDPROPERTIES); + + mt->poll = (have_function[0]) ? menu_poll : NULL; + mt->draw = (have_function[1]) ? menu_draw : NULL; + + { + const char *owner_id = RNA_struct_state_owner_get(); + if (owner_id) { + BLI_strncpy(mt->owner_id, owner_id, sizeof(mt->owner_id)); + } + } + + WM_menutype_add(mt); + + /* update while blender is running */ + WM_main_add_notifier(NC_WINDOW, NULL); + + return mt->ext.srna; } static StructRNA *rna_Menu_refine(PointerRNA *mtr) { - Menu *menu = (Menu *)mtr->data; - return (menu->type && menu->type->ext.srna) ? menu->type->ext.srna : &RNA_Menu; + Menu *menu = (Menu *)mtr->data; + return (menu->type && menu->type->ext.srna) ? menu->type->ext.srna : &RNA_Menu; } static void rna_Menu_bl_description_set(PointerRNA *ptr, const char *value) { - Menu *data = (Menu *)(ptr->data); - char *str = (char *)data->type->description; - if (!str[0]) BLI_strncpy(str, value, RNA_DYN_DESCR_MAX); /* utf8 already ensured */ - else assert(!"setting the bl_description on a non-builtin menu"); + Menu *data = (Menu *)(ptr->data); + char *str = (char *)data->type->description; + if (!str[0]) + BLI_strncpy(str, value, RNA_DYN_DESCR_MAX); /* utf8 already ensured */ + else + assert(!"setting the bl_description on a non-builtin menu"); } /* UILayout */ static bool rna_UILayout_active_get(PointerRNA *ptr) { - return uiLayoutGetActive(ptr->data); + return uiLayoutGetActive(ptr->data); } static void rna_UILayout_active_set(PointerRNA *ptr, bool value) { - uiLayoutSetActive(ptr->data, value); + uiLayoutSetActive(ptr->data, value); } static bool rna_UILayout_active_default_get(PointerRNA *ptr) { - return uiLayoutGetActiveDefault(ptr->data); + return uiLayoutGetActiveDefault(ptr->data); } static void rna_UILayout_active_default_set(PointerRNA *ptr, bool value) { - uiLayoutSetActiveDefault(ptr->data, value); + uiLayoutSetActiveDefault(ptr->data, value); } static bool rna_UILayout_activate_init_get(PointerRNA *ptr) { - return uiLayoutGetActivateInit(ptr->data); + return uiLayoutGetActivateInit(ptr->data); } static void rna_UILayout_activate_init_set(PointerRNA *ptr, bool value) { - uiLayoutSetActivateInit(ptr->data, value); + uiLayoutSetActivateInit(ptr->data, value); } static bool rna_UILayout_alert_get(PointerRNA *ptr) { - return uiLayoutGetRedAlert(ptr->data); + return uiLayoutGetRedAlert(ptr->data); } static void rna_UILayout_alert_set(PointerRNA *ptr, bool value) { - uiLayoutSetRedAlert(ptr->data, value); + uiLayoutSetRedAlert(ptr->data, value); } static void rna_UILayout_op_context_set(PointerRNA *ptr, int value) { - uiLayoutSetOperatorContext(ptr->data, value); + uiLayoutSetOperatorContext(ptr->data, value); } static int rna_UILayout_op_context_get(PointerRNA *ptr) { - return uiLayoutGetOperatorContext(ptr->data); + return uiLayoutGetOperatorContext(ptr->data); } static bool rna_UILayout_enabled_get(PointerRNA *ptr) { - return uiLayoutGetEnabled(ptr->data); + return uiLayoutGetEnabled(ptr->data); } static void rna_UILayout_enabled_set(PointerRNA *ptr, bool value) { - uiLayoutSetEnabled(ptr->data, value); + uiLayoutSetEnabled(ptr->data, value); } -#if 0 +# if 0 static int rna_UILayout_red_alert_get(PointerRNA *ptr) { - return uiLayoutGetRedAlert(ptr->data); + return uiLayoutGetRedAlert(ptr->data); } static void rna_UILayout_red_alert_set(PointerRNA *ptr, bool value) { - uiLayoutSetRedAlert(ptr->data, value); + uiLayoutSetRedAlert(ptr->data, value); } static bool rna_UILayout_keep_aspect_get(PointerRNA *ptr) { - return uiLayoutGetKeepAspect(ptr->data); + return uiLayoutGetKeepAspect(ptr->data); } static void rna_UILayout_keep_aspect_set(PointerRNA *ptr, int value) { - uiLayoutSetKeepAspect(ptr->data, value); + uiLayoutSetKeepAspect(ptr->data, value); } -#endif +# endif static int rna_UILayout_alignment_get(PointerRNA *ptr) { - return uiLayoutGetAlignment(ptr->data); + return uiLayoutGetAlignment(ptr->data); } static void rna_UILayout_alignment_set(PointerRNA *ptr, int value) { - uiLayoutSetAlignment(ptr->data, value); + uiLayoutSetAlignment(ptr->data, value); } static int rna_UILayout_direction_get(PointerRNA *ptr) { - return uiLayoutGetLocalDir(ptr->data); + return uiLayoutGetLocalDir(ptr->data); } static float rna_UILayout_scale_x_get(PointerRNA *ptr) { - return uiLayoutGetScaleX(ptr->data); + return uiLayoutGetScaleX(ptr->data); } static void rna_UILayout_scale_x_set(PointerRNA *ptr, float value) { - uiLayoutSetScaleX(ptr->data, value); + uiLayoutSetScaleX(ptr->data, value); } static float rna_UILayout_scale_y_get(PointerRNA *ptr) { - return uiLayoutGetScaleY(ptr->data); + return uiLayoutGetScaleY(ptr->data); } static void rna_UILayout_scale_y_set(PointerRNA *ptr, float value) { - uiLayoutSetScaleY(ptr->data, value); + uiLayoutSetScaleY(ptr->data, value); } static float rna_UILayout_units_x_get(PointerRNA *ptr) { - return uiLayoutGetUnitsX(ptr->data); + return uiLayoutGetUnitsX(ptr->data); } static void rna_UILayout_units_x_set(PointerRNA *ptr, float value) { - uiLayoutSetUnitsX(ptr->data, value); + uiLayoutSetUnitsX(ptr->data, value); } static float rna_UILayout_units_y_get(PointerRNA *ptr) { - return uiLayoutGetUnitsY(ptr->data); + return uiLayoutGetUnitsY(ptr->data); } static void rna_UILayout_units_y_set(PointerRNA *ptr, float value) { - uiLayoutSetUnitsY(ptr->data, value); + uiLayoutSetUnitsY(ptr->data, value); } static int rna_UILayout_emboss_get(PointerRNA *ptr) { - return uiLayoutGetEmboss(ptr->data); + return uiLayoutGetEmboss(ptr->data); } static void rna_UILayout_emboss_set(PointerRNA *ptr, int value) { - uiLayoutSetEmboss(ptr->data, value); + uiLayoutSetEmboss(ptr->data, value); } static bool rna_UILayout_property_split_get(PointerRNA *ptr) { - return uiLayoutGetPropSep(ptr->data); + return uiLayoutGetPropSep(ptr->data); } static void rna_UILayout_property_split_set(PointerRNA *ptr, bool value) { - uiLayoutSetPropSep(ptr->data, value); + uiLayoutSetPropSep(ptr->data, value); } static bool rna_UILayout_property_decorate_get(PointerRNA *ptr) { - return uiLayoutGetPropDecorate(ptr->data); + return uiLayoutGetPropDecorate(ptr->data); } static void rna_UILayout_property_decorate_set(PointerRNA *ptr, bool value) { - uiLayoutSetPropDecorate(ptr->data, value); + uiLayoutSetPropDecorate(ptr->data, value); } #else /* RNA_RUNTIME */ static void rna_def_ui_layout(BlenderRNA *brna) { - StructRNA *srna; - PropertyRNA *prop; - - static const EnumPropertyItem alignment_items[] = { - {UI_LAYOUT_ALIGN_EXPAND, "EXPAND", 0, "Expand", ""}, - {UI_LAYOUT_ALIGN_LEFT, "LEFT", 0, "Left", ""}, - {UI_LAYOUT_ALIGN_CENTER, "CENTER", 0, "Center", ""}, - {UI_LAYOUT_ALIGN_RIGHT, "RIGHT", 0, "Right", ""}, - {0, NULL, 0, NULL, NULL}, - }; - - static const EnumPropertyItem direction_items[] = { - {UI_LAYOUT_HORIZONTAL, "HORIZONTAL", 0, "Horizontal", ""}, - {UI_LAYOUT_VERTICAL, "VERTICAL", 0, "Vertical", ""}, - {0, NULL, 0, NULL, NULL}, - }; - - static const EnumPropertyItem emboss_items[] = { - {UI_EMBOSS, "NORMAL", 0, "Regular", "Draw standard button emboss style"}, - {UI_EMBOSS_NONE, "NONE", 0, "None", "Draw only text and icons"}, - {UI_EMBOSS_PULLDOWN, "PULLDOWN_MENU", 0, "Pulldown Menu", "Draw pulldown menu style"}, - {UI_EMBOSS_RADIAL, "RADIAL_MENU", 0, "Radial Menu", "Draw radial menu style"}, - {0, NULL, 0, NULL, NULL}, - }; - - /* layout */ - - srna = RNA_def_struct(brna, "UILayout", NULL); - RNA_def_struct_sdna(srna, "uiLayout"); - RNA_def_struct_ui_text(srna, "UI Layout", "User interface layout in a panel or header"); - - prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_active_get", "rna_UILayout_active_set"); - - prop = RNA_def_property(srna, "active_default", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_active_default_get", "rna_UILayout_active_default_set"); - RNA_def_property_ui_text( - prop, "Active Default", - "When true, an operator button defined after this will be activated when pressing return" - "(use with popup dialogs)"); - - prop = RNA_def_property(srna, "activate_init", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_activate_init_get", "rna_UILayout_activate_init_set"); - RNA_def_property_ui_text( - prop, "Activate on Init", - "When true, buttons defined in popups will be activated on first display " - "(use so you can type into a field without having to click on it first)"); - - prop = RNA_def_property(srna, "operator_context", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_items(prop, rna_enum_operator_context_items); - RNA_def_property_enum_funcs(prop, "rna_UILayout_op_context_get", "rna_UILayout_op_context_set", NULL); - - prop = RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_enabled_get", "rna_UILayout_enabled_set"); - RNA_def_property_ui_text(prop, "Enabled", "When false, this (sub)layout is grayed out"); - - prop = RNA_def_property(srna, "alert", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_alert_get", "rna_UILayout_alert_set"); - - prop = RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_items(prop, alignment_items); - RNA_def_property_enum_funcs(prop, "rna_UILayout_alignment_get", "rna_UILayout_alignment_set", NULL); - - prop = RNA_def_property(srna, "direction", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_items(prop, direction_items); - RNA_def_property_enum_funcs(prop, "rna_UILayout_direction_get", NULL, NULL); - RNA_def_property_clear_flag(prop, PROP_EDITABLE); - -#if 0 - prop = RNA_def_property(srna, "keep_aspect", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_keep_aspect_get", "rna_UILayout_keep_aspect_set"); -#endif - - prop = RNA_def_property(srna, "scale_x", PROP_FLOAT, PROP_UNSIGNED); - RNA_def_property_float_funcs(prop, "rna_UILayout_scale_x_get", "rna_UILayout_scale_x_set", NULL); - RNA_def_property_ui_text(prop, "Scale X", "Scale factor along the X for items in this (sub)layout"); - - prop = RNA_def_property(srna, "scale_y", PROP_FLOAT, PROP_UNSIGNED); - RNA_def_property_float_funcs(prop, "rna_UILayout_scale_y_get", "rna_UILayout_scale_y_set", NULL); - RNA_def_property_ui_text(prop, "Scale Y", "Scale factor along the Y for items in this (sub)layout"); - - prop = RNA_def_property(srna, "ui_units_x", PROP_FLOAT, PROP_UNSIGNED); - RNA_def_property_float_funcs(prop, "rna_UILayout_units_x_get", "rna_UILayout_units_x_set", NULL); - RNA_def_property_ui_text(prop, "Units X", "Fixed Size along the X for items in this (sub)layout"); - - prop = RNA_def_property(srna, "ui_units_y", PROP_FLOAT, PROP_UNSIGNED); - RNA_def_property_float_funcs(prop, "rna_UILayout_units_y_get", "rna_UILayout_units_y_set", NULL); - RNA_def_property_ui_text(prop, "Units Y", "Fixed Size along the Y for items in this (sub)layout"); - RNA_api_ui_layout(srna); - - prop = RNA_def_property(srna, "emboss", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_items(prop, emboss_items); - RNA_def_property_enum_funcs(prop, "rna_UILayout_emboss_get", "rna_UILayout_emboss_set", NULL); - - prop = RNA_def_property(srna, "use_property_split", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_property_split_get", "rna_UILayout_property_split_set"); - - prop = RNA_def_property(srna, "use_property_decorate", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_funcs(prop, "rna_UILayout_property_decorate_get", "rna_UILayout_property_decorate_set"); + StructRNA *srna; + PropertyRNA *prop; + + static const EnumPropertyItem alignment_items[] = { + {UI_LAYOUT_ALIGN_EXPAND, "EXPAND", 0, "Expand", ""}, + {UI_LAYOUT_ALIGN_LEFT, "LEFT", 0, "Left", ""}, + {UI_LAYOUT_ALIGN_CENTER, "CENTER", 0, "Center", ""}, + {UI_LAYOUT_ALIGN_RIGHT, "RIGHT", 0, "Right", ""}, + {0, NULL, 0, NULL, NULL}, + }; + + static const EnumPropertyItem direction_items[] = { + {UI_LAYOUT_HORIZONTAL, "HORIZONTAL", 0, "Horizontal", ""}, + {UI_LAYOUT_VERTICAL, "VERTICAL", 0, "Vertical", ""}, + {0, NULL, 0, NULL, NULL}, + }; + + static const EnumPropertyItem emboss_items[] = { + {UI_EMBOSS, "NORMAL", 0, "Regular", "Draw standard button emboss style"}, + {UI_EMBOSS_NONE, "NONE", 0, "None", "Draw only text and icons"}, + {UI_EMBOSS_PULLDOWN, "PULLDOWN_MENU", 0, "Pulldown Menu", "Draw pulldown menu style"}, + {UI_EMBOSS_RADIAL, "RADIAL_MENU", 0, "Radial Menu", "Draw radial menu style"}, + {0, NULL, 0, NULL, NULL}, + }; + + /* layout */ + + srna = RNA_def_struct(brna, "UILayout", NULL); + RNA_def_struct_sdna(srna, "uiLayout"); + RNA_def_struct_ui_text(srna, "UI Layout", "User interface layout in a panel or header"); + + prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs(prop, "rna_UILayout_active_get", "rna_UILayout_active_set"); + + prop = RNA_def_property(srna, "active_default", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs( + prop, "rna_UILayout_active_default_get", "rna_UILayout_active_default_set"); + RNA_def_property_ui_text( + prop, + "Active Default", + "When true, an operator button defined after this will be activated when pressing return" + "(use with popup dialogs)"); + + prop = RNA_def_property(srna, "activate_init", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs( + prop, "rna_UILayout_activate_init_get", "rna_UILayout_activate_init_set"); + RNA_def_property_ui_text( + prop, + "Activate on Init", + "When true, buttons defined in popups will be activated on first display " + "(use so you can type into a field without having to click on it first)"); + + prop = RNA_def_property(srna, "operator_context", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_items(prop, rna_enum_operator_context_items); + RNA_def_property_enum_funcs( + prop, "rna_UILayout_op_context_get", "rna_UILayout_op_context_set", NULL); + + prop = RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs(prop, "rna_UILayout_enabled_get", "rna_UILayout_enabled_set"); + RNA_def_property_ui_text(prop, "Enabled", "When false, this (sub)layout is grayed out"); + + prop = RNA_def_property(srna, "alert", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs(prop, "rna_UILayout_alert_get", "rna_UILayout_alert_set"); + + prop = RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_items(prop, alignment_items); + RNA_def_property_enum_funcs( + prop, "rna_UILayout_alignment_get", "rna_UILayout_alignment_set", NULL); + + prop = RNA_def_property(srna, "direction", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_items(prop, direction_items); + RNA_def_property_enum_funcs(prop, "rna_UILayout_direction_get", NULL, NULL); + RNA_def_property_clear_flag(prop, PROP_EDITABLE); + +# if 0 + prop = RNA_def_property(srna, "keep_aspect", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs(prop, "rna_UILayout_keep_aspect_get", "rna_UILayout_keep_aspect_set"); +# endif + + prop = RNA_def_property(srna, "scale_x", PROP_FLOAT, PROP_UNSIGNED); + RNA_def_property_float_funcs(prop, "rna_UILayout_scale_x_get", "rna_UILayout_scale_x_set", NULL); + RNA_def_property_ui_text( + prop, "Scale X", "Scale factor along the X for items in this (sub)layout"); + + prop = RNA_def_property(srna, "scale_y", PROP_FLOAT, PROP_UNSIGNED); + RNA_def_property_float_funcs(prop, "rna_UILayout_scale_y_get", "rna_UILayout_scale_y_set", NULL); + RNA_def_property_ui_text( + prop, "Scale Y", "Scale factor along the Y for items in this (sub)layout"); + + prop = RNA_def_property(srna, "ui_units_x", PROP_FLOAT, PROP_UNSIGNED); + RNA_def_property_float_funcs(prop, "rna_UILayout_units_x_get", "rna_UILayout_units_x_set", NULL); + RNA_def_property_ui_text( + prop, "Units X", "Fixed Size along the X for items in this (sub)layout"); + + prop = RNA_def_property(srna, "ui_units_y", PROP_FLOAT, PROP_UNSIGNED); + RNA_def_property_float_funcs(prop, "rna_UILayout_units_y_get", "rna_UILayout_units_y_set", NULL); + RNA_def_property_ui_text( + prop, "Units Y", "Fixed Size along the Y for items in this (sub)layout"); + RNA_api_ui_layout(srna); + + prop = RNA_def_property(srna, "emboss", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_items(prop, emboss_items); + RNA_def_property_enum_funcs(prop, "rna_UILayout_emboss_get", "rna_UILayout_emboss_set", NULL); + + prop = RNA_def_property(srna, "use_property_split", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs( + prop, "rna_UILayout_property_split_get", "rna_UILayout_property_split_set"); + + prop = RNA_def_property(srna, "use_property_decorate", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_funcs( + prop, "rna_UILayout_property_decorate_get", "rna_UILayout_property_decorate_set"); } static void rna_def_panel(BlenderRNA *brna) { - StructRNA *srna; - PropertyRNA *prop; - PropertyRNA *parm; - FunctionRNA *func; - - static const EnumPropertyItem panel_flag_items[] = { - {PNL_DEFAULT_CLOSED, "DEFAULT_CLOSED", 0, "Default Closed", - "Defines if the panel has to be open or collapsed at the time of its creation"}, - {PNL_NO_HEADER, "HIDE_HEADER", 0, "Hide Header", - "If set to False, the panel shows a header, which contains a clickable " - "arrow to collapse the panel and the label (see bl_label)"}, - {0, NULL, 0, NULL, NULL}, - }; - - srna = RNA_def_struct(brna, "Panel", NULL); - RNA_def_struct_ui_text(srna, "Panel", "Panel containing UI elements"); - RNA_def_struct_sdna(srna, "Panel"); - RNA_def_struct_refine_func(srna, "rna_Panel_refine"); - RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister", NULL); - RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA); - RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT); - - /* poll */ - func = RNA_def_function(srna, "poll", NULL); - RNA_def_function_ui_description(func, "If this method returns a non-null output, then the panel can be drawn"); - RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL); - RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", "")); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); - - /* draw */ - func = RNA_def_function(srna, "draw", NULL); - RNA_def_function_ui_description(func, "Draw UI elements into the panel UI layout"); - RNA_def_function_flag(func, FUNC_REGISTER); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); - - func = RNA_def_function(srna, "draw_header", NULL); - RNA_def_function_ui_description(func, "Draw UI elements into the panel's header UI layout"); - RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); - - func = RNA_def_function(srna, "draw_header_preset", NULL); - RNA_def_function_ui_description(func, "Draw UI elements for presets in the panel's header"); - RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); - - prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE); - RNA_def_property_struct_type(prop, "UILayout"); - RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the panel in the UI"); - - prop = RNA_def_property(srna, "text", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "drawname"); - RNA_def_property_ui_text(prop, "Text", "XXX todo"); - - /* registration */ - prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->idname"); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "ID Name", - "If this is set, the panel gets a custom ID, otherwise it takes the " - "name of the class used to define the panel. For example, if the " - "class name is \"OBJECT_PT_hello\", and bl_idname is not set by the " - "script, then bl_idname = \"OBJECT_PT_hello\""); - - prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->label"); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "Label", - "The panel label, shows up in the panel header at the right of the " - "triangle used to collapse the panel"); - - prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->translation_context"); - RNA_def_property_string_default(prop, BLT_I18NCONTEXT_DEFAULT_BPYRNA); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - RNA_define_verify_sdna(true); - - prop = RNA_def_property(srna, "bl_category", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->category"); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - - prop = RNA_def_property(srna, "bl_owner_id", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->owner_id"); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - - prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_sdna(prop, NULL, "type->space_type"); - RNA_def_property_enum_items(prop, rna_enum_space_type_items); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "Space type", "The space where the panel is going to be used in"); - - prop = RNA_def_property(srna, "bl_region_type", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_sdna(prop, NULL, "type->region_type"); - RNA_def_property_enum_items(prop, rna_enum_region_type_items); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "Region Type", "The region where the panel is going to be used in"); - - prop = RNA_def_property(srna, "bl_context", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->context"); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); /* Only used in Properties Editor and 3D View - Thomas */ - RNA_def_property_ui_text(prop, "Context", - "The context in which the panel belongs to. (TODO: explain the " - "possible combinations bl_context/bl_region_type/bl_space_type)"); - - prop = RNA_def_property(srna, "bl_options", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_sdna(prop, NULL, "type->flag"); - RNA_def_property_enum_items(prop, panel_flag_items); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL | PROP_ENUM_FLAG); - RNA_def_property_ui_text(prop, "Options", "Options for this panel type"); - - prop = RNA_def_property(srna, "bl_parent_id", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->parent_id"); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - RNA_def_property_ui_text(prop, "Parent ID Name", "If this is set, the panel becomes a sub-panel"); - - prop = RNA_def_property(srna, "bl_ui_units_x", PROP_INT, PROP_UNSIGNED); - RNA_def_property_int_sdna(prop, NULL, "type->ui_units_x"); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - RNA_def_property_ui_text(prop, "Units X", "When set, defines popup panel width"); - - prop = RNA_def_property(srna, "use_pin", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_sdna(prop, NULL, "flag", PNL_PIN); - RNA_def_property_ui_text(prop, "Pin", ""); - /* XXX, should only tag region for redraw */ - RNA_def_property_update(prop, NC_WINDOW, NULL); - - prop = RNA_def_property(srna, "is_popover", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_sdna(prop, NULL, "flag", PNL_POPOVER); - RNA_def_property_clear_flag(prop, PROP_EDITABLE); - RNA_def_property_ui_text(prop, "Popover", ""); + StructRNA *srna; + PropertyRNA *prop; + PropertyRNA *parm; + FunctionRNA *func; + + static const EnumPropertyItem panel_flag_items[] = { + {PNL_DEFAULT_CLOSED, + "DEFAULT_CLOSED", + 0, + "Default Closed", + "Defines if the panel has to be open or collapsed at the time of its creation"}, + {PNL_NO_HEADER, + "HIDE_HEADER", + 0, + "Hide Header", + "If set to False, the panel shows a header, which contains a clickable " + "arrow to collapse the panel and the label (see bl_label)"}, + {0, NULL, 0, NULL, NULL}, + }; + + srna = RNA_def_struct(brna, "Panel", NULL); + RNA_def_struct_ui_text(srna, "Panel", "Panel containing UI elements"); + RNA_def_struct_sdna(srna, "Panel"); + RNA_def_struct_refine_func(srna, "rna_Panel_refine"); + RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister", NULL); + RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA); + RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT); + + /* poll */ + func = RNA_def_function(srna, "poll", NULL); + RNA_def_function_ui_description( + func, "If this method returns a non-null output, then the panel can be drawn"); + RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL); + RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", "")); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); + + /* draw */ + func = RNA_def_function(srna, "draw", NULL); + RNA_def_function_ui_description(func, "Draw UI elements into the panel UI layout"); + RNA_def_function_flag(func, FUNC_REGISTER); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); + + func = RNA_def_function(srna, "draw_header", NULL); + RNA_def_function_ui_description(func, "Draw UI elements into the panel's header UI layout"); + RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); + + func = RNA_def_function(srna, "draw_header_preset", NULL); + RNA_def_function_ui_description(func, "Draw UI elements for presets in the panel's header"); + RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); + + prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE); + RNA_def_property_struct_type(prop, "UILayout"); + RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the panel in the UI"); + + prop = RNA_def_property(srna, "text", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "drawname"); + RNA_def_property_ui_text(prop, "Text", "XXX todo"); + + /* registration */ + prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->idname"); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text(prop, + "ID Name", + "If this is set, the panel gets a custom ID, otherwise it takes the " + "name of the class used to define the panel. For example, if the " + "class name is \"OBJECT_PT_hello\", and bl_idname is not set by the " + "script, then bl_idname = \"OBJECT_PT_hello\""); + + prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->label"); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text(prop, + "Label", + "The panel label, shows up in the panel header at the right of the " + "triangle used to collapse the panel"); + + prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->translation_context"); + RNA_def_property_string_default(prop, BLT_I18NCONTEXT_DEFAULT_BPYRNA); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + RNA_define_verify_sdna(true); + + prop = RNA_def_property(srna, "bl_category", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->category"); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + + prop = RNA_def_property(srna, "bl_owner_id", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->owner_id"); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + + prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_sdna(prop, NULL, "type->space_type"); + RNA_def_property_enum_items(prop, rna_enum_space_type_items); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text(prop, "Space type", "The space where the panel is going to be used in"); + + prop = RNA_def_property(srna, "bl_region_type", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_sdna(prop, NULL, "type->region_type"); + RNA_def_property_enum_items(prop, rna_enum_region_type_items); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text( + prop, "Region Type", "The region where the panel is going to be used in"); + + prop = RNA_def_property(srna, "bl_context", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->context"); + RNA_def_property_flag( + prop, PROP_REGISTER_OPTIONAL); /* Only used in Properties Editor and 3D View - Thomas */ + RNA_def_property_ui_text(prop, + "Context", + "The context in which the panel belongs to. (TODO: explain the " + "possible combinations bl_context/bl_region_type/bl_space_type)"); + + prop = RNA_def_property(srna, "bl_options", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_sdna(prop, NULL, "type->flag"); + RNA_def_property_enum_items(prop, panel_flag_items); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL | PROP_ENUM_FLAG); + RNA_def_property_ui_text(prop, "Options", "Options for this panel type"); + + prop = RNA_def_property(srna, "bl_parent_id", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->parent_id"); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + RNA_def_property_ui_text( + prop, "Parent ID Name", "If this is set, the panel becomes a sub-panel"); + + prop = RNA_def_property(srna, "bl_ui_units_x", PROP_INT, PROP_UNSIGNED); + RNA_def_property_int_sdna(prop, NULL, "type->ui_units_x"); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + RNA_def_property_ui_text(prop, "Units X", "When set, defines popup panel width"); + + prop = RNA_def_property(srna, "use_pin", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_sdna(prop, NULL, "flag", PNL_PIN); + RNA_def_property_ui_text(prop, "Pin", ""); + /* XXX, should only tag region for redraw */ + RNA_def_property_update(prop, NC_WINDOW, NULL); + + prop = RNA_def_property(srna, "is_popover", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_sdna(prop, NULL, "flag", PNL_POPOVER); + RNA_def_property_clear_flag(prop, PROP_EDITABLE); + RNA_def_property_ui_text(prop, "Popover", ""); } static void rna_def_uilist(BlenderRNA *brna) { - StructRNA *srna; - PropertyRNA *prop; - PropertyRNA *parm; - FunctionRNA *func; - - srna = RNA_def_struct(brna, "UIList", NULL); - RNA_def_struct_ui_text(srna, "UIList", "UI list containing the elements of a collection"); - RNA_def_struct_sdna(srna, "uiList"); - RNA_def_struct_refine_func(srna, "rna_UIList_refine"); - RNA_def_struct_register_funcs(srna, "rna_UIList_register", "rna_UIList_unregister", NULL); - RNA_def_struct_idprops_func(srna, "rna_UIList_idprops"); - RNA_def_struct_flag(srna, STRUCT_NO_DATABLOCK_IDPROPERTIES | STRUCT_PUBLIC_NAMESPACE_INHERIT); - - /* Registration */ - prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->idname"); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "ID Name", - "If this is set, the uilist gets a custom ID, otherwise it takes the " - "name of the class used to define the uilist (for example, if the " - "class name is \"OBJECT_UL_vgroups\", and bl_idname is not set by the " - "script, then bl_idname = \"OBJECT_UL_vgroups\")"); - - /* Data */ - prop = RNA_def_property(srna, "layout_type", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_items(prop, rna_enum_uilist_layout_type_items); - RNA_def_property_clear_flag(prop, PROP_EDITABLE); - - /* Filter options */ - prop = RNA_def_property(srna, "use_filter_show", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_SHOW); - RNA_def_property_ui_text(prop, "Show Filter", "Show filtering options"); - - prop = RNA_def_property(srna, "filter_name", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "filter_byname"); - RNA_def_property_flag(prop, PROP_TEXTEDIT_UPDATE); - RNA_def_property_ui_text(prop, "Filter by Name", "Only show items matching this name (use '*' as wildcard)"); - - prop = RNA_def_property(srna, "use_filter_invert", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_EXCLUDE); - RNA_def_property_ui_text(prop, "Invert", "Invert filtering (show hidden items, and vice-versa)"); - - /* WARNING: This is sort of an abuse, sort-by-alpha is actually a value, should even be an enum in full logic - * (of two values, sort by index and sort by name). - * But for default UIList, it's nicer (better UI-wise) to show this as a boolean bit-flag option, - * avoids having to define custom setters/getters using UILST_FLT_SORT_MASK to mask out - * actual bitflags on same var, etc. - */ - prop = RNA_def_property(srna, "use_filter_sort_alpha", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_ALPHA); - RNA_def_property_ui_icon(prop, ICON_SORTALPHA, 0); - RNA_def_property_ui_text(prop, "Sort by Name", "Sort items by their name"); - - prop = RNA_def_property(srna, "use_filter_sort_reverse", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_REVERSE); - RNA_def_property_ui_text(prop, "Reverse", "Reverse the order of shown items"); - - prop = RNA_def_property(srna, "use_filter_sort_lock", PROP_BOOLEAN, PROP_NONE); - RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_LOCK); - RNA_def_property_ui_text(prop, "Lock Order", "Lock the order of shown items (user cannot change it)"); - - /* draw_item */ - func = RNA_def_function(srna, "draw_item", NULL); - RNA_def_function_ui_description(func, "Draw an item in the list (NOTE: when you define your own draw_item " - "function, you may want to check given 'item' is of the right type...)"); - RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item"); - RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); - parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property"); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR); - parm = RNA_def_pointer(func, "item", "AnyType", "", "Item of the collection property"); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR); - parm = RNA_def_int(func, "icon", 0, 0, INT_MAX, "", "Icon of the item in the collection", 0, INT_MAX); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - parm = RNA_def_pointer(func, "active_data", "AnyType", "", - "Data from which to take property for the active element"); - RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR); - parm = RNA_def_string(func, "active_property", NULL, 0, "", - "Identifier of property in active_data, for the active element"); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - RNA_def_int(func, "index", 0, 0, INT_MAX, "", "Index of the item in the collection", 0, INT_MAX); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_PYFUNC_OPTIONAL); - prop = RNA_def_property(func, "flt_flag", PROP_INT, PROP_UNSIGNED); - RNA_def_property_ui_text(prop, "", "The filter-flag result for this item"); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_PYFUNC_OPTIONAL); - - /* draw_filter */ - func = RNA_def_function(srna, "draw_filter", NULL); - RNA_def_function_ui_description(func, "Draw filtering options"); - RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item"); - RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); - - /* filter */ - func = RNA_def_function(srna, "filter_items", NULL); - RNA_def_function_ui_description(func, "Filter and/or re-order items of the collection (output filter results in " - "filter_flags, and reorder results in filter_neworder arrays)"); - RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property"); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR); - parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in data, for the collection"); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - prop = RNA_def_property(func, "filter_flags", PROP_INT, PROP_UNSIGNED); - RNA_def_property_flag(prop, PARM_REQUIRED | PROP_DYNAMIC); - RNA_def_property_array(prop, 1); /* XXX Dummy value, default 0 does not work */ - RNA_def_property_ui_text(prop, "", "An array of filter flags, one for each item in the collection (NOTE: " - "FILTER_ITEM bit is reserved, it defines whether the item is shown or not)"); - RNA_def_function_output(func, prop); - prop = RNA_def_property(func, "filter_neworder", PROP_INT, PROP_UNSIGNED); - RNA_def_property_flag(prop, PARM_REQUIRED | PROP_DYNAMIC); - RNA_def_property_array(prop, 1); /* XXX Dummy value, default 0 does not work */ - RNA_def_property_ui_text(prop, "", "An array of indices, one for each item in the collection, mapping the org " - "index to the new one"); - RNA_def_function_output(func, prop); - - /* "Constants"! */ - RNA_define_verify_sdna(0); /* not in sdna */ - - prop = RNA_def_property(srna, "bitflag_filter_item", PROP_INT, PROP_UNSIGNED); - RNA_def_property_ui_text(prop, "FILTER_ITEM", - "The value of the reserved bitflag 'FILTER_ITEM' (in filter_flags values)"); - RNA_def_property_int_funcs(prop, "rna_UIList_filter_const_FILTER_ITEM_get", NULL, NULL); - RNA_def_property_clear_flag(prop, PROP_EDITABLE); + StructRNA *srna; + PropertyRNA *prop; + PropertyRNA *parm; + FunctionRNA *func; + + srna = RNA_def_struct(brna, "UIList", NULL); + RNA_def_struct_ui_text(srna, "UIList", "UI list containing the elements of a collection"); + RNA_def_struct_sdna(srna, "uiList"); + RNA_def_struct_refine_func(srna, "rna_UIList_refine"); + RNA_def_struct_register_funcs(srna, "rna_UIList_register", "rna_UIList_unregister", NULL); + RNA_def_struct_idprops_func(srna, "rna_UIList_idprops"); + RNA_def_struct_flag(srna, STRUCT_NO_DATABLOCK_IDPROPERTIES | STRUCT_PUBLIC_NAMESPACE_INHERIT); + + /* Registration */ + prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->idname"); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text(prop, + "ID Name", + "If this is set, the uilist gets a custom ID, otherwise it takes the " + "name of the class used to define the uilist (for example, if the " + "class name is \"OBJECT_UL_vgroups\", and bl_idname is not set by the " + "script, then bl_idname = \"OBJECT_UL_vgroups\")"); + + /* Data */ + prop = RNA_def_property(srna, "layout_type", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_items(prop, rna_enum_uilist_layout_type_items); + RNA_def_property_clear_flag(prop, PROP_EDITABLE); + + /* Filter options */ + prop = RNA_def_property(srna, "use_filter_show", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_SHOW); + RNA_def_property_ui_text(prop, "Show Filter", "Show filtering options"); + + prop = RNA_def_property(srna, "filter_name", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "filter_byname"); + RNA_def_property_flag(prop, PROP_TEXTEDIT_UPDATE); + RNA_def_property_ui_text( + prop, "Filter by Name", "Only show items matching this name (use '*' as wildcard)"); + + prop = RNA_def_property(srna, "use_filter_invert", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_EXCLUDE); + RNA_def_property_ui_text(prop, "Invert", "Invert filtering (show hidden items, and vice-versa)"); + + /* WARNING: This is sort of an abuse, sort-by-alpha is actually a value, should even be an enum in full logic + * (of two values, sort by index and sort by name). + * But for default UIList, it's nicer (better UI-wise) to show this as a boolean bit-flag option, + * avoids having to define custom setters/getters using UILST_FLT_SORT_MASK to mask out + * actual bitflags on same var, etc. + */ + prop = RNA_def_property(srna, "use_filter_sort_alpha", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_ALPHA); + RNA_def_property_ui_icon(prop, ICON_SORTALPHA, 0); + RNA_def_property_ui_text(prop, "Sort by Name", "Sort items by their name"); + + prop = RNA_def_property(srna, "use_filter_sort_reverse", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_REVERSE); + RNA_def_property_ui_text(prop, "Reverse", "Reverse the order of shown items"); + + prop = RNA_def_property(srna, "use_filter_sort_lock", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_LOCK); + RNA_def_property_ui_text( + prop, "Lock Order", "Lock the order of shown items (user cannot change it)"); + + /* draw_item */ + func = RNA_def_function(srna, "draw_item", NULL); + RNA_def_function_ui_description( + func, + "Draw an item in the list (NOTE: when you define your own draw_item " + "function, you may want to check given 'item' is of the right type...)"); + RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item"); + RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); + parm = RNA_def_pointer( + func, "data", "AnyType", "", "Data from which to take Collection property"); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR); + parm = RNA_def_pointer(func, "item", "AnyType", "", "Item of the collection property"); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR); + parm = RNA_def_int( + func, "icon", 0, 0, INT_MAX, "", "Icon of the item in the collection", 0, INT_MAX); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + parm = RNA_def_pointer(func, + "active_data", + "AnyType", + "", + "Data from which to take property for the active element"); + RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR); + parm = RNA_def_string(func, + "active_property", + NULL, + 0, + "", + "Identifier of property in active_data, for the active element"); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + RNA_def_int(func, "index", 0, 0, INT_MAX, "", "Index of the item in the collection", 0, INT_MAX); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_PYFUNC_OPTIONAL); + prop = RNA_def_property(func, "flt_flag", PROP_INT, PROP_UNSIGNED); + RNA_def_property_ui_text(prop, "", "The filter-flag result for this item"); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_PYFUNC_OPTIONAL); + + /* draw_filter */ + func = RNA_def_function(srna, "draw_filter", NULL); + RNA_def_function_ui_description(func, "Draw filtering options"); + RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item"); + RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED); + + /* filter */ + func = RNA_def_function(srna, "filter_items", NULL); + RNA_def_function_ui_description( + func, + "Filter and/or re-order items of the collection (output filter results in " + "filter_flags, and reorder results in filter_neworder arrays)"); + RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + parm = RNA_def_pointer( + func, "data", "AnyType", "", "Data from which to take Collection property"); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED | PARM_RNAPTR); + parm = RNA_def_string( + func, "property", NULL, 0, "", "Identifier of property in data, for the collection"); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + prop = RNA_def_property(func, "filter_flags", PROP_INT, PROP_UNSIGNED); + RNA_def_property_flag(prop, PARM_REQUIRED | PROP_DYNAMIC); + RNA_def_property_array(prop, 1); /* XXX Dummy value, default 0 does not work */ + RNA_def_property_ui_text( + prop, + "", + "An array of filter flags, one for each item in the collection (NOTE: " + "FILTER_ITEM bit is reserved, it defines whether the item is shown or not)"); + RNA_def_function_output(func, prop); + prop = RNA_def_property(func, "filter_neworder", PROP_INT, PROP_UNSIGNED); + RNA_def_property_flag(prop, PARM_REQUIRED | PROP_DYNAMIC); + RNA_def_property_array(prop, 1); /* XXX Dummy value, default 0 does not work */ + RNA_def_property_ui_text( + prop, + "", + "An array of indices, one for each item in the collection, mapping the org " + "index to the new one"); + RNA_def_function_output(func, prop); + + /* "Constants"! */ + RNA_define_verify_sdna(0); /* not in sdna */ + + prop = RNA_def_property(srna, "bitflag_filter_item", PROP_INT, PROP_UNSIGNED); + RNA_def_property_ui_text( + prop, + "FILTER_ITEM", + "The value of the reserved bitflag 'FILTER_ITEM' (in filter_flags values)"); + RNA_def_property_int_funcs(prop, "rna_UIList_filter_const_FILTER_ITEM_get", NULL, NULL); + RNA_def_property_clear_flag(prop, PROP_EDITABLE); } static void rna_def_header(BlenderRNA *brna) { - StructRNA *srna; - PropertyRNA *prop; - PropertyRNA *parm; - FunctionRNA *func; - - srna = RNA_def_struct(brna, "Header", NULL); - RNA_def_struct_ui_text(srna, "Header", "Editor header containing UI elements"); - RNA_def_struct_sdna(srna, "Header"); - RNA_def_struct_refine_func(srna, "rna_Header_refine"); - RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister", NULL); - RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT); - - /* draw */ - func = RNA_def_function(srna, "draw", NULL); - RNA_def_function_ui_description(func, "Draw UI elements into the header UI layout"); - RNA_def_function_flag(func, FUNC_REGISTER); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - - RNA_define_verify_sdna(0); /* not in sdna */ - - prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE); - RNA_def_property_pointer_sdna(prop, NULL, "layout"); - RNA_def_property_struct_type(prop, "UILayout"); - RNA_def_property_ui_text(prop, "Layout", "Structure of the header in the UI"); - - /* registration */ - prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->idname"); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "ID Name", - "If this is set, the header gets a custom ID, otherwise it takes the " - "name of the class used to define the panel; for example, if the " - "class name is \"OBJECT_HT_hello\", and bl_idname is not set by the " - "script, then bl_idname = \"OBJECT_HT_hello\""); - - prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_sdna(prop, NULL, "type->space_type"); - RNA_def_property_enum_items(prop, rna_enum_space_type_items); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "Space type", "The space where the header is going to be used in"); - - prop = RNA_def_property(srna, "bl_region_type", PROP_ENUM, PROP_NONE); - RNA_def_property_enum_sdna(prop, NULL, "type->region_type"); - RNA_def_property_enum_default(prop, RGN_TYPE_HEADER); - RNA_def_property_enum_items(prop, rna_enum_region_type_items); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - RNA_def_property_ui_text(prop, "Region Type", "The region where the header is going to be used in " - "(defaults to header region)"); - - RNA_define_verify_sdna(1); + StructRNA *srna; + PropertyRNA *prop; + PropertyRNA *parm; + FunctionRNA *func; + + srna = RNA_def_struct(brna, "Header", NULL); + RNA_def_struct_ui_text(srna, "Header", "Editor header containing UI elements"); + RNA_def_struct_sdna(srna, "Header"); + RNA_def_struct_refine_func(srna, "rna_Header_refine"); + RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister", NULL); + RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT); + + /* draw */ + func = RNA_def_function(srna, "draw", NULL); + RNA_def_function_ui_description(func, "Draw UI elements into the header UI layout"); + RNA_def_function_flag(func, FUNC_REGISTER); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + + RNA_define_verify_sdna(0); /* not in sdna */ + + prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE); + RNA_def_property_pointer_sdna(prop, NULL, "layout"); + RNA_def_property_struct_type(prop, "UILayout"); + RNA_def_property_ui_text(prop, "Layout", "Structure of the header in the UI"); + + /* registration */ + prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->idname"); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text(prop, + "ID Name", + "If this is set, the header gets a custom ID, otherwise it takes the " + "name of the class used to define the panel; for example, if the " + "class name is \"OBJECT_HT_hello\", and bl_idname is not set by the " + "script, then bl_idname = \"OBJECT_HT_hello\""); + + prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_sdna(prop, NULL, "type->space_type"); + RNA_def_property_enum_items(prop, rna_enum_space_type_items); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text( + prop, "Space type", "The space where the header is going to be used in"); + + prop = RNA_def_property(srna, "bl_region_type", PROP_ENUM, PROP_NONE); + RNA_def_property_enum_sdna(prop, NULL, "type->region_type"); + RNA_def_property_enum_default(prop, RGN_TYPE_HEADER); + RNA_def_property_enum_items(prop, rna_enum_region_type_items); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + RNA_def_property_ui_text(prop, + "Region Type", + "The region where the header is going to be used in " + "(defaults to header region)"); + + RNA_define_verify_sdna(1); } static void rna_def_menu(BlenderRNA *brna) { - StructRNA *srna; - PropertyRNA *prop; - PropertyRNA *parm; - FunctionRNA *func; - - srna = RNA_def_struct(brna, "Menu", NULL); - RNA_def_struct_ui_text(srna, "Menu", "Editor menu containing buttons"); - RNA_def_struct_sdna(srna, "Menu"); - RNA_def_struct_refine_func(srna, "rna_Menu_refine"); - RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister", NULL); - RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA); - RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT); - - /* poll */ - func = RNA_def_function(srna, "poll", NULL); - RNA_def_function_ui_description(func, "If this method returns a non-null output, then the menu can be drawn"); - RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL); - RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", "")); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - - /* draw */ - func = RNA_def_function(srna, "draw", NULL); - RNA_def_function_ui_description(func, "Draw UI elements into the menu UI layout"); - RNA_def_function_flag(func, FUNC_REGISTER); - parm = RNA_def_pointer(func, "context", "Context", "", ""); - RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); - - RNA_define_verify_sdna(false); /* not in sdna */ - - prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE); - RNA_def_property_pointer_sdna(prop, NULL, "layout"); - RNA_def_property_struct_type(prop, "UILayout"); - RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the menu in the UI"); - - /* registration */ - prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->idname"); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "ID Name", - "If this is set, the menu gets a custom ID, otherwise it takes the " - "name of the class used to define the menu (for example, if the " - "class name is \"OBJECT_MT_hello\", and bl_idname is not set by the " - "script, then bl_idname = \"OBJECT_MT_hello\")"); - - prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->label"); - RNA_def_property_flag(prop, PROP_REGISTER); - RNA_def_property_ui_text(prop, "Label", "The menu label"); - - prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->translation_context"); - RNA_def_property_string_default(prop, BLT_I18NCONTEXT_DEFAULT_BPYRNA); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - - prop = RNA_def_property(srna, "bl_description", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->description"); - RNA_def_property_string_maxlength(prop, RNA_DYN_DESCR_MAX); /* else it uses the pointer size! */ - RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Menu_bl_description_set"); - /* RNA_def_property_clear_flag(prop, PROP_EDITABLE); */ - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - RNA_def_property_clear_flag(prop, PROP_NEVER_NULL); /* check for NULL */ - - prop = RNA_def_property(srna, "bl_owner_id", PROP_STRING, PROP_NONE); - RNA_def_property_string_sdna(prop, NULL, "type->owner_id"); - RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); - - RNA_define_verify_sdna(1); + StructRNA *srna; + PropertyRNA *prop; + PropertyRNA *parm; + FunctionRNA *func; + + srna = RNA_def_struct(brna, "Menu", NULL); + RNA_def_struct_ui_text(srna, "Menu", "Editor menu containing buttons"); + RNA_def_struct_sdna(srna, "Menu"); + RNA_def_struct_refine_func(srna, "rna_Menu_refine"); + RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister", NULL); + RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA); + RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT); + + /* poll */ + func = RNA_def_function(srna, "poll", NULL); + RNA_def_function_ui_description( + func, "If this method returns a non-null output, then the menu can be drawn"); + RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL); + RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", "")); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + + /* draw */ + func = RNA_def_function(srna, "draw", NULL); + RNA_def_function_ui_description(func, "Draw UI elements into the menu UI layout"); + RNA_def_function_flag(func, FUNC_REGISTER); + parm = RNA_def_pointer(func, "context", "Context", "", ""); + RNA_def_parameter_flags(parm, 0, PARM_REQUIRED); + + RNA_define_verify_sdna(false); /* not in sdna */ + + prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE); + RNA_def_property_pointer_sdna(prop, NULL, "layout"); + RNA_def_property_struct_type(prop, "UILayout"); + RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the menu in the UI"); + + /* registration */ + prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->idname"); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text(prop, + "ID Name", + "If this is set, the menu gets a custom ID, otherwise it takes the " + "name of the class used to define the menu (for example, if the " + "class name is \"OBJECT_MT_hello\", and bl_idname is not set by the " + "script, then bl_idname = \"OBJECT_MT_hello\")"); + + prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->label"); + RNA_def_property_flag(prop, PROP_REGISTER); + RNA_def_property_ui_text(prop, "Label", "The menu label"); + + prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->translation_context"); + RNA_def_property_string_default(prop, BLT_I18NCONTEXT_DEFAULT_BPYRNA); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + + prop = RNA_def_property(srna, "bl_description", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->description"); + RNA_def_property_string_maxlength(prop, RNA_DYN_DESCR_MAX); /* else it uses the pointer size! */ + RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Menu_bl_description_set"); + /* RNA_def_property_clear_flag(prop, PROP_EDITABLE); */ + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + RNA_def_property_clear_flag(prop, PROP_NEVER_NULL); /* check for NULL */ + + prop = RNA_def_property(srna, "bl_owner_id", PROP_STRING, PROP_NONE); + RNA_def_property_string_sdna(prop, NULL, "type->owner_id"); + RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); + + RNA_define_verify_sdna(1); } void RNA_def_ui(BlenderRNA *brna) { - rna_def_ui_layout(brna); - rna_def_panel(brna); - rna_def_uilist(brna); - rna_def_header(brna); - rna_def_menu(brna); + rna_def_ui_layout(brna); + rna_def_panel(brna); + rna_def_uilist(brna); + rna_def_header(brna); + rna_def_menu(brna); } #endif /* RNA_RUNTIME */ |