Merge branch 'dpkdir' into 'master'
[xonotic/netradiant.git] / radiant / mainframe.h
1 /*
2    Copyright (C) 1999-2006 Id Software, Inc. and contributors.
3    For a list of contributors, see the accompanying CONTRIBUTORS file.
4
5    This file is part of GtkRadiant.
6
7    GtkRadiant is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    GtkRadiant is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with GtkRadiant; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 #if !defined( INCLUDED_MAINFRAME_H )
23 #define INCLUDED_MAINFRAME_H
24
25 #include "gtkutil/window.h"
26 #include "gtkutil/idledraw.h"
27 #include "gtkutil/widget.h"
28 #include "string/string.h"
29
30 #include "qerplugin.h"
31
32 class IPlugIn;
33 class IToolbarButton;
34
35 class XYWnd;
36 class CamWnd;
37 class ZWnd;
38
39 typedef struct _GtkWidget GtkWidget;
40 typedef struct _GtkWindow GtkWindow;
41
42 const int c_command_status = 0;
43 const int c_position_status = 1;
44 const int c_brushcount_status = 2;
45 const int c_texture_status = 3;
46 const int c_grid_status = 4;
47 const int c_count_status = 5;
48
49 class MainFrame
50 {
51 public:
52 enum EViewStyle
53 {
54         eRegular = 0,
55         eFloating = 1,
56         eSplit = 2,
57         eRegularLeft = 3,
58 };
59
60 MainFrame();
61 ~MainFrame();
62
63 GtkWindow* m_window;
64
65 CopiedString m_command_status;
66 CopiedString m_position_status;
67 CopiedString m_brushcount_status;
68 CopiedString m_texture_status;
69 CopiedString m_grid_status;
70 private:
71
72 void Create();
73 void SaveWindowInfo();
74 void Shutdown();
75
76 GtkWidget* m_vSplit;
77 GtkWidget* m_hSplit;
78 GtkWidget* m_vSplit2;
79
80 XYWnd* m_pXYWnd;
81 XYWnd* m_pYZWnd;
82 XYWnd* m_pXZWnd;
83 CamWnd* m_pCamWnd;
84 ZWnd* m_pZWnd;
85 XYWnd* m_pActiveXY;
86
87 bool m_bSleeping;
88
89 GtkWidget *m_pStatusLabel[c_count_status];
90
91
92 EViewStyle m_nCurrentStyle;
93 WindowPositionTracker m_position_tracker;
94
95 IdleDraw m_idleRedrawStatusText;
96
97 public:
98
99 bool IsSleeping(){
100         return m_bSleeping;
101 }
102 void OnSleep();
103
104 void SetStatusText( CopiedString& status_text, const char* pText );
105 void UpdateStatusText();
106 void RedrawStatusText();
107 typedef MemberCaller<MainFrame, &MainFrame::RedrawStatusText> RedrawStatusTextCaller;
108
109 void SetGridStatus();
110 typedef MemberCaller<MainFrame, &MainFrame::SetGridStatus> SetGridStatusCaller;
111
112 void SetActiveXY( XYWnd* p );
113 XYWnd* ActiveXY(){
114         return m_pActiveXY;
115 };
116 XYWnd* GetXYWnd(){
117         return m_pXYWnd;
118 }
119 XYWnd* GetXZWnd(){
120         return m_pXZWnd;
121 }
122 XYWnd* GetYZWnd(){
123         return m_pYZWnd;
124 }
125 ZWnd* GetZWnd(){
126         return m_pZWnd;
127 }
128 CamWnd* GetCamWnd(){
129         return m_pCamWnd;
130 }
131
132 void ReleaseContexts();
133 void CreateContexts();
134
135 EViewStyle CurrentStyle(){
136         return m_nCurrentStyle;
137 };
138 bool FloatingGroupDialog(){
139         return CurrentStyle() == eFloating || CurrentStyle() == eSplit;
140 };
141 };
142
143 extern MainFrame* g_pParentWnd;
144
145 GtkWindow* MainFrame_getWindow();
146
147 enum EMouseButtonMode
148 {
149         ETwoButton = 0,
150         EThreeButton = 1,
151 };
152
153 struct glwindow_globals_t
154 {
155         int m_nMouseType;
156
157         glwindow_globals_t() :
158                 m_nMouseType( EThreeButton ){
159         }
160 };
161
162 void GLWindow_Construct();
163 void GLWindow_Destroy();
164
165 extern glwindow_globals_t g_glwindow_globals;
166 template<typename Value>
167 class LatchedValue;
168 typedef LatchedValue<bool> LatchedBool;
169 extern LatchedBool g_Layout_enableDetachableMenus;
170
171 void deleteSelection();
172
173
174 void Sys_Status( const char* status );
175
176
177 void ScreenUpdates_Disable( const char* message, const char* title );
178 void ScreenUpdates_Enable();
179 bool ScreenUpdates_Enabled();
180 void ScreenUpdates_process();
181
182 class ScopeDisableScreenUpdates
183 {
184 public:
185 ScopeDisableScreenUpdates( const char* message, const char* title ){
186         ScreenUpdates_Disable( message, title );
187 }
188 ~ScopeDisableScreenUpdates(){
189         ScreenUpdates_Enable();
190 }
191 };
192
193
194 void EnginePath_Realise();
195 void EnginePath_Unrealise();
196
197 class ModuleObserver;
198
199 void Radiant_attachEnginePathObserver( ModuleObserver& observer );
200 void Radiant_detachEnginePathObserver( ModuleObserver& observer );
201
202 void Radiant_attachGameToolsPathObserver( ModuleObserver& observer );
203 void Radiant_detachGameToolsPathObserver( ModuleObserver& observer );
204
205 extern CopiedString g_strEnginePath;
206 void EnginePath_verify();
207 const char* EnginePath_get();
208 const char* QERApp_GetGamePath();
209
210 extern CopiedString g_strAppPath;
211 const char* AppPath_get();
212
213 extern CopiedString g_strSettingsPath;
214 const char* SettingsPath_get();
215
216 const char* LocalRcPath_get( void );
217
218 const char* const g_pluginsDir = "plugins/"; ///< name of plugins directory, always sub-directory of toolspath
219 const char* const g_modulesDir = "modules/"; ///< name of modules directory, always sub-directory of toolspath
220
221 extern CopiedString g_strGameToolsPath;
222 const char* GameToolsPath_get();
223
224 void Radiant_Initialise();
225 void Radiant_Shutdown();
226
227 void SaveMapAs();
228
229
230 void XY_UpdateAllWindows();
231 void UpdateAllWindows();
232
233
234 void ClipperChangeNotify();
235
236 void DefaultMode();
237
238 const char* basegame_get();
239 const char* gamename_get();
240 void gamename_set( const char* gamename );
241 void Radiant_attachGameNameObserver( ModuleObserver& observer );
242 void Radiant_detachGameNameObserver( ModuleObserver& observer );
243 const char* gamemode_get();
244 void gamemode_set( const char* gamemode );
245 void Radiant_attachGameModeObserver( ModuleObserver& observer );
246 void Radiant_detachGameModeObserver( ModuleObserver& observer );
247
248 void VFS_Restart();
249 void VFS_Construct();
250 void VFS_Destroy();
251
252 void HomePaths_Construct();
253 void HomePaths_Destroy();
254 void Radiant_attachHomePathsObserver( ModuleObserver& observer );
255 void Radiant_detachHomePathsObserver( ModuleObserver& observer );
256
257
258 void MainFrame_Construct();
259 void MainFrame_Destroy();
260
261
262 extern float ( *GridStatus_getGridSize )();
263 extern int ( *GridStatus_getRotateIncrement )();
264 extern int ( *GridStatus_getFarClipDistance )();
265 extern bool ( *GridStatus_getTextureLockEnabled )();
266 void GridStatus_onTextureLockEnabledChanged();
267
268 SignalHandlerId XYWindowDestroyed_connect( const SignalHandler& handler );
269 void XYWindowDestroyed_disconnect( SignalHandlerId id );
270 MouseEventHandlerId XYWindowMouseDown_connect( const MouseEventHandler& handler );
271 void XYWindowMouseDown_disconnect( MouseEventHandlerId id );
272
273 extern GtkWidget* g_page_entity;
274
275 #endif