added back space switching keys Shift+F2 to F12
[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         {0, NULL, 0, NULL, NULL}};
44
45 #ifdef RNA_RUNTIME
46
47 #include "ED_screen.h"
48
49
50 #include "WM_api.h"
51 #include "WM_types.h"
52
53 static void rna_Screen_scene_set(PointerRNA *ptr, PointerRNA value)
54 {
55         bScreen *sc= (bScreen*)ptr->data;
56
57         if(value.data == NULL)
58                 return;
59
60         /* exception: can't set screens inside of area/region handers */
61         sc->newscene= value.data;
62 }
63
64 static void rna_Screen_scene_update(bContext *C, PointerRNA *ptr)
65 {
66         bScreen *sc= (bScreen*)ptr->data;
67
68         /* exception: can't set screens inside of area/region handers */
69         if(sc->newscene) {
70                 WM_event_add_notifier(C, NC_SCENE|ND_SCENEBROWSE, sc->newscene);
71                 sc->newscene= NULL;
72         }
73 }
74
75 static int rna_Screen_animation_playing_get(PointerRNA *ptr)
76 {
77         bScreen *sc= (bScreen*)ptr->data;
78         return (sc->animtimer != NULL);
79 }
80
81 static void rna_Area_type_set(PointerRNA *ptr, int value)
82 {
83         ScrArea *sa= (ScrArea*)ptr->data;
84         sa->butspacetype= value;
85 }
86
87 static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
88 {
89         ScrArea *sa= (ScrArea*)ptr->data;
90
91         if(sa) {
92                 ED_area_newspace(C, sa, sa->butspacetype); /* XXX - this uses the window */
93                 ED_area_tag_redraw(sa);
94         }
95 }
96
97 #else
98
99 static void rna_def_area(BlenderRNA *brna)
100 {
101         StructRNA *srna;
102         PropertyRNA *prop;
103         
104         srna= RNA_def_struct(brna, "Area", NULL);
105         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor.");
106         RNA_def_struct_sdna(srna, "ScrArea");
107
108         prop= RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
109         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
110         RNA_def_property_struct_type(prop, "Space");
111         RNA_def_property_ui_text(prop, "Spaces", "Spaces contained in this area, the first space is active.");
112
113         prop= RNA_def_property(srna, "active_space", PROP_POINTER, PROP_NONE);
114         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
115         RNA_def_property_struct_type(prop, "Space");
116         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area.");
117
118         prop= RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
119         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
120         RNA_def_property_struct_type(prop, "Region");
121         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in.");
122
123         prop= RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
124         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
125         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header.");
126         
127         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
128         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
129         RNA_def_property_enum_items(prop, space_type_items);
130         RNA_def_property_enum_funcs(prop, NULL, "rna_Area_type_set", NULL);
131         RNA_def_property_ui_text(prop, "Type", "Space type.");
132         RNA_def_property_update(prop, 0, "rna_Area_type_update");
133
134
135         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
136 }
137
138 static void rna_def_region(BlenderRNA *brna)
139 {
140         StructRNA *srna;
141         PropertyRNA *prop;
142         
143         srna= RNA_def_struct(brna, "Region", NULL);
144         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area.");
145         RNA_def_struct_sdna(srna, "ARegion");
146         
147         prop= RNA_def_property(srna, "id", PROP_INT, PROP_NONE);
148         RNA_def_property_int_sdna(prop, NULL, "swinid");
149         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
150         RNA_def_property_ui_text(prop, "Region ID", "Uniqute ID for this region.");
151 }
152
153 static void rna_def_screen(BlenderRNA *brna)
154 {
155         StructRNA *srna;
156         PropertyRNA *prop;
157         
158         srna= RNA_def_struct(brna, "Screen", "ID");
159         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
160         RNA_def_struct_ui_text(srna, "Screen", "Screen datablock, defining the layout of areas in a window.");
161         RNA_def_struct_ui_icon(srna, ICON_SPLITSCREEN);
162         
163         prop= RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
164         RNA_def_property_flag(prop, PROP_EDITABLE|PROP_NEVER_NULL);
165         RNA_def_property_pointer_funcs(prop, NULL, "rna_Screen_scene_set", NULL);
166         RNA_def_property_ui_text(prop, "Scene", "Active scene to be edited in the screen.");
167         RNA_def_property_update(prop, 0, "rna_Screen_scene_update");
168         
169         prop= RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
170         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
171         RNA_def_property_struct_type(prop, "Area");
172         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into.");
173
174         prop= RNA_def_property(srna, "animation_playing", PROP_BOOLEAN, PROP_NONE);
175         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
176         RNA_def_property_boolean_funcs(prop, "rna_Screen_animation_playing_get", NULL);
177         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active.");
178 }
179
180 void RNA_def_screen(BlenderRNA *brna)
181 {
182         rna_def_screen(brna);
183         rna_def_area(brna);
184         rna_def_region(brna);
185 }
186
187 #endif
188