]> git.saurik.com Git - wxWidgets.git/blob - include/wx/toplevel.h
made ShouldPreventAppExit() public
[wxWidgets.git] / include / wx / toplevel.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/toplevel.h
3 // Purpose: declares wxTopLevelWindow class, the base class for all
4 // top level windows (such as frames and dialogs)
5 // Author: Vadim Zeitlin, Vaclav Slavik
6 // Modified by:
7 // Created: 06.08.01
8 // RCS-ID: $Id$
9 // Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Vaclav Slavik <vaclav@wxwidgets.org>
11 // Licence: wxWindows licence
12 ///////////////////////////////////////////////////////////////////////////////
13
14 #ifndef _WX_TOPLEVEL_BASE_H_
15 #define _WX_TOPLEVEL_BASE_H_
16
17 // ----------------------------------------------------------------------------
18 // headers
19 // ----------------------------------------------------------------------------
20
21 #include "wx/window.h"
22 #include "wx/iconbndl.h"
23
24 // the default names for various classes
25 extern WXDLLEXPORT_DATA(const wxChar) wxFrameNameStr[];
26
27 class WXDLLEXPORT wxTopLevelWindowBase;
28
29 // ----------------------------------------------------------------------------
30 // constants
31 // ----------------------------------------------------------------------------
32
33 // style common to both wxFrame and wxDialog
34 #define wxSTAY_ON_TOP 0x8000
35 #define wxICONIZE 0x4000
36 #define wxMINIMIZE wxICONIZE
37 #define wxMAXIMIZE 0x2000
38 #define wxCLOSE_BOX 0x1000
39
40 #define wxSYSTEM_MENU 0x0800
41 #define wxMINIMIZE_BOX 0x0400
42 #define wxMAXIMIZE_BOX 0x0200
43 #define wxTINY_CAPTION_HORIZ 0x0100
44 #define wxTINY_CAPTION_VERT 0x0080
45 #define wxRESIZE_BORDER 0x0040
46
47 #if WXWIN_COMPATIBILITY_2_6
48
49 // deprecated versions defined for compatibility reasons
50 #define wxRESIZE_BOX wxMAXIMIZE_BOX
51 #define wxTHICK_FRAME wxRESIZE_BORDER
52
53 // obsolete styles, unused any more
54 #define wxDIALOG_MODAL 0
55 #define wxDIALOG_MODELESS 0
56 #define wxNO_3D 0
57 #define wxUSER_COLOURS 0
58
59 #endif // WXWIN_COMPATIBILITY_2_6
60
61 // default style
62 //
63 // under Windows CE (at least when compiling with eVC 4) we should create
64 // top level windows without any styles at all for them to appear
65 // "correctly", i.e. as full screen windows with a "hide" button (same as
66 // "close" but round instead of squared and just hides the applications
67 // instead of closing it) in the title bar
68 #if defined(__WXWINCE__)
69 #if defined(__SMARTPHONE__)
70 #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE)
71 #elif defined(__WINCE_STANDARDSDK__)
72 #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
73 #else
74 #define wxDEFAULT_FRAME_STYLE (wxNO_BORDER)
75 #endif
76 #else // !__WXWINCE__
77 #define wxDEFAULT_FRAME_STYLE \
78 (wxSYSTEM_MENU | \
79 wxRESIZE_BORDER | \
80 wxMINIMIZE_BOX | \
81 wxMAXIMIZE_BOX | \
82 wxCLOSE_BOX | \
83 wxCAPTION | \
84 wxCLIP_CHILDREN)
85 #endif
86
87
88 // Dialogs are created in a special way
89 #define wxTOPLEVEL_EX_DIALOG 0x00000008
90
91 // Styles for ShowFullScreen
92 // (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and
93 // wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow)
94 enum
95 {
96 wxFULLSCREEN_NOMENUBAR = 0x0001,
97 wxFULLSCREEN_NOTOOLBAR = 0x0002,
98 wxFULLSCREEN_NOSTATUSBAR = 0x0004,
99 wxFULLSCREEN_NOBORDER = 0x0008,
100 wxFULLSCREEN_NOCAPTION = 0x0010,
101
102 wxFULLSCREEN_ALL = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
103 wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |
104 wxFULLSCREEN_NOCAPTION
105 };
106
107 // Styles for RequestUserAttention
108 enum
109 {
110 wxUSER_ATTENTION_INFO = 1,
111 wxUSER_ATTENTION_ERROR = 2
112 };
113
114 // ----------------------------------------------------------------------------
115 // wxTopLevelWindow: a top level (as opposed to child) window
116 // ----------------------------------------------------------------------------
117
118 class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
119 {
120 public:
121 // construction
122 wxTopLevelWindowBase();
123 virtual ~wxTopLevelWindowBase();
124
125 // top level wnd state
126 // --------------------
127
128 // maximize = true => maximize, otherwise - restore
129 virtual void Maximize(bool maximize = true) = 0;
130
131 // undo Maximize() or Iconize()
132 virtual void Restore() = 0;
133
134 // iconize = true => iconize, otherwise - restore
135 virtual void Iconize(bool iconize = true) = 0;
136
137 // return true if the frame is maximized
138 virtual bool IsMaximized() const = 0;
139
140 // return true if the frame is iconized
141 virtual bool IsIconized() const = 0;
142
143 // get the frame icon
144 const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
145
146 // get the frame icons
147 const wxIconBundle& GetIcons() const { return m_icons; }
148
149 // set the frame icon
150 virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
151
152 // set the frame icons
153 virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }
154
155 // maximize the window to cover entire screen
156 virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
157
158 // return true if the frame is in fullscreen mode
159 virtual bool IsFullScreen() const = 0;
160
161 // the title of the top level window: the text which the
162 // window shows usually at the top of the frame/dialog in dedicated bar
163 virtual void SetTitle(const wxString& title) = 0;
164 virtual wxString GetTitle() const = 0;
165
166 // Set the shape of the window to the given region.
167 // Returns true if the platform supports this feature (and the
168 // operation is successful.)
169 virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }
170
171 // Attracts the users attention to this window if the application is
172 // inactive (should be called when a background event occurs)
173 virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
174
175 // Is this the active frame (highlighted in the taskbar)?
176 virtual bool IsActive() { return wxGetTopLevelParent(FindFocus()) == this; }
177
178 // this function may be overridden to return false to allow closing the
179 // application even when this top level window is still open
180 //
181 // notice that the window is still closed prior to the application exit and
182 // so it can still veto it even if it returns false from here
183 virtual bool ShouldPreventAppExit() const { return true; }
184
185
186 #if defined(__SMARTPHONE__)
187 virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
188 virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
189 #endif // __SMARTPHONE__
190
191 // centre the window on screen: this is just a shortcut
192 void CentreOnScreen(int dir = wxBOTH) { DoCentre(dir | wxCENTRE_ON_SCREEN); }
193 void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
194
195
196 // implementation only from now on
197 // -------------------------------
198
199 // override some base class virtuals
200 virtual bool Destroy();
201 virtual bool IsTopLevel() const { return true; }
202 virtual wxSize GetMaxSize() const;
203
204 // event handlers
205 void OnCloseWindow(wxCloseEvent& event);
206 void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
207
208 // Get rect to be used to center top-level children
209 virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h);
210
211 // this should go away, but for now it's called from docview.cpp,
212 // so should be there for all platforms
213 void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
214
215 // do the window-specific processing after processing the update event
216 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
217
218 protected:
219 // the frame client to screen translation should take account of the
220 // toolbar which may shift the origin of the client area
221 virtual void DoClientToScreen(int *x, int *y) const;
222 virtual void DoScreenToClient(int *x, int *y) const;
223
224 // add support for wxCENTRE_ON_SCREEN
225 virtual void DoCentre(int dir);
226
227 // no need to do client to screen translation to get our position in screen
228 // coordinates: this is already the case
229 virtual void DoGetScreenPosition(int *x, int *y) const
230 {
231 DoGetPosition(x, y);
232 }
233
234 // test whether this window makes part of the frame
235 // (menubar, toolbar and statusbar are excluded from automatic layout)
236 virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
237 { return false; }
238
239 // check if we should exit the program after deleting this window
240 bool IsLastBeforeExit() const;
241
242 // send the iconize event, return true if processed
243 bool SendIconizeEvent(bool iconized = true);
244
245 // do TLW-specific layout: we resize our unique child to fill the entire
246 // client area
247 void DoLayout();
248
249 // Get the default size for the new window if no explicit size given. If
250 // there are better default sizes then these can be changed, just as long
251 // as they are not too small for TLWs (and not larger than screen).
252 static wxSize GetDefaultSize();
253 static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
254 static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }
255
256 // the frame icon
257 wxIconBundle m_icons;
258
259 DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
260 DECLARE_EVENT_TABLE()
261 };
262
263
264 // include the real class declaration
265 #if defined(__WXPALMOS__)
266 #include "wx/palmos/toplevel.h"
267 #define wxTopLevelWindowNative wxTopLevelWindowPalm
268 #elif defined(__WXMSW__)
269 #include "wx/msw/toplevel.h"
270 #define wxTopLevelWindowNative wxTopLevelWindowMSW
271 #elif defined(__WXGTK20__)
272 #include "wx/gtk/toplevel.h"
273 #define wxTopLevelWindowNative wxTopLevelWindowGTK
274 #elif defined(__WXGTK__)
275 #include "wx/gtk1/toplevel.h"
276 #define wxTopLevelWindowNative wxTopLevelWindowGTK
277 #elif defined(__WXX11__)
278 #include "wx/x11/toplevel.h"
279 #define wxTopLevelWindowNative wxTopLevelWindowX11
280 #elif defined(__WXMGL__)
281 #include "wx/mgl/toplevel.h"
282 #define wxTopLevelWindowNative wxTopLevelWindowMGL
283 #elif defined(__WXMAC__)
284 #include "wx/mac/toplevel.h"
285 #define wxTopLevelWindowNative wxTopLevelWindowMac
286 #elif defined(__WXCOCOA__)
287 #include "wx/cocoa/toplevel.h"
288 #define wxTopLevelWindowNative wxTopLevelWindowCocoa
289 #elif defined(__WXPM__)
290 #include "wx/os2/toplevel.h"
291 #define wxTopLevelWindowNative wxTopLevelWindowOS2
292 #elif defined(__WXMOTIF__)
293 #include "wx/motif/toplevel.h"
294 #define wxTopLevelWindowNative wxTopLevelWindowMotif
295 #endif
296
297 #ifdef __WXUNIVERSAL__
298 #include "wx/univ/toplevel.h"
299 #else // !__WXUNIVERSAL__
300 #ifdef wxTopLevelWindowNative
301 class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
302 {
303 public:
304 // construction
305 wxTopLevelWindow() { Init(); }
306 wxTopLevelWindow(wxWindow *parent,
307 wxWindowID winid,
308 const wxString& title,
309 const wxPoint& pos = wxDefaultPosition,
310 const wxSize& size = wxDefaultSize,
311 long style = wxDEFAULT_FRAME_STYLE,
312 const wxString& name = wxFrameNameStr)
313 {
314 Init();
315 Create(parent, winid, title, pos, size, style, name);
316 }
317
318 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)
319 };
320 #endif // wxTopLevelWindowNative
321 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
322
323
324 #endif // _WX_TOPLEVEL_BASE_H_