fix: adding missing new area type RGN_TYPE_PREVIEW to rna enum.
[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 #include "RNA_enum_types.h"
30
31 #include "rna_internal.h"
32
33 #include "DNA_screen_types.h"
34 #include "DNA_scene_types.h"
35
36 EnumPropertyItem region_type_items[] = {
37         {RGN_TYPE_WINDOW, "WINDOW", 0, "Window", ""},
38         {RGN_TYPE_HEADER, "HEADER", 0, "Header", ""},
39         {RGN_TYPE_CHANNELS, "CHANNELS", 0, "Channels", ""},
40         {RGN_TYPE_TOOLS, "TOOLS", 0, "Tools", ""},
41         {RGN_TYPE_TEMPORARY, "TEMPORARY", 0, "Temporary", ""},
42         {RGN_TYPE_UI, "UI", 0, "UI", ""},
43         {RGN_TYPE_PREVIEW, "PREVIEW", 0, "Preview", ""},
44         {0, NULL, 0, NULL, NULL}};
45
46 #ifdef RNA_RUNTIME
47
48 #include "ED_screen.h"
49
50
51 #include "WM_api.h"
52 #include "WM_types.h"
53
54 static void rna_Screen_scene_set(PointerRNA *ptr, PointerRNA value)
55 {
56         bScreen *sc= (bScreen*)ptr->data;
57
58         if(value.data == NULL)
59                 return;
60
61         /* exception: can't set screens inside of area/region handers */
62         sc->newscene= value.data;
63 }
64
65 static void rna_Screen_scene_update(bContext *C, PointerRNA *ptr)
66 {
67         bScreen *sc= (bScreen*)ptr->data;
68
69         /* exception: can't set screens inside of area/region handers */
70         if(sc->newscene) {
71                 WM_event_add_notifier(C, NC_SCENE|ND_SCENEBROWSE, sc->newscene);
72                 sc->newscene= NULL;
73         }
74 }
75
76 static int rna_Screen_animation_playing_get(PointerRNA *ptr)
77 {
78         bScreen *sc= (bScreen*)ptr->data;
79         return (sc->animtimer != NULL);
80 }
81
82 static int rna_Screen_fullscreen_get(PointerRNA *ptr)
83 {
84         bScreen *sc= (bScreen*)ptr->data;
85         return (sc->full == SCREENFULL);
86 }
87
88 static void rna_Area_type_set(PointerRNA *ptr, int value)
89 {
90         ScrArea *sa= (ScrArea*)ptr->data;
91         sa->butspacetype= value;
92 }
93
94 static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
95 {
96         ScrArea *sa= (ScrArea*)ptr->data;
97
98         ED_area_newspace(C, sa, sa->butspacetype); /* XXX - this uses the window */
99         ED_area_tag_redraw(sa);
100 }
101
102 #else
103
104 static void rna_def_area(BlenderRNA *brna)
105 {
106         StructRNA *srna;
107         PropertyRNA *prop;
108         
109         srna= RNA_def_struct(brna, "Area", NULL);
110         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor.");
111         RNA_def_struct_sdna(srna, "ScrArea");
112
113         prop= RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
114         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
115         RNA_def_property_struct_type(prop, "Space");
116         RNA_def_property_ui_text(prop, "Spaces", "Spaces contained in this area, the first space is active.");
117
118         prop= RNA_def_property(srna, "active_space", PROP_POINTER, PROP_NONE);
119         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
120         RNA_def_property_struct_type(prop, "Space");
121         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area.");
122
123         prop= RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
124         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
125         RNA_def_property_struct_type(prop, "Region");
126         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in.");
127
128         prop= RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
129         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
130         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header.");
131         
132         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
133         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
134         RNA_def_property_enum_items(prop, space_type_items);
135         RNA_def_property_enum_funcs(prop, NULL, "rna_Area_type_set", NULL);
136         RNA_def_property_ui_text(prop, "Type", "Space type.");
137         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
138         RNA_def_property_update(prop, 0, "rna_Area_type_update");
139
140         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
141 }
142
143 static void rna_def_region(BlenderRNA *brna)
144 {
145         StructRNA *srna;
146         PropertyRNA *prop;
147         
148         srna= RNA_def_struct(brna, "Region", NULL);
149         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area.");
150         RNA_def_struct_sdna(srna, "ARegion");
151         
152         prop= RNA_def_property(srna, "id", PROP_INT, PROP_NONE);
153         RNA_def_property_int_sdna(prop, NULL, "swinid");
154         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
155         RNA_def_property_ui_text(prop, "Region ID", "Uniqute ID for this region.");
156
157         prop= RNA_def_property(srna, "width", PROP_INT, PROP_NONE);
158         RNA_def_property_int_sdna(prop, NULL, "winx");
159         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
160         RNA_def_property_ui_text(prop, "Width", "Region width.");
161
162         prop= RNA_def_property(srna, "height", PROP_INT, PROP_NONE);
163         RNA_def_property_int_sdna(prop, NULL, "winy");
164         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
165         RNA_def_property_ui_text(prop, "Height", "Region height.");
166 }
167
168 static void rna_def_screen(BlenderRNA *brna)
169 {
170         StructRNA *srna;
171         PropertyRNA *prop;
172         
173         srna= RNA_def_struct(brna, "Screen", "ID");
174         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
175         RNA_def_struct_ui_text(srna, "Screen", "Screen datablock, defining the layout of areas in a window.");
176         RNA_def_struct_ui_icon(srna, ICON_SPLITSCREEN);
177         
178         prop= RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
179         RNA_def_property_flag(prop, PROP_EDITABLE|PROP_NEVER_NULL);
180         RNA_def_property_pointer_funcs(prop, NULL, "rna_Screen_scene_set", NULL);
181         RNA_def_property_ui_text(prop, "Scene", "Active scene to be edited in the screen.");
182         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
183         RNA_def_property_update(prop, 0, "rna_Screen_scene_update");
184         
185         prop= RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
186         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
187         RNA_def_property_struct_type(prop, "Area");
188         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into.");
189
190         prop= RNA_def_property(srna, "animation_playing", PROP_BOOLEAN, PROP_NONE);
191         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
192         RNA_def_property_boolean_funcs(prop, "rna_Screen_animation_playing_get", NULL);
193         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active.");
194         
195         prop= RNA_def_property(srna, "fullscreen", PROP_BOOLEAN, PROP_NONE);
196         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
197         RNA_def_property_boolean_funcs(prop, "rna_Screen_fullscreen_get", NULL);
198         RNA_def_property_ui_text(prop, "Fullscreen", "An area is maximised, filling this screen.");
199 }
200
201 void RNA_def_screen(BlenderRNA *brna)
202 {
203         rna_def_screen(brna);
204         rna_def_area(brna);
205         rna_def_region(brna);
206 }
207
208 #endif
209