2011-02-23 10:52:22 +00:00
|
|
|
/*
|
2009-04-08 16:40:46 +00:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
2010-02-12 13:34:04 +00:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2009-04-08 16:40:46 +00:00
|
|
|
*
|
|
|
|
* Contributor(s): Blender Foundation (2009)
|
|
|
|
*
|
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
|
|
*/
|
|
|
|
|
2011-02-27 20:20:01 +00:00
|
|
|
/** \file blender/makesrna/intern/rna_ui.c
|
|
|
|
* \ingroup RNA
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
2009-04-08 16:40:46 +00:00
|
|
|
#include <stdlib.h>
|
|
|
|
|
2009-06-16 00:52:21 +00:00
|
|
|
#include "DNA_screen_types.h"
|
|
|
|
|
2013-03-15 14:32:29 +00:00
|
|
|
#include "BLF_translation.h"
|
|
|
|
|
2013-08-29 12:55:31 +00:00
|
|
|
#include "BKE_idprop.h"
|
|
|
|
|
2009-04-08 16:40:46 +00:00
|
|
|
#include "RNA_define.h"
|
|
|
|
|
|
|
|
#include "rna_internal.h"
|
2009-04-19 17:12:16 +00:00
|
|
|
#include "RNA_enum_types.h"
|
2009-04-08 16:40:46 +00:00
|
|
|
|
2009-05-28 23:37:55 +00:00
|
|
|
#include "UI_interface.h"
|
|
|
|
|
2009-06-09 10:30:11 +00:00
|
|
|
#include "WM_types.h"
|
|
|
|
|
2010-02-10 11:10:38 +00:00
|
|
|
/* see WM_types.h */
|
|
|
|
EnumPropertyItem 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", ""},
|
2012-05-12 11:01:29 +00:00
|
|
|
{0, NULL, 0, NULL, NULL}
|
|
|
|
};
|
2010-02-10 11:10:38 +00:00
|
|
|
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
EnumPropertyItem uilist_layout_type_items[] = {
|
2013-08-29 12:55:31 +00:00
|
|
|
{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"},
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
{0, NULL, 0, NULL, NULL}
|
|
|
|
};
|
|
|
|
|
2009-04-08 16:40:46 +00:00
|
|
|
#ifdef RNA_RUNTIME
|
|
|
|
|
2011-11-15 14:58:14 +00:00
|
|
|
#include <assert.h>
|
|
|
|
|
2009-04-19 13:37:59 +00:00
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
|
|
|
|
#include "RNA_access.h"
|
|
|
|
|
|
|
|
#include "BLI_dynstr.h"
|
|
|
|
|
|
|
|
#include "BKE_context.h"
|
|
|
|
#include "BKE_report.h"
|
|
|
|
#include "BKE_screen.h"
|
|
|
|
|
|
|
|
#include "WM_api.h"
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
static ARegionType *region_type_find(ReportList *reports, int space_type, int region_type)
|
2009-04-19 13:37:59 +00:00
|
|
|
{
|
2009-04-19 17:12:16 +00:00
|
|
|
SpaceType *st;
|
|
|
|
ARegionType *art;
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
st = BKE_spacetype_from_id(space_type);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
for (art = (st) ? st->regiontypes.first : NULL; art; art = art->next) {
|
2012-03-05 23:30:41 +00:00
|
|
|
if (art->regionid == region_type)
|
2009-04-19 17:12:16 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* region type not found? abort */
|
2012-03-05 23:30:41 +00:00
|
|
|
if (art == NULL) {
|
2012-10-13 13:40:05 +00:00
|
|
|
BKE_report(reports, RPT_ERROR, "Region not found in space type");
|
2009-04-19 17:12:16 +00:00
|
|
|
return NULL;
|
|
|
|
}
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
return art;
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
/* Panel */
|
|
|
|
|
2009-04-19 13:37:59 +00:00
|
|
|
static int panel_poll(const bContext *C, PanelType *pt)
|
|
|
|
{
|
2011-10-19 22:40:03 +00:00
|
|
|
extern FunctionRNA rna_Panel_poll_func;
|
|
|
|
|
2009-04-19 13:37:59 +00:00
|
|
|
PointerRNA ptr;
|
2009-07-17 02:31:28 +00:00
|
|
|
ParameterList list;
|
2009-04-19 13:37:59 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
void *ret;
|
|
|
|
int visible;
|
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = &rna_Panel_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_create(&list, &ptr, func);
|
|
|
|
RNA_parameter_set_lookup(&list, "context", &C);
|
2010-12-07 04:12:15 +00:00
|
|
|
pt->ext.call((bContext *)C, &ptr, func, &list);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_get_lookup(&list, "visible", &ret);
|
2012-05-12 11:01:29 +00:00
|
|
|
visible = *(int *)ret;
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_free(&list);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
|
|
|
return visible;
|
|
|
|
}
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
static void panel_draw(const bContext *C, Panel *pnl)
|
2009-04-19 13:37:59 +00:00
|
|
|
{
|
2011-10-19 22:40:03 +00:00
|
|
|
extern FunctionRNA rna_Panel_draw_func;
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
PointerRNA ptr;
|
2009-07-17 02:31:28 +00:00
|
|
|
ParameterList list;
|
2009-04-19 17:12:16 +00:00
|
|
|
FunctionRNA *func;
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr);
|
2012-05-12 11:01:29 +00:00
|
|
|
func = &rna_Panel_draw_func; /* RNA_struct_find_function(&ptr, "draw"); */
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_create(&list, &ptr, func);
|
|
|
|
RNA_parameter_set_lookup(&list, "context", &C);
|
2010-12-07 04:12:15 +00:00
|
|
|
pnl->type->ext.call((bContext *)C, &ptr, func, &list);
|
2009-04-19 17:12:16 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_free(&list);
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
|
|
|
|
2009-05-19 17:13:33 +00:00
|
|
|
static void panel_draw_header(const bContext *C, Panel *pnl)
|
|
|
|
{
|
2011-10-19 22:40:03 +00:00
|
|
|
extern FunctionRNA rna_Panel_draw_header_func;
|
|
|
|
|
2009-05-19 17:13:33 +00:00
|
|
|
PointerRNA ptr;
|
2009-07-17 02:31:28 +00:00
|
|
|
ParameterList list;
|
2009-05-19 17:13:33 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr);
|
2012-03-05 23:30:41 +00:00
|
|
|
func = &rna_Panel_draw_header_func; /* RNA_struct_find_function(&ptr, "draw_header"); */
|
2009-05-19 17:13:33 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_create(&list, &ptr, func);
|
|
|
|
RNA_parameter_set_lookup(&list, "context", &C);
|
2010-12-07 04:12:15 +00:00
|
|
|
pnl->type->ext.call((bContext *)C, &ptr, func, &list);
|
2009-05-19 17:13:33 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_free(&list);
|
2009-05-19 17:13:33 +00:00
|
|
|
}
|
|
|
|
|
2013-09-20 06:35:28 +00:00
|
|
|
static void rna_Panel_unregister(Main *UNUSED(bmain), StructRNA *type)
|
2009-04-19 13:37:59 +00:00
|
|
|
{
|
|
|
|
ARegionType *art;
|
2012-03-05 23:30:41 +00:00
|
|
|
PanelType *pt = RNA_struct_blender_type_get(type);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (!pt)
|
2009-04-19 17:12:16 +00:00
|
|
|
return;
|
2012-03-05 23:30:41 +00:00
|
|
|
if (!(art = region_type_find(NULL, pt->space_type, pt->region_type)))
|
2009-04-19 17:12:16 +00:00
|
|
|
return;
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-08-16 07:26:29 +00:00
|
|
|
RNA_struct_free_extension(type, &pt->ext);
|
2009-08-14 12:29:55 +00:00
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
BLI_freelinkN(&art->paneltypes, pt);
|
|
|
|
RNA_struct_free(&BLENDER_RNA, type);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
|
|
|
|
2011-09-19 13:23:58 +00:00
|
|
|
static StructRNA *rna_Panel_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
|
|
|
|
StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
|
2009-04-19 13:37:59 +00:00
|
|
|
{
|
|
|
|
ARegionType *art;
|
2011-03-03 17:58:06 +00:00
|
|
|
PanelType *pt, dummypt = {NULL};
|
2012-03-05 23:30:41 +00:00
|
|
|
Panel dummypanel = {NULL};
|
2009-04-19 13:37:59 +00:00
|
|
|
PointerRNA dummyptr;
|
2009-05-27 00:03:49 +00:00
|
|
|
int have_function[3];
|
2009-04-19 13:37:59 +00:00
|
|
|
|
|
|
|
/* setup dummy panel & panel type to store static properties in */
|
2012-03-05 23:30:41 +00:00
|
|
|
dummypanel.type = &dummypt;
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_pointer_create(NULL, &RNA_Panel, &dummypanel, &dummyptr);
|
|
|
|
|
2013-03-19 19:37:22 +00:00
|
|
|
/* We have to set default context! Else we get a void string... */
|
|
|
|
strcpy(dummypt.translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
|
|
|
|
|
2009-04-19 13:37:59 +00:00
|
|
|
/* validate the python class */
|
2012-03-05 23:30:41 +00:00
|
|
|
if (validate(&dummyptr, data, have_function) != 0)
|
2009-04-19 13:37:59 +00:00
|
|
|
return NULL;
|
2009-12-22 10:04:15 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (strlen(identifier) >= sizeof(dummypt.idname)) {
|
2012-10-21 14:02:30 +00:00
|
|
|
BKE_reportf(reports, RPT_ERROR, "Registering panel class: '%s' is too long, maximum length is %d",
|
2011-09-19 13:23:58 +00:00
|
|
|
identifier, (int)sizeof(dummypt.idname));
|
2009-12-22 10:04:15 +00:00
|
|
|
return NULL;
|
|
|
|
}
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (!(art = region_type_find(reports, dummypt.space_type, dummypt.region_type)))
|
2009-04-19 13:37:59 +00:00
|
|
|
return NULL;
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
/* check if we have registered this panel type before, and remove it */
|
2012-03-05 23:30:41 +00:00
|
|
|
for (pt = art->paneltypes.first; pt; pt = pt->next) {
|
|
|
|
if (strcmp(pt->idname, dummypt.idname) == 0) {
|
|
|
|
if (pt->ext.srna)
|
2011-05-18 10:56:26 +00:00
|
|
|
rna_Panel_unregister(bmain, pt->ext.srna);
|
2009-07-10 11:59:45 +00:00
|
|
|
else
|
|
|
|
BLI_freelinkN(&art->paneltypes, pt);
|
2009-04-19 13:37:59 +00:00
|
|
|
break;
|
2009-04-19 17:12:16 +00:00
|
|
|
}
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
2009-04-19 17:12:16 +00:00
|
|
|
|
|
|
|
/* create a new panel type */
|
2012-03-05 23:30:41 +00:00
|
|
|
pt = MEM_callocN(sizeof(PanelType), "python buttons panel");
|
2009-04-19 17:12:16 +00:00
|
|
|
memcpy(pt, &dummypt, sizeof(dummypt));
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2013-01-09 05:32:15 +00:00
|
|
|
pt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, pt->idname, &RNA_Panel);
|
2013-03-15 14:32:29 +00:00
|
|
|
RNA_def_struct_translation_context(pt->ext.srna, pt->translation_context);
|
2012-03-05 23:30:41 +00:00
|
|
|
pt->ext.data = data;
|
|
|
|
pt->ext.call = call;
|
|
|
|
pt->ext.free = free;
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_struct_blender_type_set(pt->ext.srna, pt);
|
2010-08-19 10:16:30 +00:00
|
|
|
RNA_def_struct_flag(pt->ext.srna, STRUCT_NO_IDPROPERTIES);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
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;
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2011-01-23 13:52:24 +00:00
|
|
|
/* XXX use "no header" flag for some ordering of panels until we have real panel ordering */
|
2012-03-05 23:30:41 +00:00
|
|
|
if (pt->flag & PNL_NO_HEADER) {
|
2011-01-23 13:52:24 +00:00
|
|
|
PanelType *pth = art->paneltypes.first;
|
2012-03-05 23:30:41 +00:00
|
|
|
while (pth && pth->flag & PNL_NO_HEADER)
|
|
|
|
pth = pth->next;
|
2011-01-23 13:52:24 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (pth)
|
2011-01-23 13:52:24 +00:00
|
|
|
BLI_insertlinkbefore(&art->paneltypes, pth, pt);
|
|
|
|
else
|
|
|
|
BLI_addtail(&art->paneltypes, pt);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
BLI_addtail(&art->paneltypes, pt);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
return pt->ext.srna;
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
static StructRNA *rna_Panel_refine(PointerRNA *ptr)
|
2009-04-19 17:12:16 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
Panel *hdr = (Panel *)ptr->data;
|
|
|
|
return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Panel;
|
2009-04-19 17:12:16 +00:00
|
|
|
}
|
|
|
|
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
/* UIList */
|
2013-09-20 06:35:28 +00:00
|
|
|
static unsigned int rna_UIList_filter_const_FILTER_ITEM_get(PointerRNA *UNUSED(ptr))
|
2013-08-29 12:55:31 +00:00
|
|
|
{
|
|
|
|
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");
|
|
|
|
}
|
|
|
|
|
|
|
|
return ui_list->properties;
|
|
|
|
}
|
|
|
|
|
2012-12-28 10:32:49 +00:00
|
|
|
static void uilist_draw_item(uiList *ui_list, bContext *C, uiLayout *layout, PointerRNA *dataptr, PointerRNA *itemptr,
|
2013-08-29 12:55:31 +00:00
|
|
|
int icon, PointerRNA *active_dataptr, const char *active_propname, int index, int flt_flag)
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
{
|
|
|
|
extern FunctionRNA rna_UIList_draw_item_func;
|
|
|
|
|
2012-12-28 10:32:49 +00:00
|
|
|
PointerRNA ul_ptr;
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
ParameterList list;
|
|
|
|
FunctionRNA *func;
|
|
|
|
|
2012-12-28 10:32:49 +00:00
|
|
|
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"); */
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
|
2012-12-28 10:32:49 +00:00
|
|
|
RNA_parameter_list_create(&list, &ul_ptr, func);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
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);
|
2013-08-29 12:55:31 +00:00
|
|
|
RNA_parameter_set_lookup(&list, "flt_flag", &flt_flag);
|
2012-12-28 10:32:49 +00:00
|
|
|
ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
|
|
|
|
RNA_parameter_list_free(&list);
|
|
|
|
}
|
|
|
|
|
2013-08-29 12:55:31 +00:00
|
|
|
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", AT,
|
|
|
|
RNA_parameter_dynamic_length_get(&list, parm), "filter_flags", len);
|
|
|
|
RNA_parameter_list_free(&list);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
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", AT,
|
|
|
|
RNA_parameter_dynamic_length_get(&list, parm), "filter_neworder", len);
|
|
|
|
RNA_parameter_list_free(&list);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
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, AT);
|
|
|
|
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, AT);
|
|
|
|
/* 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, AT);
|
|
|
|
memcpy(flt_data->items_filter_neworder, filter_neworder, sizeof(int) * len);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
RNA_parameter_list_free(&list);
|
|
|
|
}
|
|
|
|
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
static void rna_UIList_unregister(Main *UNUSED(bmain), StructRNA *type)
|
|
|
|
{
|
|
|
|
uiListType *ult = RNA_struct_blender_type_get(type);
|
|
|
|
|
|
|
|
if (!ult)
|
|
|
|
return;
|
|
|
|
|
|
|
|
RNA_struct_free_extension(type, &ult->ext);
|
|
|
|
|
|
|
|
WM_uilisttype_freelink(ult);
|
|
|
|
|
|
|
|
RNA_struct_free(&BLENDER_RNA, type);
|
|
|
|
|
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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};
|
2012-12-28 10:32:49 +00:00
|
|
|
PointerRNA dummyul_ptr;
|
2013-08-29 12:55:31 +00:00
|
|
|
int have_function[3];
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
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;
|
2012-12-28 10:32:49 +00:00
|
|
|
RNA_pointer_create(NULL, &RNA_UIList, &dummyuilist, &dummyul_ptr);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
|
|
|
|
/* validate the python class */
|
2012-12-28 10:32:49 +00:00
|
|
|
if (validate(&dummyul_ptr, data, have_function) != 0)
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
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);
|
|
|
|
|
|
|
|
/* create a new menu type */
|
|
|
|
ult = MEM_callocN(sizeof(uiListType) + over_alloc, "python uilist");
|
|
|
|
memcpy(ult, &dummyult, sizeof(dummyult));
|
|
|
|
|
2013-01-09 05:32:15 +00:00
|
|
|
ult->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ult->idname, &RNA_UIList);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
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;
|
2013-08-29 12:55:31 +00:00
|
|
|
ult->draw_filter = (have_function[1]) ? uilist_draw_filter : NULL;
|
|
|
|
ult->filter_items = (have_function[2]) ? uilist_filter_items : NULL;
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
|
|
|
|
WM_uilisttype_add(ult);
|
|
|
|
|
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
|
|
|
|
return ult->ext.srna;
|
|
|
|
}
|
|
|
|
|
|
|
|
static StructRNA *rna_UIList_refine(PointerRNA *ptr)
|
|
|
|
{
|
2012-12-28 10:32:49 +00:00
|
|
|
uiList *ui_list = (uiList *)ptr->data;
|
|
|
|
return (ui_list->type && ui_list->type->ext.srna) ? ui_list->type->ext.srna : &RNA_UIList;
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
}
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
/* Header */
|
|
|
|
|
|
|
|
static void header_draw(const bContext *C, Header *hdr)
|
|
|
|
{
|
2011-10-19 22:40:03 +00:00
|
|
|
extern FunctionRNA rna_Header_draw_func;
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
PointerRNA htr;
|
2009-07-17 02:31:28 +00:00
|
|
|
ParameterList list;
|
2009-04-19 17:12:16 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &htr);
|
2012-03-05 23:30:41 +00:00
|
|
|
func = &rna_Header_draw_func; /* RNA_struct_find_function(&htr, "draw"); */
|
2009-04-19 17:12:16 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_create(&list, &htr, func);
|
|
|
|
RNA_parameter_set_lookup(&list, "context", &C);
|
2010-12-07 04:12:15 +00:00
|
|
|
hdr->type->ext.call((bContext *)C, &htr, func, &list);
|
2009-04-19 17:12:16 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_free(&list);
|
2009-04-19 17:12:16 +00:00
|
|
|
}
|
|
|
|
|
2011-05-31 02:14:25 +00:00
|
|
|
static void rna_Header_unregister(Main *UNUSED(bmain), StructRNA *type)
|
2009-04-19 13:37:59 +00:00
|
|
|
{
|
|
|
|
ARegionType *art;
|
2012-03-05 23:30:41 +00:00
|
|
|
HeaderType *ht = RNA_struct_blender_type_get(type);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (!ht)
|
2009-04-19 17:12:16 +00:00
|
|
|
return;
|
2012-03-05 23:30:41 +00:00
|
|
|
if (!(art = region_type_find(NULL, ht->space_type, RGN_TYPE_HEADER)))
|
2009-04-19 13:37:59 +00:00
|
|
|
return;
|
|
|
|
|
2009-08-16 07:26:29 +00:00
|
|
|
RNA_struct_free_extension(type, &ht->ext);
|
2009-08-14 12:29:55 +00:00
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
BLI_freelinkN(&art->headertypes, ht);
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_struct_free(&BLENDER_RNA, type);
|
|
|
|
|
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
|
|
|
|
2011-09-19 13:23:58 +00:00
|
|
|
static StructRNA *rna_Header_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
|
|
|
|
StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
|
2009-04-19 13:37:59 +00:00
|
|
|
{
|
2009-04-19 17:12:16 +00:00
|
|
|
ARegionType *art;
|
2011-03-03 17:58:06 +00:00
|
|
|
HeaderType *ht, dummyht = {NULL};
|
2012-03-05 23:30:41 +00:00
|
|
|
Header dummyheader = {NULL};
|
2009-04-19 17:12:16 +00:00
|
|
|
PointerRNA dummyhtr;
|
|
|
|
int have_function[1];
|
|
|
|
|
|
|
|
/* setup dummy header & header type to store static properties in */
|
2012-03-05 23:30:41 +00:00
|
|
|
dummyheader.type = &dummyht;
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_pointer_create(NULL, &RNA_Header, &dummyheader, &dummyhtr);
|
|
|
|
|
|
|
|
/* validate the python class */
|
2012-03-05 23:30:41 +00:00
|
|
|
if (validate(&dummyhtr, data, have_function) != 0)
|
2009-04-19 17:12:16 +00:00
|
|
|
return NULL;
|
2009-12-22 10:04:15 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (strlen(identifier) >= sizeof(dummyht.idname)) {
|
2012-10-21 14:02:30 +00:00
|
|
|
BKE_reportf(reports, RPT_ERROR, "Registering header class: '%s' is too long, maximum length is %d",
|
2011-09-19 13:23:58 +00:00
|
|
|
identifier, (int)sizeof(dummyht.idname));
|
2009-12-22 10:04:15 +00:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (!(art = region_type_find(reports, dummyht.space_type, RGN_TYPE_HEADER)))
|
2009-04-19 17:12:16 +00:00
|
|
|
return NULL;
|
|
|
|
|
|
|
|
/* check if we have registered this header type before, and remove it */
|
2012-03-05 23:30:41 +00:00
|
|
|
for (ht = art->headertypes.first; ht; ht = ht->next) {
|
|
|
|
if (strcmp(ht->idname, dummyht.idname) == 0) {
|
|
|
|
if (ht->ext.srna)
|
2011-05-18 10:56:26 +00:00
|
|
|
rna_Header_unregister(bmain, ht->ext.srna);
|
2009-04-19 17:12:16 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* create a new header type */
|
2012-03-05 23:30:41 +00:00
|
|
|
ht = MEM_callocN(sizeof(HeaderType), "python buttons header");
|
2009-04-19 17:12:16 +00:00
|
|
|
memcpy(ht, &dummyht, sizeof(dummyht));
|
|
|
|
|
2013-01-09 05:32:15 +00:00
|
|
|
ht->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ht->idname, &RNA_Header);
|
2012-03-05 23:30:41 +00:00
|
|
|
ht->ext.data = data;
|
|
|
|
ht->ext.call = call;
|
|
|
|
ht->ext.free = free;
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_struct_blender_type_set(ht->ext.srna, ht);
|
2009-04-19 17:12:16 +00:00
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
ht->draw = (have_function[0]) ? header_draw : NULL;
|
2009-04-19 17:12:16 +00:00
|
|
|
|
|
|
|
BLI_addtail(&art->headertypes, ht);
|
|
|
|
|
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
2009-04-19 17:12:16 +00:00
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
return ht->ext.srna;
|
2009-04-19 17:12:16 +00:00
|
|
|
}
|
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
static StructRNA *rna_Header_refine(PointerRNA *htr)
|
2009-04-19 17:12:16 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
Header *hdr = (Header *)htr->data;
|
|
|
|
return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Header;
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
|
|
|
|
2009-04-22 18:39:44 +00:00
|
|
|
/* Menu */
|
|
|
|
|
|
|
|
static int menu_poll(const bContext *C, MenuType *pt)
|
|
|
|
{
|
2011-10-19 22:40:03 +00:00
|
|
|
extern FunctionRNA rna_Menu_poll_func;
|
|
|
|
|
2009-04-22 18:39:44 +00:00
|
|
|
PointerRNA ptr;
|
2009-07-17 02:31:28 +00:00
|
|
|
ParameterList list;
|
2009-04-22 18:39:44 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
void *ret;
|
|
|
|
int visible;
|
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = &rna_Menu_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_create(&list, &ptr, func);
|
|
|
|
RNA_parameter_set_lookup(&list, "context", &C);
|
2010-12-07 04:12:15 +00:00
|
|
|
pt->ext.call((bContext *)C, &ptr, func, &list);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_get_lookup(&list, "visible", &ret);
|
2012-05-12 11:01:29 +00:00
|
|
|
visible = *(int *)ret;
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_free(&list);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
return visible;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void menu_draw(const bContext *C, Menu *hdr)
|
|
|
|
{
|
2011-10-19 22:40:03 +00:00
|
|
|
extern FunctionRNA rna_Menu_draw_func;
|
|
|
|
|
2009-04-22 18:39:44 +00:00
|
|
|
PointerRNA mtr;
|
2009-07-17 02:31:28 +00:00
|
|
|
ParameterList list;
|
2009-04-22 18:39:44 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &mtr);
|
2012-03-05 23:30:41 +00:00
|
|
|
func = &rna_Menu_draw_func; /* RNA_struct_find_function(&mtr, "draw"); */
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_create(&list, &mtr, func);
|
|
|
|
RNA_parameter_set_lookup(&list, "context", &C);
|
2010-12-07 04:12:15 +00:00
|
|
|
hdr->type->ext.call((bContext *)C, &mtr, func, &list);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2009-07-17 02:31:28 +00:00
|
|
|
RNA_parameter_list_free(&list);
|
2009-04-22 18:39:44 +00:00
|
|
|
}
|
|
|
|
|
2011-05-31 02:14:25 +00:00
|
|
|
static void rna_Menu_unregister(Main *UNUSED(bmain), StructRNA *type)
|
2009-04-22 18:39:44 +00:00
|
|
|
{
|
2012-03-05 23:30:41 +00:00
|
|
|
MenuType *mt = RNA_struct_blender_type_get(type);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (!mt)
|
2009-04-22 18:39:44 +00:00
|
|
|
return;
|
|
|
|
|
2009-08-16 07:26:29 +00:00
|
|
|
RNA_struct_free_extension(type, &mt->ext);
|
2009-08-14 12:29:55 +00:00
|
|
|
|
2009-10-08 19:06:32 +00:00
|
|
|
WM_menutype_freelink(mt);
|
|
|
|
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_struct_free(&BLENDER_RNA, type);
|
|
|
|
|
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
2009-04-22 18:39:44 +00:00
|
|
|
}
|
|
|
|
|
2011-11-15 15:24:57 +00:00
|
|
|
static char _menu_descr[RNA_DYN_DESCR_MAX];
|
2011-09-19 13:23:58 +00:00
|
|
|
static StructRNA *rna_Menu_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
|
|
|
|
StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
|
2009-04-22 18:39:44 +00:00
|
|
|
{
|
2011-03-03 17:58:06 +00:00
|
|
|
MenuType *mt, dummymt = {NULL};
|
2012-03-05 23:30:41 +00:00
|
|
|
Menu dummymenu = {NULL};
|
2009-04-22 18:39:44 +00:00
|
|
|
PointerRNA dummymtr;
|
|
|
|
int have_function[2];
|
2012-03-05 23:30:41 +00:00
|
|
|
size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */
|
|
|
|
size_t description_size = 0;
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
/* setup dummy menu & menu type to store static properties in */
|
2012-03-05 23:30:41 +00:00
|
|
|
dummymenu.type = &dummymt;
|
|
|
|
dummymenu.type->description = _menu_descr;
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_pointer_create(NULL, &RNA_Menu, &dummymenu, &dummymtr);
|
|
|
|
|
2012-03-09 00:41:09 +00:00
|
|
|
/* clear in case they are left unset */
|
2012-03-05 23:30:41 +00:00
|
|
|
_menu_descr[0] = '\0';
|
2013-03-19 19:37:22 +00:00
|
|
|
/* We have to set default context! Else we get a void string... */
|
|
|
|
strcpy(dummymt.translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
|
2011-11-15 14:58:14 +00:00
|
|
|
|
2009-04-22 18:39:44 +00:00
|
|
|
/* validate the python class */
|
2012-03-05 23:30:41 +00:00
|
|
|
if (validate(&dummymtr, data, have_function) != 0)
|
2009-04-22 18:39:44 +00:00
|
|
|
return NULL;
|
2009-12-22 10:04:15 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
if (strlen(identifier) >= sizeof(dummymt.idname)) {
|
2012-10-21 14:02:30 +00:00
|
|
|
BKE_reportf(reports, RPT_ERROR, "Registering menu class: '%s' is too long, maximum length is %d",
|
2011-09-19 13:23:58 +00:00
|
|
|
identifier, (int)sizeof(dummymt.idname));
|
2009-12-22 10:04:15 +00:00
|
|
|
return NULL;
|
|
|
|
}
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
/* check if we have registered this menu type before, and remove it */
|
2012-03-05 23:30:41 +00:00
|
|
|
mt = WM_menutype_find(dummymt.idname, TRUE);
|
|
|
|
if (mt && mt->ext.srna)
|
2011-05-18 10:56:26 +00:00
|
|
|
rna_Menu_unregister(bmain, mt->ext.srna);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
/* create a new menu type */
|
2011-11-15 14:58:14 +00:00
|
|
|
if (_menu_descr[0]) {
|
2012-03-05 23:30:41 +00:00
|
|
|
description_size = strlen(_menu_descr) + 1;
|
2011-11-15 14:58:14 +00:00
|
|
|
over_alloc += description_size;
|
|
|
|
}
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
mt = MEM_callocN(sizeof(MenuType) + over_alloc, "python buttons menu");
|
2009-04-22 18:39:44 +00:00
|
|
|
memcpy(mt, &dummymt, sizeof(dummymt));
|
|
|
|
|
2011-11-15 14:58:14 +00:00
|
|
|
if (_menu_descr[0]) {
|
2012-03-05 23:30:41 +00:00
|
|
|
char *buf = (char *)(mt + 1);
|
2011-11-15 14:58:14 +00:00
|
|
|
memcpy(buf, _menu_descr, description_size);
|
2012-03-05 23:30:41 +00:00
|
|
|
mt->description = buf;
|
2011-11-15 14:58:14 +00:00
|
|
|
}
|
|
|
|
|
2013-01-09 05:32:15 +00:00
|
|
|
mt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, mt->idname, &RNA_Menu);
|
2013-03-15 14:32:29 +00:00
|
|
|
RNA_def_struct_translation_context(mt->ext.srna, mt->translation_context);
|
2012-03-05 23:30:41 +00:00
|
|
|
mt->ext.data = data;
|
|
|
|
mt->ext.call = call;
|
|
|
|
mt->ext.free = free;
|
2009-07-21 20:05:16 +00:00
|
|
|
RNA_struct_blender_type_set(mt->ext.srna, mt);
|
2010-08-19 10:16:30 +00:00
|
|
|
RNA_def_struct_flag(mt->ext.srna, STRUCT_NO_IDPROPERTIES);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
mt->poll = (have_function[0]) ? menu_poll : NULL;
|
|
|
|
mt->draw = (have_function[1]) ? menu_draw : NULL;
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2009-10-08 19:06:32 +00:00
|
|
|
WM_menutype_add(mt);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
/* update while blender is running */
|
2013-01-09 13:15:23 +00:00
|
|
|
WM_main_add_notifier(NC_WINDOW, NULL);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2009-07-21 20:05:16 +00:00
|
|
|
return mt->ext.srna;
|
2009-04-22 18:39:44 +00:00
|
|
|
}
|
|
|
|
|
2012-05-12 11:01:29 +00:00
|
|
|
static StructRNA *rna_Menu_refine(PointerRNA *mtr)
|
2009-04-22 18:39:44 +00:00
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
Menu *hdr = (Menu *)mtr->data;
|
|
|
|
return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Menu;
|
2009-04-22 18:39:44 +00:00
|
|
|
}
|
|
|
|
|
2011-11-15 14:58:14 +00:00
|
|
|
static void rna_Menu_bl_description_set(PointerRNA *ptr, const char *value)
|
|
|
|
{
|
2012-05-12 11:01:29 +00:00
|
|
|
Menu *data = (Menu *)(ptr->data);
|
2012-03-05 23:30:41 +00:00
|
|
|
char *str = (char *)data->type->description;
|
2012-05-12 11:01:29 +00:00
|
|
|
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");
|
2011-11-15 14:58:14 +00:00
|
|
|
}
|
|
|
|
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
/* UILayout */
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static int rna_UILayout_active_get(PointerRNA *ptr)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetActive(ptr->data);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_active_set(PointerRNA *ptr, int value)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetActive(ptr->data, value);
|
2009-05-28 23:37:55 +00:00
|
|
|
}
|
|
|
|
|
2011-01-03 13:33:07 +00:00
|
|
|
static int rna_UILayout_alert_get(PointerRNA *ptr)
|
2011-01-02 23:47:48 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetRedAlert(ptr->data);
|
|
|
|
}
|
|
|
|
|
2011-01-03 13:33:07 +00:00
|
|
|
static void rna_UILayout_alert_set(PointerRNA *ptr, int value)
|
2011-01-02 23:47:48 +00:00
|
|
|
{
|
|
|
|
uiLayoutSetRedAlert(ptr->data, value);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_op_context_set(PointerRNA *ptr, int value)
|
2009-06-09 10:30:11 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetOperatorContext(ptr->data, value);
|
2009-06-09 10:30:11 +00:00
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static int rna_UILayout_op_context_get(PointerRNA *ptr)
|
2009-06-09 10:30:11 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetOperatorContext(ptr->data);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static int rna_UILayout_enabled_get(PointerRNA *ptr)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetEnabled(ptr->data);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_enabled_set(PointerRNA *ptr, int value)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetEnabled(ptr->data, value);
|
2009-05-28 23:37:55 +00:00
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
#if 0
|
|
|
|
static int rna_UILayout_red_alert_get(PointerRNA *ptr)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetRedAlert(ptr->data);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_red_alert_set(PointerRNA *ptr, int value)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetRedAlert(ptr->data, value);
|
2009-05-28 23:37:55 +00:00
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static int rna_UILayout_keep_aspect_get(PointerRNA *ptr)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetKeepAspect(ptr->data);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_keep_aspect_set(PointerRNA *ptr, int value)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetKeepAspect(ptr->data, value);
|
2009-05-28 23:37:55 +00:00
|
|
|
}
|
2009-07-21 01:26:17 +00:00
|
|
|
#endif
|
2009-05-28 23:37:55 +00:00
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static int rna_UILayout_alignment_get(PointerRNA *ptr)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetAlignment(ptr->data);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_alignment_set(PointerRNA *ptr, int value)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetAlignment(ptr->data, value);
|
2009-05-28 23:37:55 +00:00
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static float rna_UILayout_scale_x_get(PointerRNA *ptr)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
2009-06-03 00:04:48 +00:00
|
|
|
return uiLayoutGetScaleX(ptr->data);
|
2009-05-28 23:37:55 +00:00
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_scale_x_set(PointerRNA *ptr, float value)
|
2009-05-28 23:37:55 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetScaleX(ptr->data, value);
|
2009-06-03 00:04:48 +00:00
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static float rna_UILayout_scale_y_get(PointerRNA *ptr)
|
2009-06-03 00:04:48 +00:00
|
|
|
{
|
|
|
|
return uiLayoutGetScaleY(ptr->data);
|
|
|
|
}
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
static void rna_UILayout_scale_y_set(PointerRNA *ptr, float value)
|
2009-06-03 00:04:48 +00:00
|
|
|
{
|
RNA
* Mesh.add_geometry, Mesh.update and make indices editable. This
is without checking if they are valid still, no time now to
implement this.
* Also fix warnings in rna_ui.c, and a bug in CDDM_calc_edges.
Example code:
co = [0.0, 0.0, 0.0] + [1.0, 0.0, 0.0] + [0.0, 1.0, 0.0] + [1.0, 1.0, 0.0]
faces = [0, 1, 2, 0] + [1, 3, 2, 0]
mesh.add_geometry(4, 0, 2)
mesh.verts.foreach_set("co", co)
mesh.faces.foreach_set("verts", faces)
mesh.update()
2009-07-01 12:19:00 +00:00
|
|
|
uiLayoutSetScaleY(ptr->data, value);
|
2009-05-28 23:37:55 +00:00
|
|
|
}
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
#else /* RNA_RUNTIME */
|
2009-04-08 16:40:46 +00:00
|
|
|
|
|
|
|
static void rna_def_ui_layout(BlenderRNA *brna)
|
|
|
|
{
|
|
|
|
StructRNA *srna;
|
2009-05-28 23:37:55 +00:00
|
|
|
PropertyRNA *prop;
|
|
|
|
|
|
|
|
static EnumPropertyItem alignment_items[] = {
|
2009-06-16 00:52:21 +00:00
|
|
|
{UI_LAYOUT_ALIGN_EXPAND, "EXPAND", 0, "Expand", ""},
|
|
|
|
{UI_LAYOUT_ALIGN_LEFT, "LEFT", 0, "Left", ""},
|
|
|
|
{UI_LAYOUT_ALIGN_CENTER, "CENTER", 0, "Center", ""},
|
2009-10-22 16:35:51 +00:00
|
|
|
{UI_LAYOUT_ALIGN_RIGHT, "RIGHT", 0, "Right", ""},
|
2012-05-12 11:01:29 +00:00
|
|
|
{0, NULL, 0, NULL, NULL}
|
|
|
|
};
|
2009-07-21 01:26:17 +00:00
|
|
|
|
|
|
|
/* layout */
|
2009-04-08 16:40:46 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "UILayout", NULL);
|
2009-04-08 16:40:46 +00:00
|
|
|
RNA_def_struct_sdna(srna, "uiLayout");
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "UI Layout", "User interface layout in a panel or header");
|
2009-04-08 16:40:46 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
|
2009-05-28 23:37:55 +00:00
|
|
|
RNA_def_property_boolean_funcs(prop, "rna_UILayout_active_get", "rna_UILayout_active_set");
|
2009-06-09 10:30:11 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "operator_context", PROP_ENUM, PROP_NONE);
|
2009-06-09 10:30:11 +00:00
|
|
|
RNA_def_property_enum_items(prop, operator_context_items);
|
|
|
|
RNA_def_property_enum_funcs(prop, "rna_UILayout_op_context_get", "rna_UILayout_op_context_set", NULL);
|
2010-08-07 18:34:16 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE);
|
2009-05-28 23:37:55 +00:00
|
|
|
RNA_def_property_boolean_funcs(prop, "rna_UILayout_enabled_get", "rna_UILayout_enabled_set");
|
2012-07-03 19:09:07 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Enabled", "When false, this (sub)layout is grayed out");
|
2010-08-07 18:34:16 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "alert", PROP_BOOLEAN, PROP_NONE);
|
2011-01-03 13:33:07 +00:00
|
|
|
RNA_def_property_boolean_funcs(prop, "rna_UILayout_alert_get", "rna_UILayout_alert_set");
|
2009-05-28 23:37:55 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE);
|
2009-05-28 23:37:55 +00:00
|
|
|
RNA_def_property_enum_items(prop, alignment_items);
|
|
|
|
RNA_def_property_enum_funcs(prop, "rna_UILayout_alignment_get", "rna_UILayout_alignment_set", NULL);
|
|
|
|
|
2009-07-21 01:26:17 +00:00
|
|
|
#if 0
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "keep_aspect", PROP_BOOLEAN, PROP_NONE);
|
2009-05-28 23:37:55 +00:00
|
|
|
RNA_def_property_boolean_funcs(prop, "rna_UILayout_keep_aspect_get", "rna_UILayout_keep_aspect_set");
|
2009-07-21 01:26:17 +00:00
|
|
|
#endif
|
2009-05-28 23:37:55 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "scale_x", PROP_FLOAT, PROP_UNSIGNED);
|
2009-06-03 00:04:48 +00:00
|
|
|
RNA_def_property_float_funcs(prop, "rna_UILayout_scale_x_get", "rna_UILayout_scale_x_set", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Scale X", "Scale factor along the X for items in this (sub)layout");
|
2010-08-07 18:34:16 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "scale_y", PROP_FLOAT, PROP_UNSIGNED);
|
2009-06-03 00:04:48 +00:00
|
|
|
RNA_def_property_float_funcs(prop, "rna_UILayout_scale_y_get", "rna_UILayout_scale_y_set", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Scale Y", "Scale factor along the Y for items in this (sub)layout");
|
2009-04-08 16:40:46 +00:00
|
|
|
RNA_api_ui_layout(srna);
|
|
|
|
}
|
|
|
|
|
2009-04-19 13:37:59 +00:00
|
|
|
static void rna_def_panel(BlenderRNA *brna)
|
|
|
|
{
|
|
|
|
StructRNA *srna;
|
|
|
|
PropertyRNA *prop;
|
2009-12-26 17:49:08 +00:00
|
|
|
PropertyRNA *parm;
|
2009-04-19 13:37:59 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
|
2010-08-26 01:05:37 +00:00
|
|
|
static EnumPropertyItem panel_flag_items[] = {
|
2012-05-12 11:01:29 +00:00
|
|
|
{PNL_DEFAULT_CLOSED, "DEFAULT_CLOSED", 0, "Default Closed",
|
|
|
|
"Defines if the panel has to be open or collapsed at the time of its creation"},
|
2012-12-12 12:50:45 +00:00
|
|
|
{PNL_NO_HEADER, "HIDE_HEADER", 0, "Hide Header",
|
|
|
|
"If set to False, the panel shows a header, which contains a clickable "
|
2012-05-12 11:01:29 +00:00
|
|
|
"arrow to collapse the panel and the label (see bl_label)"},
|
|
|
|
{0, NULL, 0, NULL, NULL}
|
|
|
|
};
|
2010-08-26 01:05:37 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "Panel", NULL);
|
2010-08-04 16:57:24 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "Panel", "Panel containing UI elements");
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_struct_sdna(srna, "Panel");
|
|
|
|
RNA_def_struct_refine_func(srna, "rna_Panel_refine");
|
2011-05-18 11:21:10 +00:00
|
|
|
RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister", NULL);
|
2013-03-19 19:37:22 +00:00
|
|
|
RNA_def_struct_translation_context(srna, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
/* poll */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "poll", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "If this method returns a non-null output, then the panel can be drawn");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "context", "Context", "", "");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
/* draw */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "draw", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "Draw UI elements into the panel UI layout");
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_REGISTER);
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "context", "Context", "", "");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "draw_header", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "Draw UI elements into the panel's header UI layout");
|
2013-01-28 12:18:00 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "context", "Context", "", "");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
|
2009-05-19 17:13:33 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_property_struct_type(prop, "UILayout");
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the panel in the UI");
|
2010-08-04 16:57:24 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "text", PROP_STRING, PROP_NONE);
|
2009-07-28 16:46:14 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "drawname");
|
2010-08-04 16:57:24 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Text", "XXX todo");
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
/* registration */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->idname");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER | PROP_NEVER_CLAMP);
|
2011-09-19 13:23:58 +00:00
|
|
|
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\"");
|
2012-02-16 15:53:30 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->label");
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER);
|
2011-09-19 13:23:58 +00:00
|
|
|
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");
|
2013-03-15 14:32:29 +00:00
|
|
|
|
|
|
|
prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE);
|
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->translation_context");
|
2013-03-19 19:37:22 +00:00
|
|
|
RNA_def_property_string_default(prop, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
|
2013-03-15 14:32:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
|
|
|
|
RNA_define_verify_sdna(TRUE);
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE);
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
|
|
|
|
RNA_def_property_enum_items(prop, space_type_items);
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Space type", "The space where the panel is going to be used in");
|
2010-08-04 16:57:24 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_region_type", PROP_ENUM, PROP_NONE);
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_enum_sdna(prop, NULL, "type->region_type");
|
|
|
|
RNA_def_property_enum_items(prop, region_type_items);
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Region Type", "The region where the panel is going to be used in");
|
2009-04-19 13:37:59 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_context", PROP_STRING, PROP_NONE);
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->context");
|
2012-04-28 08:27:09 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); /* Only used in Properties Editor and 3D View - Thomas */
|
2011-09-19 13:23:58 +00:00
|
|
|
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)");
|
2010-08-04 16:57:24 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_options", PROP_ENUM, PROP_NONE);
|
2010-08-26 01:05:37 +00:00
|
|
|
RNA_def_property_enum_sdna(prop, NULL, "type->flag");
|
|
|
|
RNA_def_property_enum_items(prop, panel_flag_items);
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL | PROP_ENUM_FLAG);
|
2010-08-26 01:05:37 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Options", "Options for this panel type");
|
2009-04-19 17:12:16 +00:00
|
|
|
}
|
|
|
|
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
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);
|
2013-08-29 12:55:31 +00:00
|
|
|
RNA_def_struct_idprops_func(srna, "rna_UIList_idprops");
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
|
2013-08-29 12:55:31 +00:00
|
|
|
/* 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 | PROP_NEVER_CLAMP);
|
|
|
|
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, 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_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)");
|
|
|
|
|
2013-08-30 11:49:35 +00:00
|
|
|
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");
|
2013-08-29 12:55:31 +00:00
|
|
|
|
2013-08-30 11:49:35 +00:00
|
|
|
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);
|
2013-08-29 12:55:31 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Invert", "Invert the order of shown items");
|
|
|
|
|
|
|
|
/* draw_item */
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
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...)");
|
2013-01-28 18:46:04 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
parm = RNA_def_pointer(func, "context", "Context", "", "");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
|
|
|
parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
|
|
|
|
parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
|
|
|
|
parm = RNA_def_pointer(func, "item", "AnyType", "", "Item of the collection property");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
|
|
|
|
parm = RNA_def_int(func, "icon", 0, 0, INT_MAX, "", "Icon of the item in the collection", 0, INT_MAX);
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
|
|
|
parm = RNA_def_pointer(func, "active_data", "AnyType", "",
|
|
|
|
"Data from which to take property for the active element");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR | PROP_NEVER_NULL);
|
|
|
|
parm = RNA_def_string(func, "active_property", "", 0, "",
|
|
|
|
"Identifier of property in active_data, for the active element");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
|
|
|
RNA_def_int(func, "index", 0, 0, INT_MAX, "", "Index of the item in the collection", 0, INT_MAX);
|
2013-08-29 12:55:31 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_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_property_flag(parm, PROP_REQUIRED | PROP_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", "", "");
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
2013-08-29 12:55:31 +00:00
|
|
|
parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
|
2013-08-29 12:55:31 +00:00
|
|
|
/* 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_property_flag(parm, PROP_REQUIRED);
|
|
|
|
parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
|
|
|
|
parm = RNA_def_string(func, "property", "", 0, "", "Identifier of property in data, for the collection");
|
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
|
|
|
prop = RNA_def_property(func, "filter_flags", PROP_INT, PROP_UNSIGNED);
|
|
|
|
RNA_def_property_flag(prop, PROP_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, PROP_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",
|
2013-09-09 20:22:01 +00:00
|
|
|
"The value of the reserved bitflag 'FILTER_ITEM' (in filter_flags values)");
|
2013-08-29 12:55:31 +00:00
|
|
|
RNA_def_property_int_funcs(prop, "rna_UIList_filter_const_FILTER_ITEM_get", NULL, NULL);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_EDITABLE);
|
|
|
|
}
|
|
|
|
|
2009-04-19 17:12:16 +00:00
|
|
|
static void rna_def_header(BlenderRNA *brna)
|
|
|
|
{
|
|
|
|
StructRNA *srna;
|
|
|
|
PropertyRNA *prop;
|
2009-12-26 17:49:08 +00:00
|
|
|
PropertyRNA *parm;
|
2009-04-19 17:12:16 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "Header", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "Header", "Editor header containing UI elements");
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_struct_sdna(srna, "Header");
|
|
|
|
RNA_def_struct_refine_func(srna, "rna_Header_refine");
|
2011-05-18 11:21:10 +00:00
|
|
|
RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister", NULL);
|
2009-04-19 17:12:16 +00:00
|
|
|
|
|
|
|
/* draw */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "draw", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "Draw UI elements into the header UI layout");
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_REGISTER);
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "context", "Context", "", "");
|
2009-12-26 17:49:08 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
2009-04-19 17:12:16 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
RNA_define_verify_sdna(0); /* not in sdna */
|
2009-07-21 01:14:55 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
|
2009-07-21 01:14:55 +00:00
|
|
|
RNA_def_property_pointer_sdna(prop, NULL, "layout");
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_struct_type(prop, "UILayout");
|
2011-09-29 14:41:11 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Layout", "Structure of the header in the UI");
|
2009-04-19 17:12:16 +00:00
|
|
|
|
|
|
|
/* registration */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->idname");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER | PROP_NEVER_CLAMP);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "ID Name",
|
|
|
|
"If this is set, the header gets a custom ID, otherwise it takes the "
|
2011-09-29 14:41:11 +00:00
|
|
|
"name of the class used to define the panel; for example, if the "
|
2011-09-19 13:23:58 +00:00
|
|
|
"class name is \"OBJECT_HT_hello\", and bl_idname is not set by the "
|
|
|
|
"script, then bl_idname = \"OBJECT_HT_hello\"");
|
2009-04-19 17:12:16 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE);
|
2009-04-19 17:12:16 +00:00
|
|
|
RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
|
|
|
|
RNA_def_property_enum_items(prop, space_type_items);
|
2009-04-19 13:37:59 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Space type", "The space where the header is going to be used in");
|
2009-07-21 01:14:55 +00:00
|
|
|
|
|
|
|
RNA_define_verify_sdna(1);
|
2009-04-19 13:37:59 +00:00
|
|
|
}
|
|
|
|
|
2009-04-22 18:39:44 +00:00
|
|
|
static void rna_def_menu(BlenderRNA *brna)
|
|
|
|
{
|
|
|
|
StructRNA *srna;
|
|
|
|
PropertyRNA *prop;
|
2009-12-26 17:49:08 +00:00
|
|
|
PropertyRNA *parm;
|
2009-04-22 18:39:44 +00:00
|
|
|
FunctionRNA *func;
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
srna = RNA_def_struct(brna, "Menu", NULL);
|
2010-02-10 21:15:44 +00:00
|
|
|
RNA_def_struct_ui_text(srna, "Menu", "Editor menu containing buttons");
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_def_struct_sdna(srna, "Menu");
|
|
|
|
RNA_def_struct_refine_func(srna, "rna_Menu_refine");
|
2011-05-18 11:21:10 +00:00
|
|
|
RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister", NULL);
|
2013-03-19 19:37:22 +00:00
|
|
|
RNA_def_struct_translation_context(srna, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
/* poll */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "poll", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "If this method returns a non-null output, then the menu can be drawn");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "context", "Context", "", "");
|
2009-12-26 17:49:08 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
/* draw */
|
2012-03-05 23:30:41 +00:00
|
|
|
func = RNA_def_function(srna, "draw", NULL);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_function_ui_description(func, "Draw UI elements into the menu UI layout");
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_def_function_flag(func, FUNC_REGISTER);
|
2012-03-05 23:30:41 +00:00
|
|
|
parm = RNA_def_pointer(func, "context", "Context", "", "");
|
2009-12-26 17:49:08 +00:00
|
|
|
RNA_def_property_flag(parm, PROP_REQUIRED);
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2013-03-15 14:32:29 +00:00
|
|
|
RNA_define_verify_sdna(FALSE); /* not in sdna */
|
2009-07-21 01:14:55 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
|
2009-07-21 01:14:55 +00:00
|
|
|
RNA_def_property_pointer_sdna(prop, NULL, "layout");
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_def_property_struct_type(prop, "UILayout");
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the menu in the UI");
|
2009-04-22 18:39:44 +00:00
|
|
|
|
|
|
|
/* registration */
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->idname");
|
2012-05-12 11:01:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER | PROP_NEVER_CLAMP);
|
2011-09-19 13:23:58 +00:00
|
|
|
RNA_def_property_ui_text(prop, "ID Name",
|
|
|
|
"If this is set, the menu gets a custom ID, otherwise it takes the "
|
2011-10-02 08:46:46 +00:00
|
|
|
"name of the class used to define the menu (for example, if the "
|
2011-09-19 13:23:58 +00:00
|
|
|
"class name is \"OBJECT_MT_hello\", and bl_idname is not set by the "
|
2011-10-02 08:46:46 +00:00
|
|
|
"script, then bl_idname = \"OBJECT_MT_hello\")");
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
|
2009-04-22 18:39:44 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->label");
|
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER);
|
2010-08-04 16:57:24 +00:00
|
|
|
RNA_def_property_ui_text(prop, "Label", "The menu label");
|
2009-04-22 18:39:44 +00:00
|
|
|
|
2013-03-15 14:32:29 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE);
|
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->translation_context");
|
2013-03-19 19:37:22 +00:00
|
|
|
RNA_def_property_string_default(prop, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
|
2013-03-15 14:32:29 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
|
|
|
|
|
2013-01-05 13:52:41 +00:00
|
|
|
prop = RNA_def_property(srna, "bl_description", PROP_STRING, PROP_NONE);
|
2011-11-15 14:58:14 +00:00
|
|
|
RNA_def_property_string_sdna(prop, NULL, "type->description");
|
2011-11-15 15:24:57 +00:00
|
|
|
RNA_def_property_string_maxlength(prop, RNA_DYN_DESCR_MAX); /* else it uses the pointer size! */
|
2011-11-15 14:58:14 +00:00
|
|
|
RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Menu_bl_description_set");
|
2012-03-05 23:30:41 +00:00
|
|
|
/* RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
|
2011-11-15 14:58:14 +00:00
|
|
|
RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
|
2012-04-09 04:39:47 +00:00
|
|
|
RNA_def_property_clear_flag(prop, PROP_NEVER_NULL); /* check for NULL */
|
2011-11-15 14:58:14 +00:00
|
|
|
|
2009-07-21 01:14:55 +00:00
|
|
|
RNA_define_verify_sdna(1);
|
2009-04-22 18:39:44 +00:00
|
|
|
}
|
|
|
|
|
2009-04-08 16:40:46 +00:00
|
|
|
void RNA_def_ui(BlenderRNA *brna)
|
|
|
|
{
|
|
|
|
rna_def_ui_layout(brna);
|
2009-04-19 13:37:59 +00:00
|
|
|
rna_def_panel(brna);
|
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one).
It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels!
This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore!
To make all this work, other changes were also necessary:
* Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox.
* DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not.
* UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon.
* UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews).
Note: not sure whether we should add that one to all UILayout's prop funcs?
Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
|
|
|
rna_def_uilist(brna);
|
2009-04-19 17:12:16 +00:00
|
|
|
rna_def_header(brna);
|
2009-04-22 18:39:44 +00:00
|
|
|
rna_def_menu(brna);
|
2009-04-08 16:40:46 +00:00
|
|
|
}
|
|
|
|
|
2012-03-05 23:30:41 +00:00
|
|
|
#endif /* RNA_RUNTIME */
|
2009-04-08 16:40:46 +00:00
|
|
|
|