doxygen: prevent GPL license block from being parsed as doxygen comment.
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008), Nathan Letwory
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26 #include <stddef.h>
27
28 #include "RNA_define.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_TEMPORARY, "TEMPORARY", 0, "Temporary", ""},
41         {RGN_TYPE_UI, "UI", 0, "UI", ""},
42         {RGN_TYPE_TOOLS, "TOOLS", 0, "Tools", ""},
43         {RGN_TYPE_TOOL_PROPS, "TOOL_PROPS", 0, "Tool Properties", ""},
44         {RGN_TYPE_PREVIEW, "PREVIEW", 0, "Preview", ""},
45         {0, NULL, 0, NULL, NULL}};
46
47 #include "ED_screen.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 #ifdef RNA_RUNTIME
53
54
55 static void rna_Screen_scene_set(PointerRNA *ptr, PointerRNA value)
56 {
57         bScreen *sc= (bScreen*)ptr->data;
58
59         if(value.data == NULL)
60                 return;
61
62         /* exception: can't set screens inside of area/region handers */
63         sc->newscene= value.data;
64 }
65
66 static void rna_Screen_scene_update(bContext *C, PointerRNA *ptr)
67 {
68         bScreen *sc= (bScreen*)ptr->data;
69
70         /* exception: can't set screens inside of area/region handers */
71         if(sc->newscene) {
72                 WM_event_add_notifier(C, NC_SCENE|ND_SCENEBROWSE, sc->newscene);
73                 sc->newscene= NULL;
74         }
75 }
76
77 static void rna_Screen_redraw_update(Main *bmain, Scene *scene, PointerRNA *ptr)
78 {
79         bScreen *screen= (bScreen*)ptr->data;
80         
81         /* the settings for this are currently only available from a menu in the TimeLine, hence refresh=SPACE_TIME */
82         ED_screen_animation_timer_update(screen, screen->redraws_flag, SPACE_TIME);
83 }
84
85
86 static int rna_Screen_is_animation_playing_get(PointerRNA *ptr)
87 {
88         bScreen *sc= (bScreen*)ptr->data;
89         return (sc->animtimer != NULL);
90 }
91
92 static int rna_Screen_fullscreen_get(PointerRNA *ptr)
93 {
94         bScreen *sc= (bScreen*)ptr->data;
95         return (sc->full != 0);
96 }
97
98 static void rna_Area_type_set(PointerRNA *ptr, int value)
99 {
100         ScrArea *sa= (ScrArea*)ptr->data;
101         sa->butspacetype= value;
102 }
103
104 static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
105 {
106         ScrArea *sa= (ScrArea*)ptr->data;
107
108         ED_area_newspace(C, sa, sa->butspacetype); /* XXX - this uses the window */
109         ED_area_tag_redraw(sa);
110 }
111
112 #else
113
114 static void rna_def_area(BlenderRNA *brna)
115 {
116         StructRNA *srna;
117         PropertyRNA *prop;
118         FunctionRNA *func;
119         
120         srna= RNA_def_struct(brna, "Area", NULL);
121         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor");
122         RNA_def_struct_sdna(srna, "ScrArea");
123
124         prop= RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
125         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
126         RNA_def_property_struct_type(prop, "Space");
127         RNA_def_property_ui_text(prop, "Spaces", "Spaces contained in this area, the first being the active space. NOTE: Useful for example to restore a previously used 3d view space in a certain area to get the old view orientation.");
128
129         prop= RNA_def_property(srna, "active_space", PROP_POINTER, PROP_NONE);
130         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
131         RNA_def_property_struct_type(prop, "Space");
132         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area");
133
134         prop= RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
135         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
136         RNA_def_property_struct_type(prop, "Region");
137         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in");
138
139         prop= RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
140         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
141         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header");
142         
143         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
144         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
145         RNA_def_property_enum_items(prop, space_type_items);
146         RNA_def_property_enum_funcs(prop, NULL, "rna_Area_type_set", NULL);
147         RNA_def_property_ui_text(prop, "Type", "Space type");
148         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
149         RNA_def_property_update(prop, 0, "rna_Area_type_update");
150
151         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
152
153         func= RNA_def_function(srna, "header_text_set", "ED_area_headerprint");
154         RNA_def_function_ui_description(func, "Set the header text");
155         RNA_def_string(func, "text", NULL, 0, "Text", "New string for the header, no argument clears the text.");
156 }
157
158 static void rna_def_region(BlenderRNA *brna)
159 {
160         StructRNA *srna;
161         PropertyRNA *prop;
162         
163         srna= RNA_def_struct(brna, "Region", NULL);
164         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area");
165         RNA_def_struct_sdna(srna, "ARegion");
166         
167         prop= RNA_def_property(srna, "id", PROP_INT, PROP_NONE);
168         RNA_def_property_int_sdna(prop, NULL, "swinid");
169         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
170         RNA_def_property_ui_text(prop, "Region ID", "Unique ID for this region");
171
172         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
173         RNA_def_property_enum_sdna(prop, NULL, "regiontype");
174         RNA_def_property_enum_items(prop, region_type_items);
175         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
176         RNA_def_property_ui_text(prop, "Region Type", "Type of this region");
177
178         prop= RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
179         RNA_def_property_int_sdna(prop, NULL, "winx");
180         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
181         RNA_def_property_ui_text(prop, "Width", "Region width");
182
183         prop= RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
184         RNA_def_property_int_sdna(prop, NULL, "winy");
185         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
186         RNA_def_property_ui_text(prop, "Height", "Region height");
187         
188         RNA_def_function(srna, "tag_redraw", "ED_region_tag_redraw");
189 }
190
191 static void rna_def_screen(BlenderRNA *brna)
192 {
193         StructRNA *srna;
194         PropertyRNA *prop;
195         
196         srna= RNA_def_struct(brna, "Screen", "ID");
197         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
198         RNA_def_struct_ui_text(srna, "Screen", "Screen datablock, defining the layout of areas in a window");
199         RNA_def_struct_ui_icon(srna, ICON_SPLITSCREEN);
200         
201         /* pointers */
202         prop= RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
203         RNA_def_property_flag(prop, PROP_EDITABLE|PROP_NEVER_NULL);
204         RNA_def_property_pointer_funcs(prop, NULL, "rna_Screen_scene_set", NULL, NULL);
205         RNA_def_property_ui_text(prop, "Scene", "Active scene to be edited in the screen");
206         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
207         RNA_def_property_update(prop, 0, "rna_Screen_scene_update");
208         
209         /* collections */
210         prop= RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
211         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
212         RNA_def_property_struct_type(prop, "Area");
213         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into");
214         
215         /* readonly status indicators */
216         prop= RNA_def_property(srna, "is_animation_playing", PROP_BOOLEAN, PROP_NONE);
217         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
218         RNA_def_property_boolean_funcs(prop, "rna_Screen_is_animation_playing_get", NULL);
219         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active");
220         
221         prop= RNA_def_property(srna, "show_fullscreen", PROP_BOOLEAN, PROP_NONE);
222         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
223         RNA_def_property_boolean_funcs(prop, "rna_Screen_fullscreen_get", NULL);
224         RNA_def_property_ui_text(prop, "Fullscreen", "An area is maximised, filling this screen");
225         
226         /* Define Anim Playback Areas */
227         prop= RNA_def_property(srna, "use_play_top_left_3d_editor", PROP_BOOLEAN, PROP_NONE);
228         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_REGION);
229         RNA_def_property_ui_text(prop, "Top-Left 3D Editor", "");
230         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_TIME, "rna_Screen_redraw_update");
231         
232         prop= RNA_def_property(srna, "use_play_3d_editors", PROP_BOOLEAN, PROP_NONE);
233         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_3D_WIN);
234         RNA_def_property_ui_text(prop, "All 3D View Editors", "");
235         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_TIME, "rna_Screen_redraw_update");
236         
237         prop= RNA_def_property(srna, "use_play_animation_editors", PROP_BOOLEAN, PROP_NONE);
238         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_ANIM_WIN);
239         RNA_def_property_ui_text(prop, "Animation Editors", "");
240         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_TIME, "rna_Screen_redraw_update");
241         
242         prop= RNA_def_property(srna, "use_play_properties_editors", PROP_BOOLEAN, PROP_NONE);
243         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_BUTS_WIN);
244         RNA_def_property_ui_text(prop, "Property Editors", "");
245         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_TIME, "rna_Screen_redraw_update");
246         
247         prop= RNA_def_property(srna, "use_play_image_editors", PROP_BOOLEAN, PROP_NONE);
248         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_ALL_IMAGE_WIN);
249         RNA_def_property_ui_text(prop, "Image Editors", "");
250         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_TIME, "rna_Screen_redraw_update");
251         
252         prop= RNA_def_property(srna, "use_play_sequence_editors", PROP_BOOLEAN, PROP_NONE);
253         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_SEQ);
254         RNA_def_property_ui_text(prop, "Sequencer Editors", "");
255         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_TIME, "rna_Screen_redraw_update");
256         
257         prop= RNA_def_property(srna, "use_play_node_editors", PROP_BOOLEAN, PROP_NONE);
258         RNA_def_property_boolean_sdna(prop, NULL, "redraws_flag", TIME_NODES);
259         RNA_def_property_ui_text(prop, "Node Editors", "");
260         RNA_def_property_update(prop, NC_SPACE|ND_SPACE_TIME, "rna_Screen_redraw_update");
261 }
262
263 void RNA_def_screen(BlenderRNA *brna)
264 {
265         rna_def_screen(brna);
266         rna_def_area(brna);
267         rna_def_region(brna);
268 }
269
270 #endif
271