patch [#25027] formatting mathutils.geometry module docs for sphinx
[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 #ifdef RNA_RUNTIME
50
51
52 #include "WM_api.h"
53 #include "WM_types.h"
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 int rna_Screen_is_animation_playing_get(PointerRNA *ptr)
78 {
79         bScreen *sc= (bScreen*)ptr->data;
80         return (sc->animtimer != NULL);
81 }
82
83 static int rna_Screen_fullscreen_get(PointerRNA *ptr)
84 {
85         bScreen *sc= (bScreen*)ptr->data;
86         return (sc->full == SCREENFULL);
87 }
88
89 static void rna_Area_type_set(PointerRNA *ptr, int value)
90 {
91         ScrArea *sa= (ScrArea*)ptr->data;
92         sa->butspacetype= value;
93 }
94
95 static void rna_Area_type_update(bContext *C, PointerRNA *ptr)
96 {
97         ScrArea *sa= (ScrArea*)ptr->data;
98
99         ED_area_newspace(C, sa, sa->butspacetype); /* XXX - this uses the window */
100         ED_area_tag_redraw(sa);
101 }
102
103 #else
104
105 static void rna_def_area(BlenderRNA *brna)
106 {
107         StructRNA *srna;
108         PropertyRNA *prop;
109         FunctionRNA *func;
110         PropertyRNA *parm;
111         
112         srna= RNA_def_struct(brna, "Area", NULL);
113         RNA_def_struct_ui_text(srna, "Area", "Area in a subdivided screen, containing an editor");
114         RNA_def_struct_sdna(srna, "ScrArea");
115
116         prop= RNA_def_property(srna, "spaces", PROP_COLLECTION, PROP_NONE);
117         RNA_def_property_collection_sdna(prop, NULL, "spacedata", NULL);
118         RNA_def_property_struct_type(prop, "Space");
119         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.");
120
121         prop= RNA_def_property(srna, "active_space", PROP_POINTER, PROP_NONE);
122         RNA_def_property_pointer_sdna(prop, NULL, "spacedata.first");
123         RNA_def_property_struct_type(prop, "Space");
124         RNA_def_property_ui_text(prop, "Active Space", "Space currently being displayed in this area");
125
126         prop= RNA_def_property(srna, "regions", PROP_COLLECTION, PROP_NONE);
127         RNA_def_property_collection_sdna(prop, NULL, "regionbase", NULL);
128         RNA_def_property_struct_type(prop, "Region");
129         RNA_def_property_ui_text(prop, "Regions", "Regions this area is subdivided in");
130
131         prop= RNA_def_property(srna, "show_menus", PROP_BOOLEAN, PROP_NONE);
132         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", HEADER_NO_PULLDOWN);
133         RNA_def_property_ui_text(prop, "Show Menus", "Show menus in the header");
134         
135         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
136         RNA_def_property_enum_sdna(prop, NULL, "spacetype");
137         RNA_def_property_enum_items(prop, space_type_items);
138         RNA_def_property_enum_funcs(prop, NULL, "rna_Area_type_set", NULL);
139         RNA_def_property_ui_text(prop, "Type", "Space type");
140         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
141         RNA_def_property_update(prop, 0, "rna_Area_type_update");
142
143         RNA_def_function(srna, "tag_redraw", "ED_area_tag_redraw");
144
145         func= RNA_def_function(srna, "header_text_set", "ED_area_headerprint");
146         RNA_def_function_ui_description(func, "Set the header text");
147         parm= RNA_def_string(func, "text", NULL, 0, "Text", "New string for the header, no argument clears the text.");
148 }
149
150 static void rna_def_region(BlenderRNA *brna)
151 {
152         StructRNA *srna;
153         PropertyRNA *prop;
154         
155         srna= RNA_def_struct(brna, "Region", NULL);
156         RNA_def_struct_ui_text(srna, "Region", "Region in a subdivided screen area");
157         RNA_def_struct_sdna(srna, "ARegion");
158         
159         prop= RNA_def_property(srna, "id", PROP_INT, PROP_NONE);
160         RNA_def_property_int_sdna(prop, NULL, "swinid");
161         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
162         RNA_def_property_ui_text(prop, "Region ID", "Unique ID for this region");
163
164         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
165         RNA_def_property_enum_sdna(prop, NULL, "regiontype");
166         RNA_def_property_enum_items(prop, region_type_items);
167         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
168         RNA_def_property_ui_text(prop, "Region Type", "Type of this region");
169
170         prop= RNA_def_property(srna, "width", PROP_INT, PROP_UNSIGNED);
171         RNA_def_property_int_sdna(prop, NULL, "winx");
172         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
173         RNA_def_property_ui_text(prop, "Width", "Region width");
174
175         prop= RNA_def_property(srna, "height", PROP_INT, PROP_UNSIGNED);
176         RNA_def_property_int_sdna(prop, NULL, "winy");
177         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
178         RNA_def_property_ui_text(prop, "Height", "Region height");
179         
180         RNA_def_function(srna, "tag_redraw", "ED_region_tag_redraw");
181 }
182
183 static void rna_def_screen(BlenderRNA *brna)
184 {
185         StructRNA *srna;
186         PropertyRNA *prop;
187         
188         srna= RNA_def_struct(brna, "Screen", "ID");
189         RNA_def_struct_sdna(srna, "Screen"); /* it is actually bScreen but for 2.5 the dna is patched! */
190         RNA_def_struct_ui_text(srna, "Screen", "Screen datablock, defining the layout of areas in a window");
191         RNA_def_struct_ui_icon(srna, ICON_SPLITSCREEN);
192         
193         prop= RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
194         RNA_def_property_flag(prop, PROP_EDITABLE|PROP_NEVER_NULL);
195         RNA_def_property_pointer_funcs(prop, NULL, "rna_Screen_scene_set", NULL, NULL);
196         RNA_def_property_ui_text(prop, "Scene", "Active scene to be edited in the screen");
197         RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
198         RNA_def_property_update(prop, 0, "rna_Screen_scene_update");
199         
200         prop= RNA_def_property(srna, "areas", PROP_COLLECTION, PROP_NONE);
201         RNA_def_property_collection_sdna(prop, NULL, "areabase", NULL);
202         RNA_def_property_struct_type(prop, "Area");
203         RNA_def_property_ui_text(prop, "Areas", "Areas the screen is subdivided into");
204
205         prop= RNA_def_property(srna, "is_animation_playing", PROP_BOOLEAN, PROP_NONE);
206         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
207         RNA_def_property_boolean_funcs(prop, "rna_Screen_is_animation_playing_get", NULL);
208         RNA_def_property_ui_text(prop, "Animation Playing", "Animation playback is active");
209         
210         prop= RNA_def_property(srna, "show_fullscreen", PROP_BOOLEAN, PROP_NONE);
211         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
212         RNA_def_property_boolean_funcs(prop, "rna_Screen_fullscreen_get", NULL);
213         RNA_def_property_ui_text(prop, "Fullscreen", "An area is maximised, filling this screen");
214 }
215
216 void RNA_def_screen(BlenderRNA *brna)
217 {
218         rna_def_screen(brna);
219         rna_def_area(brna);
220         rna_def_region(brna);
221 }
222
223 #endif
224