2a72845dd42cbf5a5a838c7eed577f6f9e0b52a9
[blender.git] / source / blender / makesrna / intern / rna_screen.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 (2008), Nathan Letwory
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_screen_types.h"
33 #include "DNA_scene_types.h"
34
35 EnumPropertyItem region_type_items[] = {
36         {RGN_TYPE_WINDOW, "WINDOW", 0, "Window", ""},
37         {RGN_TYPE_HEADER, "HEADER", 0, "Header", ""},
38         {RGN_TYPE_CHANNELS, "CHANNELS", 0, "Channels", ""},
39         {RGN_TYPE_TOOLS, "TOOLS", 0, "Tools", ""},
40         {RGN_TYPE_TEMPORARY, "TEMPORARY", 0, "Temporary", ""},
41         {RGN_TYPE_UI, "UI", 0, "UI", ""},
42         {0, NULL, 0, NULL, NULL}};
43
44 #ifdef RNA_RUNTIME
45
46 #include "ED_screen.h"
47
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 static void rna_Screen_scene_set(PointerRNA *ptr, PointerRNA value)
53 {
54         bScreen *sc= (bScreen*)ptr->data;
55
56         if(value.data == NULL)
57                 return;
58
59         /* exception: can't set screens inside of area/region handers */
60         sc->newscene= value.data;
61 }
62
63 static void rna_Screen_scene_update(bContext *C, PointerRNA *ptr)
64 {
65         bScreen *sc= (bScreen*)ptr->data;
66
67         /* exception: can't set screens inside of area/region handers */
68         if(sc->newscene) {
69                 WM_event_add_notifier(C, NC_SCENE|ND_SCENEBROWSE, sc->newscene);
70                 sc->newscene= NULL;
71         }
72 }
73
74 static int rna_Screen_animation_playing_get(PointerRNA *ptr)
75 {
76         bScreen *sc= (bScreen*)ptr->data;
77         return (sc->animtimer != NULL);
78 }
79
80 #else
81
82 static void rna_def_area(BlenderRNA *brna)
83 {
84         StructRNA *srna;
85         PropertyRNA *prop;
86         
87         srna= RNA_def_struct(brna, "Area", NULL);
88         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor.");
89         RNA_def_struct_sdna(srna, "ScrArea");
90
91         prop= RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
92         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
93         RNA_def_property_struct_type(prop, "Space");
94         RNA_def_property_ui_text(prop, "Spaces", "Spaces contained in this area, the first space is active.");
95
96         prop= RNA_def_property(srna, "active_space", PROP_POINTER, PROP_NONE);
97         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
98         RNA_def_property_struct_type(prop, "Space");
99         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area.");
100
101         prop= RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
102         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
103         RNA_def_property_struct_type(prop, "Region");
104         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in.");
105
106         prop= RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
107         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
108         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header.");
109         
110         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
111 }
112
113 static void rna_def_region(BlenderRNA *brna)
114 {
115         StructRNA *srna;
116         PropertyRNA *prop;
117         
118         srna= RNA_def_struct(brna, "Region", NULL);
119         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area.");
120         RNA_def_struct_sdna(srna, "ARegion");
121         
122         prop= RNA_def_property(srna, "id", PROP_INT, PROP_NONE);
123         RNA_def_property_int_sdna(prop, NULL, "swinid");
124         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
125         RNA_def_property_ui_text(prop, "Region ID", "Uniqute ID for this region.");
126 }
127
128 static void rna_def_screen(BlenderRNA *brna)
129 {
130         StructRNA *srna;
131         PropertyRNA *prop;
132         
133         srna= RNA_def_struct(brna, "Screen", "ID");
134         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
135         RNA_def_struct_ui_text(srna, "Screen", "Screen datablock, defining the layout of areas in a window.");
136         RNA_def_struct_ui_icon(srna, ICON_SPLITSCREEN);
137         
138         prop= RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
139         RNA_def_property_flag(prop, PROP_EDITABLE|PROP_NEVER_NULL);
140         RNA_def_property_pointer_funcs(prop, NULL, "rna_Screen_scene_set", NULL);
141         RNA_def_property_ui_text(prop, "Scene", "Active scene to be edited in the screen.");
142         RNA_def_property_update(prop, 0, "rna_Screen_scene_update");
143         
144         prop= RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
145         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
146         RNA_def_property_struct_type(prop, "Area");
147         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into.");
148
149         prop= RNA_def_property(srna, "animation_playing", PROP_BOOLEAN, PROP_NONE);
150         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
151         RNA_def_property_boolean_funcs(prop, "rna_Screen_animation_playing_get", NULL);
152         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active.");
153 }
154
155 void RNA_def_screen(BlenderRNA *brna)
156 {
157         rna_def_screen(brna);
158         rna_def_area(brna);
159         rna_def_region(brna);
160 }
161
162 #endif
163