source/blender/makesrna/intern/rna_ui.c

   1 /**
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19  *
  20  * Contributor(s): Blender Foundation (2009)
  21  *
  22  * ***** END GPL LICENSE BLOCK *****
  23  */
  24
  25 #include <stdlib.h>
  26
  27 #include "DNA_screen_types.h"
  28
  29 #include "RNA_define.h"
  30 #include "RNA_types.h"
  31
  32 #include "rna_internal.h"
  33 #include "RNA_enum_types.h"
  34
  35 #include "UI_interface.h"
  36
  37 #include "WM_types.h"
  38
  39 #ifdef RNA_RUNTIME
  40
  41 #include "MEM_guardedalloc.h"
  42
  43 #include "RNA_access.h"
  44
  45 #include "BLI_dynstr.h"
  46
  47 #include "BKE_context.h"
  48 #include "BKE_report.h"
  49 #include "BKE_screen.h"
  50
  51 #include "WM_api.h"
  52
  53 static ARegionType *region_type_find(ReportList *reports, int space_type, int region_type)
  54 {
  55         SpaceType *st;
  56         ARegionType *art;
  57
  58         st= BKE_spacetype_from_id(space_type);
  59
  60         for(art= (st)? st->regiontypes.first: NULL; art; art= art->next) {
  61                 if (art->regionid==region_type)
  62                         break;
  63         }
  64
  65         /* region type not found? abort */
  66         if (art==NULL) {
  67                 BKE_report(reports, RPT_ERROR, "Region not found in spacetype.");
  68                 return NULL;
  69         }
  70
  71         return art;
  72 }
  73
  74 /* Panel */
  75
  76 static int panel_poll(const bContext *C, PanelType *pt)
  77 {
  78         PointerRNA ptr;
  79         ParameterList list;
  80         FunctionRNA *func;
  81         void *ret;
  82         int visible;
  83
  84         RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */
  85         func= RNA_struct_find_function(&ptr, "poll");
  86
  87         RNA_parameter_list_create(&list, &ptr, func);
  88         RNA_parameter_set_lookup(&list, "context", &C);
  89         pt->ext.call(&ptr, func, &list);
  90
  91         RNA_parameter_get_lookup(&list, "visible", &ret);
  92         visible= *(int*)ret;
  93
  94         RNA_parameter_list_free(&list);
  95
  96         return visible;
  97 }
  98
  99 static void panel_draw(const bContext *C, Panel *pnl)
 100 {
 101         PointerRNA ptr;
 102         ParameterList list;
 103         FunctionRNA *func;
 104
 105         RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr);
 106         func= RNA_struct_find_function(&ptr, "draw");
 107
 108         RNA_parameter_list_create(&list, &ptr, func);
 109         RNA_parameter_set_lookup(&list, "context", &C);
 110         pnl->type->ext.call(&ptr, func, &list);
 111
 112         RNA_parameter_list_free(&list);
 113 }
 114
 115 static void panel_draw_header(const bContext *C, Panel *pnl)
 116 {
 117         PointerRNA ptr;
 118         ParameterList list;
 119         FunctionRNA *func;
 120
 121         RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr);
 122         func= RNA_struct_find_function(&ptr, "draw_header");
 123
 124         RNA_parameter_list_create(&list, &ptr, func);
 125         RNA_parameter_set_lookup(&list, "context", &C);
 126         pnl->type->ext.call(&ptr, func, &list);
 127
 128         RNA_parameter_list_free(&list);
 129 }
 130
 131 static void rna_Panel_unregister(const bContext *C, StructRNA *type)
 132 {
 133         ARegionType *art;
 134         PanelType *pt= RNA_struct_blender_type_get(type);
 135
 136         if(!pt)
 137                 return;
 138         if(!(art=region_type_find(NULL, pt->space_type, pt->region_type)))
 139                 return;
 140
 141         RNA_struct_free_extension(type, &pt->ext);
 142
 143         BLI_freelinkN(&art->paneltypes, pt);
 144         RNA_struct_free(&BLENDER_RNA, type);
 145
 146         /* update while blender is running */
 147         if(C)
 148                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
 149 }
 150
 151 static StructRNA *rna_Panel_register(const bContext *C, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
 152 {
 153         ARegionType *art;
 154         PanelType *pt, dummypt = {0};
 155         Panel dummypanel= {0};
 156         PointerRNA dummyptr;
 157         int have_function[3];
 158
 159         /* setup dummy panel & panel type to store static properties in */
 160         dummypanel.type= &dummypt;
 161         RNA_pointer_create(NULL, &RNA_Panel, &dummypanel, &dummyptr);
 162
 163         /* validate the python class */
 164         if(validate(&dummyptr, data, have_function) != 0)
 165                 return NULL;
 166
 167         if(!(art=region_type_find(reports, dummypt.space_type, dummypt.region_type)))
 168                 return NULL;
 169
 170         /* check if we have registered this panel type before, and remove it */
 171         for(pt=art->paneltypes.first; pt; pt=pt->next) {
 172                 if(strcmp(pt->idname, dummypt.idname) == 0) {
 173                         if(pt->ext.srna)
 174                                 rna_Panel_unregister(C, pt->ext.srna);
 175                         else
 176                                 BLI_freelinkN(&art->paneltypes, pt);
 177                         break;
 178                 }
 179         }
 180
 181         /* create a new panel type */
 182         pt= MEM_callocN(sizeof(PanelType), "python buttons panel");
 183         memcpy(pt, &dummypt, sizeof(dummypt));
 184
 185         pt->ext.srna= RNA_def_struct(&BLENDER_RNA, pt->idname, "Panel");
 186         pt->ext.data= data;
 187         pt->ext.call= call;
 188         pt->ext.free= free;
 189         RNA_struct_blender_type_set(pt->ext.srna, pt);
 190
 191         pt->poll= (have_function[0])? panel_poll: NULL;
 192         pt->draw= (have_function[1])? panel_draw: NULL;
 193         pt->draw_header= (have_function[2])? panel_draw_header: NULL;
 194
 195         BLI_addtail(&art->paneltypes, pt);
 196
 197         /* update while blender is running */
 198         if(C)
 199                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
 200
 201         return pt->ext.srna;
 202 }
 203
 204 static StructRNA* rna_Panel_refine(PointerRNA *ptr)
 205 {
 206         Panel *hdr= (Panel*)ptr->data;
 207         return (hdr->type && hdr->type->ext.srna)? hdr->type->ext.srna: &RNA_Panel;
 208 }
 209
 210 /* Header */
 211
 212 static void header_draw(const bContext *C, Header *hdr)
 213 {
 214         PointerRNA htr;
 215         ParameterList list;
 216         FunctionRNA *func;
 217
 218         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &htr);
 219         func= RNA_struct_find_function(&htr, "draw");
 220
 221         RNA_parameter_list_create(&list, &htr, func);
 222         RNA_parameter_set_lookup(&list, "context", &C);
 223         hdr->type->ext.call(&htr, func, &list);
 224
 225         RNA_parameter_list_free(&list);
 226 }
 227
 228 static void rna_Header_unregister(const bContext *C, StructRNA *type)
 229 {
 230         ARegionType *art;
 231         HeaderType *ht= RNA_struct_blender_type_get(type);
 232
 233         if(!ht)
 234                 return;
 235         if(!(art=region_type_find(NULL, ht->space_type, RGN_TYPE_HEADER)))
 236                 return;
 237
 238         RNA_struct_free_extension(type, &ht->ext);
 239
 240         BLI_freelinkN(&art->headertypes, ht);
 241         RNA_struct_free(&BLENDER_RNA, type);
 242
 243         /* update while blender is running */
 244         if(C)
 245                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
 246 }
 247
 248 static StructRNA *rna_Header_register(const bContext *C, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
 249 {
 250         ARegionType *art;
 251         HeaderType *ht, dummyht = {0};
 252         Header dummyheader= {0};
 253         PointerRNA dummyhtr;
 254         int have_function[1];
 255
 256         /* setup dummy header & header type to store static properties in */
 257         dummyheader.type= &dummyht;
 258         RNA_pointer_create(NULL, &RNA_Header, &dummyheader, &dummyhtr);
 259
 260         /* validate the python class */
 261         if(validate(&dummyhtr, data, have_function) != 0)
 262                 return NULL;
 263
 264         if(!(art=region_type_find(reports, dummyht.space_type, RGN_TYPE_HEADER)))
 265                 return NULL;
 266
 267         /* check if we have registered this header type before, and remove it */
 268         for(ht=art->headertypes.first; ht; ht=ht->next) {
 269                 if(strcmp(ht->idname, dummyht.idname) == 0) {
 270                         if(ht->ext.srna)
 271                                 rna_Header_unregister(C, ht->ext.srna);
 272                         break;
 273                 }
 274         }
 275
 276         /* create a new header type */
 277         ht= MEM_callocN(sizeof(HeaderType), "python buttons header");
 278         memcpy(ht, &dummyht, sizeof(dummyht));
 279
 280         ht->ext.srna= RNA_def_struct(&BLENDER_RNA, ht->idname, "Header");
 281         ht->ext.data= data;
 282         ht->ext.call= call;
 283         ht->ext.free= free;
 284         RNA_struct_blender_type_set(ht->ext.srna, ht);
 285
 286         ht->draw= (have_function[0])? header_draw: NULL;
 287
 288         BLI_addtail(&art->headertypes, ht);
 289
 290         /* update while blender is running */
 291         if(C)
 292                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
 293
 294         return ht->ext.srna;
 295 }
 296
 297 static StructRNA* rna_Header_refine(PointerRNA *htr)
 298 {
 299         Header *hdr= (Header*)htr->data;
 300         return (hdr->type && hdr->type->ext.srna)? hdr->type->ext.srna: &RNA_Header;
 301 }
 302
 303 /* Menu */
 304
 305 static int menu_poll(const bContext *C, MenuType *pt)
 306 {
 307         PointerRNA ptr;
 308         ParameterList list;
 309         FunctionRNA *func;
 310         void *ret;
 311         int visible;
 312
 313         RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */
 314         func= RNA_struct_find_function(&ptr, "poll");
 315
 316         RNA_parameter_list_create(&list, &ptr, func);
 317         RNA_parameter_set_lookup(&list, "context", &C);
 318         pt->ext.call(&ptr, func, &list);
 319
 320         RNA_parameter_get_lookup(&list, "visible", &ret);
 321         visible= *(int*)ret;
 322
 323         RNA_parameter_list_free(&list);
 324
 325         return visible;
 326 }
 327
 328 static void menu_draw(const bContext *C, Menu *hdr)
 329 {
 330         PointerRNA mtr;
 331         ParameterList list;
 332         FunctionRNA *func;
 333
 334         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &mtr);
 335         func= RNA_struct_find_function(&mtr, "draw");
 336
 337         RNA_parameter_list_create(&list, &mtr, func);
 338         RNA_parameter_set_lookup(&list, "context", &C);
 339         hdr->type->ext.call(&mtr, func, &list);
 340
 341         RNA_parameter_list_free(&list);
 342 }
 343
 344 static void rna_Menu_unregister(const bContext *C, StructRNA *type)
 345 {
 346         ARegionType *art;
 347         MenuType *mt= RNA_struct_blender_type_get(type);
 348
 349         if(!mt)
 350                 return;
 351
 352         RNA_struct_free_extension(type, &mt->ext);
 353
 354         WM_menutype_freelink(mt);
 355
 356         RNA_struct_free(&BLENDER_RNA, type);
 357
 358         /* update while blender is running */
 359         if(C)
 360                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
 361 }
 362
 363 static StructRNA *rna_Menu_register(const bContext *C, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
 364 {
 365         ARegionType *art;
 366         MenuType *mt, dummymt = {0};
 367         Menu dummymenu= {0};
 368         PointerRNA dummymtr;
 369         int have_function[2];
 370
 371         /* setup dummy menu & menu type to store static properties in */
 372         dummymenu.type= &dummymt;
 373         RNA_pointer_create(NULL, &RNA_Menu, &dummymenu, &dummymtr);
 374
 375         /* validate the python class */
 376         if(validate(&dummymtr, data, have_function) != 0)
 377                 return NULL;
 378
 379         /* check if we have registered this menu type before, and remove it */
 380         mt= WM_menutype_find(dummymt.idname, TRUE);
 381         if(mt && mt->ext.srna)
 382                 rna_Menu_unregister(C, mt->ext.srna);
 383
 384         /* create a new menu type */
 385         mt= MEM_callocN(sizeof(MenuType), "python buttons menu");
 386         memcpy(mt, &dummymt, sizeof(dummymt));
 387
 388         mt->ext.srna= RNA_def_struct(&BLENDER_RNA, mt->idname, "Menu");
 389         mt->ext.data= data;
 390         mt->ext.call= call;
 391         mt->ext.free= free;
 392         RNA_struct_blender_type_set(mt->ext.srna, mt);
 393
 394         mt->poll= (have_function[0])? menu_poll: NULL;
 395         mt->draw= (have_function[1])? menu_draw: NULL;
 396
 397         WM_menutype_add(mt);
 398
 399         /* update while blender is running */
 400         if(C)
 401                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
 402
 403         return mt->ext.srna;
 404 }
 405
 406 static StructRNA* rna_Menu_refine(PointerRNA *mtr)
 407 {
 408         Menu *hdr= (Menu*)mtr->data;
 409         return (hdr->type && hdr->type->ext.srna)? hdr->type->ext.srna: &RNA_Menu;
 410 }
 411
 412 static int rna_UILayout_active_get(PointerRNA *ptr)
 413 {
 414         return uiLayoutGetActive(ptr->data);
 415 }
 416
 417 static void rna_UILayout_active_set(PointerRNA *ptr, int value)
 418 {
 419         uiLayoutSetActive(ptr->data, value);
 420 }
 421
 422 static void rna_UILayout_op_context_set(PointerRNA *ptr, int value)
 423 {
 424         uiLayoutSetOperatorContext(ptr->data, value);
 425 }
 426
 427 static int rna_UILayout_op_context_get(PointerRNA *ptr)
 428 {
 429         return uiLayoutGetOperatorContext(ptr->data);
 430 }
 431
 432 static int rna_UILayout_enabled_get(PointerRNA *ptr)
 433 {
 434         return uiLayoutGetEnabled(ptr->data);
 435 }
 436
 437 static void rna_UILayout_enabled_set(PointerRNA *ptr, int value)
 438 {
 439         uiLayoutSetEnabled(ptr->data, value);
 440 }
 441
 442 #if 0
 443 static int rna_UILayout_red_alert_get(PointerRNA *ptr)
 444 {
 445         return uiLayoutGetRedAlert(ptr->data);
 446 }
 447
 448 static void rna_UILayout_red_alert_set(PointerRNA *ptr, int value)
 449 {
 450         uiLayoutSetRedAlert(ptr->data, value);
 451 }
 452
 453 static int rna_UILayout_keep_aspect_get(PointerRNA *ptr)
 454 {
 455         return uiLayoutGetKeepAspect(ptr->data);
 456 }
 457
 458 static void rna_UILayout_keep_aspect_set(PointerRNA *ptr, int value)
 459 {
 460         uiLayoutSetKeepAspect(ptr->data, value);
 461 }
 462 #endif
 463
 464 static int rna_UILayout_alignment_get(PointerRNA *ptr)
 465 {
 466         return uiLayoutGetAlignment(ptr->data);
 467 }
 468
 469 static void rna_UILayout_alignment_set(PointerRNA *ptr, int value)
 470 {
 471         uiLayoutSetAlignment(ptr->data, value);
 472 }
 473
 474 static float rna_UILayout_scale_x_get(PointerRNA *ptr)
 475 {
 476         return uiLayoutGetScaleX(ptr->data);
 477 }
 478
 479 static void rna_UILayout_scale_x_set(PointerRNA *ptr, float value)
 480 {
 481         uiLayoutSetScaleX(ptr->data, value);
 482 }
 483
 484 static float rna_UILayout_scale_y_get(PointerRNA *ptr)
 485 {
 486         return uiLayoutGetScaleY(ptr->data);
 487 }
 488
 489 static void rna_UILayout_scale_y_set(PointerRNA *ptr, float value)
 490 {
 491         uiLayoutSetScaleY(ptr->data, value);
 492 }
 493
 494 static PointerRNA rna_UIListItem_layout_get(PointerRNA *ptr)
 495 {
 496         uiListItem *item= (uiListItem*)ptr->data;
 497         PointerRNA newptr;
 498         RNA_pointer_create(NULL, &RNA_UILayout, item->layout, &newptr);
 499         return newptr;
 500 }
 501
 502 static PointerRNA rna_UIListItem_data_get(PointerRNA *ptr)
 503 {
 504         uiListItem *item= (uiListItem*)ptr->data;
 505         return item->data;
 506 }
 507
 508 #else // RNA_RUNTIME
 509
 510 static void rna_def_ui_layout(BlenderRNA *brna)
 511 {
 512         StructRNA *srna;
 513         PropertyRNA *prop;
 514
 515         static EnumPropertyItem alignment_items[] = {
 516                 {UI_LAYOUT_ALIGN_EXPAND, "EXPAND", 0, "Expand", ""},
 517                 {UI_LAYOUT_ALIGN_LEFT, "LEFT", 0, "Left", ""},
 518                 {UI_LAYOUT_ALIGN_CENTER, "CENTER", 0, "Center", ""},
 519                 {UI_LAYOUT_ALIGN_RIGHT, "RIGHT", 0, "RIght", ""},
 520                 {0, NULL, 0, NULL, NULL}};
 521
 522         /* see WM_types.h */
 523         static EnumPropertyItem operator_context_items[] = {
 524                 {WM_OP_INVOKE_DEFAULT, "INVOKE_DEFAULT", 0, "Invoke Default", ""},
 525                 {WM_OP_INVOKE_REGION_WIN, "INVOKE_REGION_WIN", 0, "Invoke Region Window", ""},
 526                 {WM_OP_INVOKE_AREA, "INVOKE_AREA", 0, "Invoke Area", ""},
 527                 {WM_OP_INVOKE_SCREEN, "INVOKE_SCREEN", 0, "Invoke Screen", ""},
 528                 {WM_OP_EXEC_DEFAULT, "EXEC_DEFAULT", 0, "Exec Default", ""},
 529                 {WM_OP_EXEC_REGION_WIN, "EXEC_REGION_WIN", 0, "Exec Region Window", ""},
 530                 {WM_OP_EXEC_AREA, "EXEC_AREA", 0, "Exec Area", ""},
 531                 {WM_OP_EXEC_SCREEN, "EXEC_SCREEN", 0, "Exec Screen", ""},
 532                 {0, NULL, 0, NULL, NULL}};
 533
 534         /* layout */
 535
 536         srna= RNA_def_struct(brna, "UILayout", NULL);
 537         RNA_def_struct_sdna(srna, "uiLayout");
 538         RNA_def_struct_ui_text(srna, "UI Layout", "User interface layout in a panel or header.");
 539
 540         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
 541         RNA_def_property_boolean_funcs(prop, "rna_UILayout_active_get", "rna_UILayout_active_set");
 542
 543         prop= RNA_def_property(srna, "operator_context", PROP_ENUM, PROP_NONE);
 544         RNA_def_property_enum_items(prop, operator_context_items);
 545         RNA_def_property_enum_funcs(prop, "rna_UILayout_op_context_get", "rna_UILayout_op_context_set", NULL);
 546
 547         prop= RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE);
 548         RNA_def_property_boolean_funcs(prop, "rna_UILayout_enabled_get", "rna_UILayout_enabled_set");
 549
 550 #if 0
 551         prop= RNA_def_property(srna, "red_alert", PROP_BOOLEAN, PROP_NONE);
 552         RNA_def_property_boolean_funcs(prop, "rna_UILayout_red_alert_get", "rna_UILayout_red_alert_set");
 553 #endif
 554
 555         prop= RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE);
 556         RNA_def_property_enum_items(prop, alignment_items);
 557         RNA_def_property_enum_funcs(prop, "rna_UILayout_alignment_get", "rna_UILayout_alignment_set", NULL);
 558
 559 #if 0
 560         prop= RNA_def_property(srna, "keep_aspect", PROP_BOOLEAN, PROP_NONE);
 561         RNA_def_property_boolean_funcs(prop, "rna_UILayout_keep_aspect_get", "rna_UILayout_keep_aspect_set");
 562 #endif
 563
 564         prop= RNA_def_property(srna, "scale_x", PROP_FLOAT, PROP_UNSIGNED);
 565         RNA_def_property_float_funcs(prop, "rna_UILayout_scale_x_get", "rna_UILayout_scale_x_set", NULL);
 566
 567         prop= RNA_def_property(srna, "scale_y", PROP_FLOAT, PROP_UNSIGNED);
 568         RNA_def_property_float_funcs(prop, "rna_UILayout_scale_y_get", "rna_UILayout_scale_y_set", NULL);
 569
 570         RNA_api_ui_layout(srna);
 571
 572         /* list item */
 573
 574         srna= RNA_def_struct(brna, "UIListItem", NULL);
 575         RNA_def_struct_ui_text(srna, "UI List Item", "User interface list.");
 576
 577         prop= RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
 578         RNA_def_property_struct_type(prop, "UILayout");
 579         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
 580         RNA_def_property_pointer_funcs(prop, "rna_UIListItem_layout_get", NULL, NULL);
 581
 582         prop= RNA_def_property(srna, "data", PROP_POINTER, PROP_NONE);
 583         RNA_def_property_struct_type(prop, "AnyType");
 584         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
 585         RNA_def_property_pointer_funcs(prop, "rna_UIListItem_data_get", NULL, NULL);
 586 }
 587
 588 static void rna_def_panel(BlenderRNA *brna)
 589 {
 590         StructRNA *srna;
 591         PropertyRNA *prop;
 592         FunctionRNA *func;
 593
 594         srna= RNA_def_struct(brna, "Panel", NULL);
 595         RNA_def_struct_ui_text(srna, "Panel", "Panel containing buttons.");
 596         RNA_def_struct_sdna(srna, "Panel");
 597         RNA_def_struct_refine_func(srna, "rna_Panel_refine");
 598         RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister");
 599
 600         /* poll */
 601         func= RNA_def_function(srna, "poll", NULL);
 602         RNA_def_function_ui_description(func, "Test if the panel is visible or not.");
 603         RNA_def_function_flag(func, FUNC_REGISTER|FUNC_REGISTER_OPTIONAL);
 604         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
 605         RNA_def_pointer(func, "context", "Context", "", "");
 606
 607         /* draw */
 608         func= RNA_def_function(srna, "draw", NULL);
 609         RNA_def_function_ui_description(func, "Draw buttons into the panel UI layout.");
 610         RNA_def_function_flag(func, FUNC_REGISTER);
 611         RNA_def_pointer(func, "context", "Context", "", "");
 612
 613         func= RNA_def_function(srna, "draw_header", NULL);
 614         RNA_def_function_ui_description(func, "Draw buttons into the panel header UI layout.");
 615         RNA_def_function_flag(func, FUNC_REGISTER);
 616         RNA_def_pointer(func, "context", "Context", "", "");
 617
 618         prop= RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
 619         RNA_def_property_struct_type(prop, "UILayout");
 620
 621         prop= RNA_def_property(srna, "text", PROP_STRING, PROP_NONE);
 622         RNA_def_property_string_sdna(prop, NULL, "drawname");
 623
 624         /* registration */
 625         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
 626         RNA_def_property_string_sdna(prop, NULL, "type->idname");
 627         RNA_def_property_flag(prop, PROP_REGISTER);
 628
 629         prop= RNA_def_property(srna, "label", PROP_STRING, PROP_NONE);
 630         RNA_def_property_string_sdna(prop, NULL, "type->label");
 631         RNA_def_property_flag(prop, PROP_REGISTER);
 632
 633         prop= RNA_def_property(srna, "space_type", PROP_ENUM, PROP_NONE);
 634         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
 635         RNA_def_property_enum_items(prop, space_type_items);
 636         RNA_def_property_flag(prop, PROP_REGISTER);
 637
 638         prop= RNA_def_property(srna, "region_type", PROP_ENUM, PROP_NONE);
 639         RNA_def_property_enum_sdna(prop, NULL, "type->region_type");
 640         RNA_def_property_enum_items(prop, region_type_items);
 641         RNA_def_property_flag(prop, PROP_REGISTER);
 642
 643         prop= RNA_def_property(srna, "context", PROP_STRING, PROP_NONE);
 644         RNA_def_property_string_sdna(prop, NULL, "type->context");
 645         RNA_def_property_flag(prop, PROP_REGISTER);
 646
 647         prop= RNA_def_property(srna, "default_closed", PROP_BOOLEAN, PROP_NONE);
 648         RNA_def_property_boolean_sdna(prop, NULL, "type->flag", PNL_DEFAULT_CLOSED);
 649         RNA_def_property_flag(prop, PROP_REGISTER);
 650
 651         prop= RNA_def_property(srna, "show_header", PROP_BOOLEAN, PROP_NONE);
 652         RNA_def_property_boolean_negative_sdna(prop, NULL, "type->flag", PNL_NO_HEADER);
 653         RNA_def_property_flag(prop, PROP_REGISTER);
 654 }
 655
 656 static void rna_def_header(BlenderRNA *brna)
 657 {
 658         StructRNA *srna;
 659         PropertyRNA *prop;
 660         FunctionRNA *func;
 661
 662         srna= RNA_def_struct(brna, "Header", NULL);
 663         RNA_def_struct_ui_text(srna, "Header", "Editor header containing buttons.");
 664         RNA_def_struct_sdna(srna, "Header");
 665         RNA_def_struct_refine_func(srna, "rna_Header_refine");
 666         RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister");
 667
 668         /* draw */
 669         func= RNA_def_function(srna, "draw", NULL);
 670         RNA_def_function_ui_description(func, "Draw buttons into the header UI layout.");
 671         RNA_def_function_flag(func, FUNC_REGISTER);
 672         RNA_def_pointer(func, "context", "Context", "", "");
 673
 674         RNA_define_verify_sdna(0); // not in sdna
 675
 676         prop= RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
 677         RNA_def_property_pointer_sdna(prop, NULL, "layout");
 678         RNA_def_property_struct_type(prop, "UILayout");
 679
 680         /* registration */
 681         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
 682         RNA_def_property_string_sdna(prop, NULL, "type->idname");
 683         RNA_def_property_flag(prop, PROP_REGISTER);
 684
 685         prop= RNA_def_property(srna, "space_type", PROP_ENUM, PROP_NONE);
 686         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
 687         RNA_def_property_enum_items(prop, space_type_items);
 688         RNA_def_property_flag(prop, PROP_REGISTER);
 689
 690         RNA_define_verify_sdna(1);
 691 }
 692
 693 static void rna_def_menu(BlenderRNA *brna)
 694 {
 695         StructRNA *srna;
 696         PropertyRNA *prop;
 697         FunctionRNA *func;
 698
 699         srna= RNA_def_struct(brna, "Menu", NULL);
 700         RNA_def_struct_ui_text(srna, "Menu", "Editor menu containing buttons.");
 701         RNA_def_struct_sdna(srna, "Menu");
 702         RNA_def_struct_refine_func(srna, "rna_Menu_refine");
 703         RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister");
 704
 705         /* poll */
 706         func= RNA_def_function(srna, "poll", NULL);
 707         RNA_def_function_ui_description(func, "Test if the menu is visible or not.");
 708         RNA_def_function_flag(func, FUNC_REGISTER|FUNC_REGISTER_OPTIONAL);
 709         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
 710         RNA_def_pointer(func, "context", "Context", "", "");
 711
 712         /* draw */
 713         func= RNA_def_function(srna, "draw", NULL);
 714         RNA_def_function_ui_description(func, "Draw buttons into the menu UI layout.");
 715         RNA_def_function_flag(func, FUNC_REGISTER);
 716         RNA_def_pointer(func, "context", "Context", "", "");
 717
 718         RNA_define_verify_sdna(0); // not in sdna
 719
 720         prop= RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
 721         RNA_def_property_pointer_sdna(prop, NULL, "layout");
 722         RNA_def_property_struct_type(prop, "UILayout");
 723
 724         /* registration */
 725         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
 726         RNA_def_property_string_sdna(prop, NULL, "type->idname");
 727         RNA_def_property_flag(prop, PROP_REGISTER);
 728
 729         prop= RNA_def_property(srna, "label", PROP_STRING, PROP_NONE);
 730         RNA_def_property_string_sdna(prop, NULL, "type->label");
 731         RNA_def_property_flag(prop, PROP_REGISTER);
 732
 733         RNA_define_verify_sdna(1);
 734 }
 735
 736 void RNA_def_ui(BlenderRNA *brna)
 737 {
 738         rna_def_ui_layout(brna);
 739         rna_def_panel(brna);
 740         rna_def_header(brna);
 741         rna_def_menu(brna);
 742 }
 743
 744 #endif // RNA_RUNTIME
 745