UI: Preferences Redesign Part 2
[blender.git] / source / blender / makesrna / intern / rna_screen.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008), Nathan Letwory
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_screen.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29 #include <stddef.h>
30
31 #include "RNA_define.h"
32 #include "RNA_enum_types.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_screen_types.h"
37 #include "DNA_scene_types.h"
38 #include "DNA_workspace_types.h"
39
40 const EnumPropertyItem rna_enum_region_type_items[] = {
41         {RGN_TYPE_WINDOW, "WINDOW", 0, "Window", ""},
42         {RGN_TYPE_HEADER, "HEADER", 0, "Header", ""},
43         {RGN_TYPE_CHANNELS, "CHANNELS", 0, "Channels", ""},
44         {RGN_TYPE_TEMPORARY, "TEMPORARY", 0, "Temporary", ""},
45         {RGN_TYPE_UI, "UI", 0, "UI", ""},
46         {RGN_TYPE_TOOLS, "TOOLS", 0, "Tools", ""},
47         {RGN_TYPE_TOOL_PROPS, "TOOL_PROPS", 0, "Tool Properties", ""},
48         {RGN_TYPE_PREVIEW, "PREVIEW", 0, "Preview", ""},
49         {RGN_TYPE_NAV_BAR, "NAVIGATION_BAR", 0, "Navigation Bar", ""},
50         {RGN_TYPE_EXECUTE, "EXECUTE", 0, "Execute Buttons", ""},
51         {0, NULL, 0, NULL, NULL}
52 };
53
54 #include "ED_screen.h"
55
56 #include "WM_api.h"
57 #include "WM_types.h"
58
59 #ifdef RNA_RUNTIME
60
61 #include "BKE_global.h"
62 #include "BKE_workspace.h"
63 #include "BKE_screen.h"
64
65 #include "DEG_depsgraph.h"
66
67 #include "UI_view2d.h"
68
69 #ifdef WITH_PYTHON
70 #  include "BPY_extern.h"
71 #endif
72
73 static void rna_Screen_bar_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
74 {
75         bScreen *screen = (bScreen *)ptr->data;
76         screen->do_draw = true;
77         screen->do_refresh = true;
78 }
79
80 static void rna_Screen_redraw_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
81 {
82         bScreen *screen = (bScreen *)ptr->data;
83
84         /* the settings for this are currently only available from a menu in the TimeLine,
85          * hence refresh=SPACE_ACTION, as timeline is now in there
86          */
87         ED_screen_animation_timer_update(screen, screen->redraws_flag, SPACE_ACTION);
88 }
89
90 static bool rna_Screen_is_animation_playing_get(PointerRNA *UNUSED(ptr))
91 {
92         /* can be NULL on file load, T42619 */
93         wmWindowManager *wm = G_MAIN->wm.first;
94         return wm ? (ED_screen_animation_playing(wm) != NULL) : 0;
95 }
96
97 static int rna_region_alignment_get(PointerRNA *ptr)
98 {
99         ARegion *region = ptr->data;
100         return (region->alignment & ~RGN_SPLIT_PREV);
101 }
102
103 static void rna_Screen_layout_name_get(PointerRNA *ptr, char *value)
104 {
105         const bScreen *screen = ptr->data;
106         const WorkSpaceLayout *layout = BKE_workspace_layout_find_global(G_MAIN, screen, NULL);
107
108         if (layout) {
109                 const char *name = BKE_workspace_layout_name_get(layout);
110                 strcpy(value, name);
111         }
112         else {
113                 value[0] = '\0';
114         }
115 }
116
117 static int rna_Screen_layout_name_length(PointerRNA *ptr)
118 {
119         const bScreen *screen = ptr->data;
120         const WorkSpaceLayout *layout = BKE_workspace_layout_find_global(G_MAIN, screen, NULL);
121
122         if (layout) {
123                 const char *name = BKE_workspace_layout_name_get(layout);
124                 return strlen(name);
125         }
126
127         return 0;
128 }
129
130 static void rna_Screen_layout_name_set(PointerRNA *ptr, const char *value)
131 {
132         bScreen *screen = ptr->data;
133         WorkSpace *workspace;
134         WorkSpaceLayout *layout = BKE_workspace_layout_find_global(G_MAIN, screen, &workspace);
135
136         if (layout) {
137                 BKE_workspace_layout_name_set(workspace, layout, value);
138         }
139 }
140
141 static bool rna_Screen_fullscreen_get(PointerRNA *ptr)
142 {
143         bScreen *sc = (bScreen *)ptr->data;
144         return (sc->state == SCREENMAXIMIZED);
145 }
146
147 /* UI compatible list: should not be needed, but for now we need to keep EMPTY
148  * at least in the static version of this enum for python scripts. */
149 static const EnumPropertyItem *rna_Area_type_itemf(
150         bContext *UNUSED(C), PointerRNA *UNUSED(ptr),
151         PropertyRNA *UNUSED(prop), bool *r_free)
152 {
153         EnumPropertyItem *item = NULL;
154         int totitem = 0;
155
156         /* +1 to skip SPACE_EMPTY */
157         for (const EnumPropertyItem *item_from = rna_enum_space_type_items + 1; item_from->identifier; item_from++) {
158                 if (ELEM(item_from->value, SPACE_TOPBAR, SPACE_STATUSBAR)) {
159                         continue;
160                 }
161                 RNA_enum_item_add(&item, &totitem, item_from);
162         }
163         RNA_enum_item_end(&item, &totitem);
164         *r_free = true;
165
166         return item;
167 }
168
169 static int rna_Area_type_get(PointerRNA *ptr)
170 {
171         ScrArea *sa = (ScrArea *)ptr->data;
172         /* Usually 'spacetype' is used. It lags behind a bit while switching area
173          * type though, then we use 'butspacetype' instead (T41435). */
174         return (sa->butspacetype == SPACE_EMPTY) ? sa->spacetype : sa->butspacetype;
175 }
176
177 static void rna_Area_type_set(PointerRNA *ptr, int value)
178 {
179         if (ELEM(value, SPACE_TOPBAR, SPACE_STATUSBAR)) {
180                 /* Special case: An area can not be set to show the top-bar editor (or
181                  * other global areas). However it should still be possible to identify
182                  * its type from Python. */
183                 return;
184         }
185
186         ScrArea *sa = (ScrArea *)ptr->data;
187         sa->butspacetype = value;
188 }
189
190 static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
191 {
192         wmWindowManager *wm = CTX_wm_manager(C);
193         wmWindow *win;
194         bScreen *sc = (bScreen *)ptr->id.data;
195         ScrArea *sa = (ScrArea *)ptr->data;
196
197         /* XXX this call still use context, so we trick it to work in the right context */
198         for (win = wm->windows.first; win; win = win->next) {
199                 if (sc == WM_window_get_active_screen(win)) {
200                         wmWindow *prevwin = CTX_wm_window(C);
201                         ScrArea *prevsa = CTX_wm_area(C);
202                         ARegion *prevar = CTX_wm_region(C);
203
204                         CTX_wm_window_set(C, win);
205                         CTX_wm_area_set(C, sa);
206                         CTX_wm_region_set(C, NULL);
207
208                         ED_area_newspace(C, sa, sa->butspacetype, true);
209                         ED_area_tag_redraw(sa);
210
211                         /* Unset so that rna_Area_type_get uses spacetype instead. */
212                         sa->butspacetype = SPACE_EMPTY;
213
214                         /* It is possible that new layers becomes visible. */
215                         if (sa->spacetype == SPACE_VIEW3D) {
216                                 DEG_on_visible_update(CTX_data_main(C), false);
217                         }
218
219                         CTX_wm_window_set(C, prevwin);
220                         CTX_wm_area_set(C, prevsa);
221                         CTX_wm_region_set(C, prevar);
222                         break;
223                 }
224         }
225 }
226
227
228 static const EnumPropertyItem *rna_Area_ui_type_itemf(
229         bContext *C, PointerRNA *UNUSED(ptr),
230         PropertyRNA *UNUSED(prop), bool *r_free)
231 {
232         EnumPropertyItem *item = NULL;
233         int totitem = 0;
234
235         /* +1 to skip SPACE_EMPTY */
236         for (const EnumPropertyItem *item_from = rna_enum_space_type_items + 1; item_from->identifier; item_from++) {
237                 if (ELEM(item_from->value, SPACE_TOPBAR, SPACE_STATUSBAR)) {
238                         continue;
239                 }
240
241                 SpaceType *st = item_from->identifier[0] ? BKE_spacetype_from_id(item_from->value) : NULL;
242                 int totitem_prev = totitem;
243                 if (st && st->space_subtype_item_extend != NULL) {
244                         st->space_subtype_item_extend(C, &item, &totitem);
245                         while (totitem_prev < totitem) {
246                                 item[totitem_prev++].value |= item_from->value << 16;
247                         }
248                 }
249                 else {
250                         RNA_enum_item_add(&item, &totitem, item_from);
251                         item[totitem_prev++].value = item_from->value << 16;
252                 }
253         }
254         RNA_enum_item_end(&item, &totitem);
255         *r_free = true;
256
257         return item;
258 }
259
260 static int rna_Area_ui_type_get(PointerRNA *ptr)
261 {
262         int value = rna_Area_type_get(ptr) << 16;
263         ScrArea *sa = ptr->data;
264         if (sa->type->space_subtype_item_extend != NULL) {
265                 value |= sa->type->space_subtype_get(sa);
266         }
267         return value;
268 }
269
270 static void rna_Area_ui_type_set(PointerRNA *ptr, int value)
271 {
272         ScrArea *sa = ptr->data;
273         const int space_type = value >> 16;
274         SpaceType *st = BKE_spacetype_from_id(space_type);
275
276         rna_Area_type_set(ptr, space_type);
277
278         if (st && st->space_subtype_item_extend != NULL) {
279                 sa->butspacetype_subtype = value & 0xffff;
280         }
281 }
282
283 static void rna_Area_ui_type_update(bContext *C, PointerRNA *ptr)
284 {
285         ScrArea *sa = ptr->data;
286         SpaceType *st = BKE_spacetype_from_id(sa->butspacetype);
287
288         rna_Area_type_update(C, ptr);
289
290         if ((sa->type == st) && (st->space_subtype_item_extend != NULL)) {
291                 st->space_subtype_set(sa, sa->butspacetype_subtype);
292         }
293         sa->butspacetype_subtype = 0;
294 }
295
296 static void rna_View2D_region_to_view(struct View2D *v2d, int x, int y, float result[2])
297 {
298         UI_view2d_region_to_view(v2d, x, y, &result[0], &result[1]);
299 }
300
301 static void rna_View2D_view_to_region(struct View2D *v2d, float x, float y, bool clip, int result[2])
302 {
303         if (clip)
304                 UI_view2d_view_to_region_clip(v2d, x, y, &result[0], &result[1]);
305         else
306                 UI_view2d_view_to_region(v2d, x, y, &result[0], &result[1]);
307 }
308
309 #else
310
311 /* Area.spaces */
312 static void rna_def_area_spaces(BlenderRNA *brna, PropertyRNA *cprop)
313 {
314         StructRNA *srna;
315         PropertyRNA *prop;
316
317         RNA_def_property_srna(cprop, "AreaSpaces");
318         srna = RNA_def_struct(brna, "AreaSpaces", NULL);
319         RNA_def_struct_sdna(srna, "ScrArea");
320         RNA_def_struct_ui_text(srna, "Area Spaces", "Collection of spaces");
321
322         prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
323         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
324         RNA_def_property_struct_type(prop, "Space");
325         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area");
326 }
327
328 static void rna_def_area_api(StructRNA *srna)
329 {
330         FunctionRNA *func;
331         PropertyRNA *parm;
332
333         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
334
335         func = RNA_def_function(srna, "header_text_set", "ED_area_status_text");
336         RNA_def_function_ui_description(func, "Set the header status text");
337         parm = RNA_def_string(func, "text", NULL, 0, "Text", "New string for the header, None clears the text");
338         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
339         RNA_def_property_clear_flag(parm, PROP_NEVER_NULL);
340 }
341
342 static void rna_def_area(BlenderRNA *brna)
343 {
344         StructRNA *srna;
345         PropertyRNA *prop;
346
347         srna = RNA_def_struct(brna, "Area", NULL);
348         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor");
349         RNA_def_struct_sdna(srna, "ScrArea");
350
351         prop = RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
352         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
353         RNA_def_property_struct_type(prop, "Space");
354         RNA_def_property_ui_text(prop, "Spaces",
355                                  "Spaces contained in this area, the first being the active space "
356                                  "(NOTE: Useful for example to restore a previously used 3D view space "
357                                  "in a certain area to get the old view orientation)");
358         rna_def_area_spaces(brna, prop);
359
360         prop = RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
361         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
362         RNA_def_property_struct_type(prop, "Region");
363         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in");
364
365         prop = RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
366         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
367         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header");
368
369         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
370         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
371         RNA_def_property_enum_items(prop, rna_enum_space_type_items);
372         RNA_def_property_enum_default(prop, SPACE_VIEW3D);
373         RNA_def_property_enum_funcs(prop, "rna_Area_type_get", "rna_Area_type_set", "rna_Area_type_itemf");
374         RNA_def_property_ui_text(prop, "Editor Type", "Current editor type for this area");
375         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
376         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
377         RNA_def_property_update(prop, 0, "rna_Area_type_update");
378
379         prop = RNA_def_property(srna, "ui_type", PROP_ENUM, PROP_NONE);
380         RNA_def_property_enum_items(prop, DummyRNA_DEFAULT_items);  /* infact dummy */
381         RNA_def_property_enum_default(prop, 0);
382         RNA_def_property_enum_funcs(prop, "rna_Area_ui_type_get", "rna_Area_ui_type_set", "rna_Area_ui_type_itemf");
383         RNA_def_property_ui_text(prop, "Editor Type", "Current editor type for this area");
384         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
385         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
386         RNA_def_property_update(prop, 0, "rna_Area_ui_type_update");
387
388         prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
389         RNA_def_property_int_sdna(prop, NULL, "totrct.xmin");
390         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
391         RNA_def_property_ui_text(prop, "X Position", "The window relative vertical location of the area");
392
393         prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
394         RNA_def_property_int_sdna(prop, NULL, "totrct.ymin");
395         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
396         RNA_def_property_ui_text(prop, "Y Position", "The window relative horizontal location of the area");
397
398         prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
399         RNA_def_property_int_sdna(prop, NULL, "winx");
400         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
401         RNA_def_property_ui_text(prop, "Width", "Area width");
402
403         prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
404         RNA_def_property_int_sdna(prop, NULL, "winy");
405         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
406         RNA_def_property_ui_text(prop, "Height", "Area height");
407
408         rna_def_area_api(srna);
409 }
410
411 static void rna_def_view2d_api(StructRNA *srna)
412 {
413         FunctionRNA *func;
414         PropertyRNA *parm;
415
416         static const float view_default[2] = {0.0f, 0.0f};
417         static const int region_default[2] = {0.0f, 0.0f};
418
419         func = RNA_def_function(srna, "region_to_view", "rna_View2D_region_to_view");
420         RNA_def_function_ui_description(func, "Transform region coordinates to 2D view");
421         parm = RNA_def_int(func, "x", 0, INT_MIN, INT_MAX, "x", "Region x coordinate", -10000, 10000);
422         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
423         parm = RNA_def_int(func, "y", 0, INT_MIN, INT_MAX, "y", "Region y coordinate", -10000, 10000);
424         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
425         parm = RNA_def_float_array(func, "result", 2, view_default, -FLT_MAX, FLT_MAX, "Result", "View coordinates", -10000.0f, 10000.0f);
426         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
427         RNA_def_function_output(func, parm);
428
429         func = RNA_def_function(srna, "view_to_region", "rna_View2D_view_to_region");
430         RNA_def_function_ui_description(func, "Transform 2D view coordinates to region");
431         parm = RNA_def_float(func, "x", 0.0f, -FLT_MAX, FLT_MAX, "x", "2D View x coordinate", -10000.0f, 10000.0f);
432         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
433         parm = RNA_def_float(func, "y", 0.0f, -FLT_MAX, FLT_MAX, "y", "2D View y coordinate", -10000.0f, 10000.0f);
434         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
435         RNA_def_boolean(func, "clip", 1, "Clip", "Clip coordinates to the visible region");
436         parm = RNA_def_int_array(func, "result", 2, region_default, INT_MIN, INT_MAX, "Result", "Region coordinates", -10000, 10000);
437         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
438         RNA_def_function_output(func, parm);
439 }
440
441 static void rna_def_view2d(BlenderRNA *brna)
442 {
443         StructRNA *srna;
444         /* PropertyRNA *prop; */
445
446         srna = RNA_def_struct(brna, "View2D", NULL);
447         RNA_def_struct_ui_text(srna, "View2D", "Scroll and zoom for a 2D region");
448         RNA_def_struct_sdna(srna, "View2D");
449
450         /* TODO more View2D properties could be exposed here (read-only) */
451
452         rna_def_view2d_api(srna);
453 }
454
455 static void rna_def_region(BlenderRNA *brna)
456 {
457         StructRNA *srna;
458         PropertyRNA *prop;
459
460         static const EnumPropertyItem alignment_types[] = {
461                 {RGN_ALIGN_NONE, "NONE", 0, "None", "Don't use any fixed alignment, fill available space"},
462                 {RGN_ALIGN_TOP, "TOP", 0, "Top", ""},
463                 {RGN_ALIGN_BOTTOM, "BOTTOM", 0, "Bottom", ""},
464                 {RGN_ALIGN_LEFT, "LEFT", 0, "Left", ""},
465                 {RGN_ALIGN_RIGHT, "RIGHT", 0, "Right", ""},
466                 {RGN_ALIGN_HSPLIT, "HORIZONTAL_SPLIT", 0, "Horizontal Split", ""},
467                 {RGN_ALIGN_VSPLIT, "VERTICAL_SPLIT", 0, "Vertical Split", ""},
468                 {RGN_ALIGN_FLOAT, "FLOAT", 0, "Float", "Region floats on screen, doesn't use any fixed alignment"},
469                 {RGN_ALIGN_QSPLIT, "QUAD_SPLIT", 0, "Quad Split", "Region is split horizontally and vertically"},
470                 {0, NULL, 0, NULL, NULL}
471         };
472
473         srna = RNA_def_struct(brna, "Region", NULL);
474         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area");
475         RNA_def_struct_sdna(srna, "ARegion");
476
477         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
478         RNA_def_property_enum_sdna(prop, NULL, "regiontype");
479         RNA_def_property_enum_items(prop, rna_enum_region_type_items);
480         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
481         RNA_def_property_ui_text(prop, "Region Type", "Type of this region");
482
483         prop = RNA_def_property(srna, "x", PROP_INT, PROP_NONE);
484         RNA_def_property_int_sdna(prop, NULL, "winrct.xmin");
485         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
486         RNA_def_property_ui_text(prop, "X Position", "The window relative vertical location of the region");
487
488         prop = RNA_def_property(srna, "y", PROP_INT, PROP_NONE);
489         RNA_def_property_int_sdna(prop, NULL, "winrct.ymin");
490         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
491         RNA_def_property_ui_text(prop, "Y Position", "The window relative horizontal location of the region");
492
493         prop = RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
494         RNA_def_property_int_sdna(prop, NULL, "winx");
495         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
496         RNA_def_property_ui_text(prop, "Width", "Region width");
497
498         prop = RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
499         RNA_def_property_int_sdna(prop, NULL, "winy");
500         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
501         RNA_def_property_ui_text(prop, "Height", "Region height");
502
503         prop = RNA_def_property(srna, "view2d", PROP_POINTER, PROP_NONE);
504         RNA_def_property_pointer_sdna(prop, NULL, "v2d");
505         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
506         RNA_def_property_flag(prop, PROP_NEVER_NULL);
507         RNA_def_property_ui_text(prop, "View2D", "2D view of the region");
508
509         prop = RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE);
510         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
511         RNA_def_property_enum_items(prop, alignment_types);
512         RNA_def_property_enum_funcs(prop, "rna_region_alignment_get", NULL, NULL);
513         RNA_def_property_ui_text(prop, "Alignment", "Alignment of the region within the area");
514
515         RNA_def_function(srna, "tag_redraw", "ED_region_tag_redraw");
516 }
517
518 static void rna_def_screen(BlenderRNA *brna)
519 {
520         StructRNA *srna;
521         PropertyRNA *prop;
522
523         srna = RNA_def_struct(brna, "Screen", "ID");
524         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
525         RNA_def_struct_ui_text(srna, "Screen", "Screen data-block, defining the layout of areas in a window");
526         RNA_def_struct_ui_icon(srna, ICON_WORKSPACE);
527
528         prop = RNA_def_property(srna, "layout_name", PROP_STRING, PROP_NONE);
529         RNA_def_property_string_funcs(prop, "rna_Screen_layout_name_get", "rna_Screen_layout_name_length",
530                                       "rna_Screen_layout_name_set");
531         RNA_def_property_ui_text(prop, "Layout Name", "The name of the layout that refers to the screen");
532         RNA_def_struct_name_property(srna, prop);
533
534         /* collections */
535         prop = RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
536         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
537         RNA_def_property_struct_type(prop, "Area");
538         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into");
539
540         /* readonly status indicators */
541         prop = RNA_def_property(srna, "is_animation_playing", PROP_BOOLEAN, PROP_NONE);
542         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
543         RNA_def_property_boolean_funcs(prop, "rna_Screen_is_animation_playing_get", NULL);
544         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active");
545
546         prop = RNA_def_property(srna, "show_fullscreen", PROP_BOOLEAN, PROP_NONE);
547         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
548         RNA_def_property_boolean_funcs(prop, "rna_Screen_fullscreen_get", NULL);
549         RNA_def_property_ui_text(prop, "Maximize", "An area is maximized, filling this screen");
550
551         prop = RNA_def_property(srna, "show_topbar", PROP_BOOLEAN, PROP_NONE);
552         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", SCREEN_COLLAPSE_TOPBAR);
553         RNA_def_property_ui_text(prop, "Show Top Bar", "Show top bar with tool settings");
554         RNA_def_property_update(prop, 0, "rna_Screen_bar_update");
555
556         prop = RNA_def_property(srna, "show_statusbar", PROP_BOOLEAN, PROP_NONE);
557         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", SCREEN_COLLAPSE_STATUSBAR);
558         RNA_def_property_ui_text(prop, "Show Status Bar", "Show status bar");
559         RNA_def_property_update(prop, 0, "rna_Screen_bar_update");
560
561         /* Define Anim Playback Areas */
562         prop = RNA_def_property(srna, "use_play_top_left_3d_editor", PROP_BOOLEAN, PROP_NONE);
563         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_REGION);
564         RNA_def_property_ui_text(prop, "Top-Left 3D Editor", "");
565         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
566
567         prop = RNA_def_property(srna, "use_play_3d_editors", PROP_BOOLEAN, PROP_NONE);
568         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_3D_WIN);
569         RNA_def_property_ui_text(prop, "All 3D View Editors", "");
570         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
571
572         prop = RNA_def_property(srna, "use_follow", PROP_BOOLEAN, PROP_NONE);
573         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_FOLLOW);
574         RNA_def_property_ui_text(prop, "Follow", "Follow current frame in editors");
575         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
576
577         prop = RNA_def_property(srna, "use_play_animation_editors", PROP_BOOLEAN, PROP_NONE);
578         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_ANIM_WIN);
579         RNA_def_property_ui_text(prop, "Animation Editors", "");
580         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
581
582         prop = RNA_def_property(srna, "use_play_properties_editors", PROP_BOOLEAN, PROP_NONE);
583         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_BUTS_WIN);
584         RNA_def_property_ui_text(prop, "Property Editors", "");
585         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
586
587         prop = RNA_def_property(srna, "use_play_image_editors", PROP_BOOLEAN, PROP_NONE);
588         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_IMAGE_WIN);
589         RNA_def_property_ui_text(prop, "Image Editors", "");
590         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
591
592         prop = RNA_def_property(srna, "use_play_sequence_editors", PROP_BOOLEAN, PROP_NONE);
593         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_SEQ);
594         RNA_def_property_ui_text(prop, "Sequencer Editors", "");
595         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
596
597         prop = RNA_def_property(srna, "use_play_node_editors", PROP_BOOLEAN, PROP_NONE);
598         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_NODES);
599         RNA_def_property_ui_text(prop, "Node Editors", "");
600         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
601
602         prop = RNA_def_property(srna, "use_play_clip_editors", PROP_BOOLEAN, PROP_NONE);
603         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_CLIPS);
604         RNA_def_property_ui_text(prop, "Clip Editors", "");
605         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_TIME, "rna_Screen_redraw_update");
606 }
607
608 void RNA_def_screen(BlenderRNA *brna)
609 {
610         rna_def_screen(brna);
611         rna_def_area(brna);
612         rna_def_region(brna);
613         rna_def_view2d(brna);
614 }
615
616 #endif