]>
Commit | Line | Data |
---|---|---|
ec4f95c4 VZ |
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) | |
7d9f12f3 | 5 | // Author: Vadim Zeitlin, Vaclav Slavik |
ec4f95c4 VZ |
6 | // Modified by: |
7 | // Created: 06.08.01 | |
8 | // RCS-ID: $Id$ | |
9 | // Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr> | |
77ffb593 | 10 | // Vaclav Slavik <vaclav@wxwidgets.org> |
65571936 | 11 | // Licence: wxWindows licence |
ec4f95c4 VZ |
12 | /////////////////////////////////////////////////////////////////////////////// |
13 | ||
7d9f12f3 VS |
14 | #ifndef _WX_TOPLEVEL_BASE_H_ |
15 | #define _WX_TOPLEVEL_BASE_H_ | |
16 | ||
17 | // ---------------------------------------------------------------------------- | |
18 | // headers | |
19 | // ---------------------------------------------------------------------------- | |
20 | ||
ec4f95c4 | 21 | #include "wx/window.h" |
f618020a | 22 | #include "wx/iconbndl.h" |
7d9f12f3 | 23 | |
63ec432b MR |
24 | // the default names for various classes |
25 | extern WXDLLEXPORT_DATA(const wxChar) wxFrameNameStr[]; | |
7d9f12f3 VS |
26 | |
27 | class WXDLLEXPORT wxTopLevelWindowBase; | |
28 | ||
b22d16ad VS |
29 | // ---------------------------------------------------------------------------- |
30 | // constants | |
31 | // ---------------------------------------------------------------------------- | |
32 | ||
8b5ef6cf VZ |
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 | ||
1c067fe3 WS |
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 | |
8b5ef6cf VZ |
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 | |
a9928e9d | 68 | #if defined(__WXWINCE__) |
cb719f2e WS |
69 | #if defined(__SMARTPHONE__) |
70 | #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE) | |
a9928e9d | 71 | #elif defined(__WINCE_STANDARDSDK__) |
cb719f2e WS |
72 | #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX) |
73 | #else | |
30dfe2ff | 74 | #define wxDEFAULT_FRAME_STYLE (wxNO_BORDER) |
cb719f2e | 75 | #endif |
8b5ef6cf VZ |
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 | ||
7d9f12f3 | 88 | // Dialogs are created in a special way |
21f4383a | 89 | #define wxTOPLEVEL_EX_DIALOG 0x00000008 |
7d9f12f3 VS |
90 | |
91 | // Styles for ShowFullScreen | |
92 | // (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and | |
93 | // wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow) | |
b22d16ad VS |
94 | enum |
95 | { | |
96 | wxFULLSCREEN_NOMENUBAR = 0x0001, | |
97 | wxFULLSCREEN_NOTOOLBAR = 0x0002, | |
98 | wxFULLSCREEN_NOSTATUSBAR = 0x0004, | |
99 | wxFULLSCREEN_NOBORDER = 0x0008, | |
100 | wxFULLSCREEN_NOCAPTION = 0x0010, | |
d4597e13 VZ |
101 | |
102 | wxFULLSCREEN_ALL = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR | | |
103 | wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER | | |
b22d16ad VS |
104 | wxFULLSCREEN_NOCAPTION |
105 | }; | |
106 | ||
dc92adaf VZ |
107 | // Styles for RequestUserAttention |
108 | enum | |
109 | { | |
110 | wxUSER_ATTENTION_INFO = 1, | |
111 | wxUSER_ATTENTION_ERROR = 2 | |
112 | }; | |
113 | ||
ec4f95c4 VZ |
114 | // ---------------------------------------------------------------------------- |
115 | // wxTopLevelWindow: a top level (as opposed to child) window | |
116 | // ---------------------------------------------------------------------------- | |
117 | ||
7d9f12f3 | 118 | class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow |
ec4f95c4 VZ |
119 | { |
120 | public: | |
7d9f12f3 VS |
121 | // construction |
122 | wxTopLevelWindowBase(); | |
799ea011 | 123 | virtual ~wxTopLevelWindowBase(); |
b22d16ad | 124 | |
7d9f12f3 VS |
125 | // top level wnd state |
126 | // -------------------- | |
127 | ||
cb719f2e WS |
128 | // maximize = true => maximize, otherwise - restore |
129 | virtual void Maximize(bool maximize = true) = 0; | |
7d9f12f3 VS |
130 | |
131 | // undo Maximize() or Iconize() | |
132 | virtual void Restore() = 0; | |
133 | ||
cb719f2e WS |
134 | // iconize = true => iconize, otherwise - restore |
135 | virtual void Iconize(bool iconize = true) = 0; | |
7d9f12f3 | 136 | |
cb719f2e | 137 | // return true if the frame is maximized |
7d9f12f3 VS |
138 | virtual bool IsMaximized() const = 0; |
139 | ||
979a0320 WS |
140 | // return true if the frame is always maximized |
141 | // due to native guidelines or current policy | |
142 | virtual bool IsAlwaysMaximized() const; | |
143 | ||
cb719f2e | 144 | // return true if the frame is iconized |
7d9f12f3 VS |
145 | virtual bool IsIconized() const = 0; |
146 | ||
147 | // get the frame icon | |
f618020a MB |
148 | const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); } |
149 | ||
150 | // get the frame icons | |
151 | const wxIconBundle& GetIcons() const { return m_icons; } | |
7d9f12f3 VS |
152 | |
153 | // set the frame icon | |
f618020a MB |
154 | virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); } |
155 | ||
156 | // set the frame icons | |
157 | virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; } | |
7d9f12f3 | 158 | |
c8e8ae85 VS |
159 | // maximize the window to cover entire screen |
160 | virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0; | |
d4597e13 | 161 | |
cb719f2e | 162 | // return true if the frame is in fullscreen mode |
c8e8ae85 VS |
163 | virtual bool IsFullScreen() const = 0; |
164 | ||
ffd84c94 WS |
165 | // the title of the top level window: the text which the |
166 | // window shows usually at the top of the frame/dialog in dedicated bar | |
7d9f12f3 | 167 | virtual void SetTitle(const wxString& title) = 0; |
ec4f95c4 | 168 | virtual wxString GetTitle() const = 0; |
7d9f12f3 | 169 | |
1542ea39 | 170 | // Set the shape of the window to the given region. |
cb719f2e | 171 | // Returns true if the platform supports this feature (and the |
1542ea39 | 172 | // operation is successful.) |
cb719f2e | 173 | virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; } |
1542ea39 | 174 | |
dc92adaf VZ |
175 | // Attracts the users attention to this window if the application is |
176 | // inactive (should be called when a background event occurs) | |
177 | virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO); | |
9b141468 | 178 | |
35ff90a0 | 179 | // Is this the active frame (highlighted in the taskbar)? |
171a1afe VZ |
180 | virtual bool IsActive() { return wxGetTopLevelParent(FindFocus()) == this; } |
181 | ||
182 | // this function may be overridden to return false to allow closing the | |
183 | // application even when this top level window is still open | |
184 | // | |
185 | // notice that the window is still closed prior to the application exit and | |
186 | // so it can still veto it even if it returns false from here | |
187 | virtual bool ShouldPreventAppExit() const { return true; } | |
188 | ||
dc92adaf | 189 | |
9b141468 WS |
190 | #if defined(__SMARTPHONE__) |
191 | virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0; | |
192 | virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0; | |
193 | #endif // __SMARTPHONE__ | |
194 | ||
1f464296 VZ |
195 | // centre the window on screen: this is just a shortcut |
196 | void CentreOnScreen(int dir = wxBOTH) { DoCentre(dir | wxCENTRE_ON_SCREEN); } | |
197 | void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); } | |
198 | ||
6c20e8f8 VZ |
199 | |
200 | // default item access: we have a permanent default item which is the one | |
201 | // set by the user code but we may also have a temporary default item which | |
202 | // would be chosen if the user pressed "Enter" now but the default action | |
203 | // reverts to the "permanent" default as soon as this temporary default | |
204 | // item loses focus | |
205 | ||
206 | // used to reset default if pointing to removed child | |
207 | virtual void RemoveChild(wxWindowBase *child); | |
208 | ||
209 | // get the default item, temporary or permanent | |
210 | wxWindow *GetDefaultItem() const | |
211 | { return m_winTmpDefault ? m_winTmpDefault : m_winDefault; } | |
212 | ||
213 | // set the permanent default item, return the old default | |
214 | wxWindow *SetDefaultItem(wxWindow *win) | |
215 | { wxWindow *old = GetDefaultItem(); m_winDefault = win; return old; } | |
216 | ||
217 | // return the temporary default item, can be NULL | |
218 | wxWindow *GetTmpDefaultItem() const { return m_winTmpDefault; } | |
219 | ||
220 | // set a temporary default item, SetTmpDefaultItem(NULL) should be called | |
221 | // soon after a call to SetTmpDefaultItem(window), return the old default | |
222 | wxWindow *SetTmpDefaultItem(wxWindow *win) | |
223 | { wxWindow *old = GetDefaultItem(); m_winTmpDefault = win; return old; } | |
224 | ||
225 | ||
7d9f12f3 VS |
226 | // implementation only from now on |
227 | // ------------------------------- | |
228 | ||
229 | // override some base class virtuals | |
230 | virtual bool Destroy(); | |
cb719f2e | 231 | virtual bool IsTopLevel() const { return true; } |
34c3ffca | 232 | virtual wxSize GetMaxSize() const; |
7d9f12f3 VS |
233 | |
234 | // event handlers | |
235 | void OnCloseWindow(wxCloseEvent& event); | |
5e62d4a5 | 236 | void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); } |
7d9f12f3 | 237 | |
0bba37f5 DE |
238 | // Get rect to be used to center top-level children |
239 | virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h); | |
240 | ||
7d9f12f3 VS |
241 | // this should go away, but for now it's called from docview.cpp, |
242 | // so should be there for all platforms | |
243 | void OnActivate(wxActivateEvent &WXUNUSED(event)) { } | |
244 | ||
e39af974 JS |
245 | // do the window-specific processing after processing the update event |
246 | virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; | |
247 | ||
7d9f12f3 VS |
248 | protected: |
249 | // the frame client to screen translation should take account of the | |
250 | // toolbar which may shift the origin of the client area | |
251 | virtual void DoClientToScreen(int *x, int *y) const; | |
252 | virtual void DoScreenToClient(int *x, int *y) const; | |
253 | ||
1f464296 VZ |
254 | // add support for wxCENTRE_ON_SCREEN |
255 | virtual void DoCentre(int dir); | |
256 | ||
3c81c9aa VZ |
257 | // no need to do client to screen translation to get our position in screen |
258 | // coordinates: this is already the case | |
259 | virtual void DoGetScreenPosition(int *x, int *y) const | |
260 | { | |
74af7bcf | 261 | DoGetPosition(x, y); |
3c81c9aa | 262 | } |
1f464296 | 263 | |
1cbee0b4 VZ |
264 | // test whether this window makes part of the frame |
265 | // (menubar, toolbar and statusbar are excluded from automatic layout) | |
266 | virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const | |
cb719f2e | 267 | { return false; } |
1cbee0b4 | 268 | |
65afac3f | 269 | // check if we should exit the program after deleting this window |
5c363878 | 270 | bool IsLastBeforeExit() const; |
1cbee0b4 | 271 | |
cb719f2e WS |
272 | // send the iconize event, return true if processed |
273 | bool SendIconizeEvent(bool iconized = true); | |
7d9f12f3 | 274 | |
5e62d4a5 VZ |
275 | // do TLW-specific layout: we resize our unique child to fill the entire |
276 | // client area | |
277 | void DoLayout(); | |
278 | ||
66202a7e RD |
279 | // Get the default size for the new window if no explicit size given. If |
280 | // there are better default sizes then these can be changed, just as long | |
0c089c08 VZ |
281 | // as they are not too small for TLWs (and not larger than screen). |
282 | static wxSize GetDefaultSize(); | |
cb719f2e WS |
283 | static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; } |
284 | static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; } | |
66202a7e | 285 | |
7d9f12f3 | 286 | // the frame icon |
f618020a | 287 | wxIconBundle m_icons; |
7d9f12f3 | 288 | |
6c20e8f8 VZ |
289 | // a default window (usually a button) or NULL |
290 | wxWindow *m_winDefault; | |
291 | ||
292 | // a temporary override of m_winDefault, use the latter if NULL | |
293 | wxWindow *m_winTmpDefault; | |
294 | ||
fc7a2a60 | 295 | DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase) |
7d9f12f3 | 296 | DECLARE_EVENT_TABLE() |
ec4f95c4 VZ |
297 | }; |
298 | ||
7d9f12f3 VS |
299 | |
300 | // include the real class declaration | |
4055ed82 | 301 | #if defined(__WXPALMOS__) |
ffecfa5a JS |
302 | #include "wx/palmos/toplevel.h" |
303 | #define wxTopLevelWindowNative wxTopLevelWindowPalm | |
304 | #elif defined(__WXMSW__) | |
82c9f85c VZ |
305 | #include "wx/msw/toplevel.h" |
306 | #define wxTopLevelWindowNative wxTopLevelWindowMSW | |
1be7a35c | 307 | #elif defined(__WXGTK20__) |
7d9f12f3 VS |
308 | #include "wx/gtk/toplevel.h" |
309 | #define wxTopLevelWindowNative wxTopLevelWindowGTK | |
1be7a35c MR |
310 | #elif defined(__WXGTK__) |
311 | #include "wx/gtk1/toplevel.h" | |
312 | #define wxTopLevelWindowNative wxTopLevelWindowGTK | |
83df96d6 JS |
313 | #elif defined(__WXX11__) |
314 | #include "wx/x11/toplevel.h" | |
315 | #define wxTopLevelWindowNative wxTopLevelWindowX11 | |
7d9f12f3 VS |
316 | #elif defined(__WXMGL__) |
317 | #include "wx/mgl/toplevel.h" | |
318 | #define wxTopLevelWindowNative wxTopLevelWindowMGL | |
93b4dc4b SC |
319 | #elif defined(__WXMAC__) |
320 | #include "wx/mac/toplevel.h" | |
321 | #define wxTopLevelWindowNative wxTopLevelWindowMac | |
e64df9bc DE |
322 | #elif defined(__WXCOCOA__) |
323 | #include "wx/cocoa/toplevel.h" | |
324 | #define wxTopLevelWindowNative wxTopLevelWindowCocoa | |
c9782ca3 DW |
325 | #elif defined(__WXPM__) |
326 | #include "wx/os2/toplevel.h" | |
327 | #define wxTopLevelWindowNative wxTopLevelWindowOS2 | |
798a4529 MB |
328 | #elif defined(__WXMOTIF__) |
329 | #include "wx/motif/toplevel.h" | |
330 | #define wxTopLevelWindowNative wxTopLevelWindowMotif | |
7d9f12f3 VS |
331 | #endif |
332 | ||
333 | #ifdef __WXUNIVERSAL__ | |
334 | #include "wx/univ/toplevel.h" | |
335 | #else // !__WXUNIVERSAL__ | |
336 | #ifdef wxTopLevelWindowNative | |
337 | class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative | |
338 | { | |
339 | public: | |
340 | // construction | |
341 | wxTopLevelWindow() { Init(); } | |
342 | wxTopLevelWindow(wxWindow *parent, | |
d9e2e4c2 | 343 | wxWindowID winid, |
7d9f12f3 VS |
344 | const wxString& title, |
345 | const wxPoint& pos = wxDefaultPosition, | |
346 | const wxSize& size = wxDefaultSize, | |
347 | long style = wxDEFAULT_FRAME_STYLE, | |
348 | const wxString& name = wxFrameNameStr) | |
349 | { | |
350 | Init(); | |
d9e2e4c2 | 351 | Create(parent, winid, title, pos, size, style, name); |
7d9f12f3 VS |
352 | } |
353 | ||
fc7a2a60 | 354 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow) |
7d9f12f3 VS |
355 | }; |
356 | #endif // wxTopLevelWindowNative | |
357 | #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__ | |
358 | ||
359 | ||
360 | #endif // _WX_TOPLEVEL_BASE_H_ |