]>
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> | |
7d9f12f3 | 10 | // Vaclav Slavik <vaclav@wxwindows.org> |
ec4f95c4 VZ |
11 | // Licence: wxWindows licence |
12 | /////////////////////////////////////////////////////////////////////////////// | |
13 | ||
7d9f12f3 VS |
14 | #ifndef _WX_TOPLEVEL_BASE_H_ |
15 | #define _WX_TOPLEVEL_BASE_H_ | |
16 | ||
12028905 | 17 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
af49c4b8 GD |
18 | #pragma interface "toplevelbase.h" |
19 | #endif | |
20 | ||
7d9f12f3 VS |
21 | // ---------------------------------------------------------------------------- |
22 | // headers | |
23 | // ---------------------------------------------------------------------------- | |
24 | ||
ec4f95c4 | 25 | #include "wx/window.h" |
f618020a | 26 | #include "wx/iconbndl.h" |
7d9f12f3 VS |
27 | |
28 | // the default names for various classs | |
29 | WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr; | |
30 | ||
31 | class WXDLLEXPORT wxTopLevelWindowBase; | |
32 | ||
b22d16ad VS |
33 | // ---------------------------------------------------------------------------- |
34 | // constants | |
35 | // ---------------------------------------------------------------------------- | |
36 | ||
8b5ef6cf VZ |
37 | // style common to both wxFrame and wxDialog |
38 | #define wxSTAY_ON_TOP 0x8000 | |
39 | #define wxICONIZE 0x4000 | |
40 | #define wxMINIMIZE wxICONIZE | |
41 | #define wxMAXIMIZE 0x2000 | |
42 | #define wxCLOSE_BOX 0x1000 | |
43 | ||
44 | #define wxSYSTEM_MENU 0x0800 | |
45 | #define wxMINIMIZE_BOX 0x0400 | |
46 | #define wxMAXIMIZE_BOX 0x0200 | |
47 | #define wxTINY_CAPTION_HORIZ 0x0100 | |
48 | #define wxTINY_CAPTION_VERT 0x0080 | |
49 | #define wxRESIZE_BORDER 0x0040 | |
50 | ||
51 | // deprecated versions defined for compatibility reasons | |
52 | #define wxRESIZE_BOX wxMAXIMIZE_BOX | |
53 | #define wxTHICK_FRAME wxRESIZE_BORDER | |
54 | ||
55 | // obsolete styles, unused any more | |
56 | #define wxDIALOG_MODAL 0 | |
57 | #define wxDIALOG_MODELESS 0 | |
58 | #define wxNO_3D 0 | |
59 | #define wxUSER_COLOURS 0 | |
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 | #ifdef __WXWINCE__ | |
69 | #define wxDEFAULT_FRAME_STYLE (0) | |
70 | #else // !__WXWINCE__ | |
71 | #define wxDEFAULT_FRAME_STYLE \ | |
72 | (wxSYSTEM_MENU | \ | |
73 | wxRESIZE_BORDER | \ | |
74 | wxMINIMIZE_BOX | \ | |
75 | wxMAXIMIZE_BOX | \ | |
76 | wxCLOSE_BOX | \ | |
77 | wxCAPTION | \ | |
78 | wxCLIP_CHILDREN) | |
79 | #endif | |
80 | ||
81 | ||
7d9f12f3 | 82 | // Dialogs are created in a special way |
21f4383a | 83 | #define wxTOPLEVEL_EX_DIALOG 0x00000008 |
7d9f12f3 VS |
84 | |
85 | // Styles for ShowFullScreen | |
86 | // (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and | |
87 | // wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow) | |
b22d16ad VS |
88 | enum |
89 | { | |
90 | wxFULLSCREEN_NOMENUBAR = 0x0001, | |
91 | wxFULLSCREEN_NOTOOLBAR = 0x0002, | |
92 | wxFULLSCREEN_NOSTATUSBAR = 0x0004, | |
93 | wxFULLSCREEN_NOBORDER = 0x0008, | |
94 | wxFULLSCREEN_NOCAPTION = 0x0010, | |
d4597e13 VZ |
95 | |
96 | wxFULLSCREEN_ALL = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR | | |
97 | wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER | | |
b22d16ad VS |
98 | wxFULLSCREEN_NOCAPTION |
99 | }; | |
100 | ||
ec4f95c4 VZ |
101 | // ---------------------------------------------------------------------------- |
102 | // wxTopLevelWindow: a top level (as opposed to child) window | |
103 | // ---------------------------------------------------------------------------- | |
104 | ||
7d9f12f3 | 105 | class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow |
ec4f95c4 VZ |
106 | { |
107 | public: | |
7d9f12f3 VS |
108 | // construction |
109 | wxTopLevelWindowBase(); | |
799ea011 | 110 | virtual ~wxTopLevelWindowBase(); |
b22d16ad | 111 | |
7d9f12f3 VS |
112 | // top level wnd state |
113 | // -------------------- | |
114 | ||
115 | // maximize = TRUE => maximize, otherwise - restore | |
116 | virtual void Maximize(bool maximize = TRUE) = 0; | |
117 | ||
118 | // undo Maximize() or Iconize() | |
119 | virtual void Restore() = 0; | |
120 | ||
121 | // iconize = TRUE => iconize, otherwise - restore | |
122 | virtual void Iconize(bool iconize = TRUE) = 0; | |
123 | ||
124 | // return TRUE if the frame is maximized | |
125 | virtual bool IsMaximized() const = 0; | |
126 | ||
127 | // return TRUE if the frame is iconized | |
128 | virtual bool IsIconized() const = 0; | |
129 | ||
130 | // get the frame icon | |
f618020a MB |
131 | const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); } |
132 | ||
133 | // get the frame icons | |
134 | const wxIconBundle& GetIcons() const { return m_icons; } | |
7d9f12f3 VS |
135 | |
136 | // set the frame icon | |
f618020a MB |
137 | virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); } |
138 | ||
139 | // set the frame icons | |
140 | virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; } | |
7d9f12f3 | 141 | |
c8e8ae85 VS |
142 | // maximize the window to cover entire screen |
143 | virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0; | |
d4597e13 | 144 | |
c8e8ae85 VS |
145 | // return TRUE if the frame is in fullscreen mode |
146 | virtual bool IsFullScreen() const = 0; | |
147 | ||
ec4f95c4 VZ |
148 | /* |
149 | for now we already have them in wxWindow, but this is wrong: these | |
150 | methods really only make sense for wxTopLevelWindow! | |
151 | ||
7d9f12f3 | 152 | virtual void SetTitle(const wxString& title) = 0; |
ec4f95c4 VZ |
153 | virtual wxString GetTitle() const = 0; |
154 | */ | |
7d9f12f3 | 155 | |
1542ea39 RD |
156 | // Set the shape of the window to the given region. |
157 | // Returns TRUE if the platform supports this feature (and the | |
158 | // operation is successful.) | |
fc7a2a60 | 159 | virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return FALSE; } |
1542ea39 | 160 | |
7d9f12f3 VS |
161 | // implementation only from now on |
162 | // ------------------------------- | |
163 | ||
164 | // override some base class virtuals | |
165 | virtual bool Destroy(); | |
166 | virtual bool IsTopLevel() const { return TRUE; } | |
34c3ffca | 167 | virtual wxSize GetMaxSize() const; |
7d9f12f3 VS |
168 | |
169 | // event handlers | |
170 | void OnCloseWindow(wxCloseEvent& event); | |
171 | void OnSize(wxSizeEvent& event); | |
172 | ||
173 | // this should go away, but for now it's called from docview.cpp, | |
174 | // so should be there for all platforms | |
175 | void OnActivate(wxActivateEvent &WXUNUSED(event)) { } | |
176 | ||
e39af974 JS |
177 | // do the window-specific processing after processing the update event |
178 | virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; | |
179 | ||
7d9f12f3 VS |
180 | protected: |
181 | // the frame client to screen translation should take account of the | |
182 | // toolbar which may shift the origin of the client area | |
183 | virtual void DoClientToScreen(int *x, int *y) const; | |
184 | virtual void DoScreenToClient(int *x, int *y) const; | |
185 | ||
1cbee0b4 VZ |
186 | // test whether this window makes part of the frame |
187 | // (menubar, toolbar and statusbar are excluded from automatic layout) | |
188 | virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const | |
189 | { return FALSE; } | |
190 | ||
5c363878 | 191 | // check if we should exit the program after deleting this top level |
1cbee0b4 | 192 | // window (this is used in common dtor and wxMSW code) |
5c363878 | 193 | bool IsLastBeforeExit() const; |
1cbee0b4 | 194 | |
7d9f12f3 VS |
195 | // send the iconize event, return TRUE if processed |
196 | bool SendIconizeEvent(bool iconized = TRUE); | |
197 | ||
66202a7e RD |
198 | // Get the default size for the new window if no explicit size given. If |
199 | // there are better default sizes then these can be changed, just as long | |
0c089c08 VZ |
200 | // as they are not too small for TLWs (and not larger than screen). |
201 | static wxSize GetDefaultSize(); | |
202 | static int WidthDefault(int w) { return w == -1 ? GetDefaultSize().x : w; } | |
203 | static int HeightDefault(int h) { return h == -1 ? GetDefaultSize().y : h; } | |
66202a7e | 204 | |
7d9f12f3 | 205 | // the frame icon |
f618020a | 206 | wxIconBundle m_icons; |
7d9f12f3 | 207 | |
fc7a2a60 | 208 | DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase) |
7d9f12f3 | 209 | DECLARE_EVENT_TABLE() |
ec4f95c4 VZ |
210 | }; |
211 | ||
7d9f12f3 VS |
212 | |
213 | // include the real class declaration | |
82c9f85c VZ |
214 | #if defined(__WXMSW__) |
215 | #include "wx/msw/toplevel.h" | |
216 | #define wxTopLevelWindowNative wxTopLevelWindowMSW | |
217 | #elif defined(__WXGTK__) | |
7d9f12f3 VS |
218 | #include "wx/gtk/toplevel.h" |
219 | #define wxTopLevelWindowNative wxTopLevelWindowGTK | |
83df96d6 JS |
220 | #elif defined(__WXX11__) |
221 | #include "wx/x11/toplevel.h" | |
222 | #define wxTopLevelWindowNative wxTopLevelWindowX11 | |
7d9f12f3 VS |
223 | #elif defined(__WXMGL__) |
224 | #include "wx/mgl/toplevel.h" | |
225 | #define wxTopLevelWindowNative wxTopLevelWindowMGL | |
93b4dc4b SC |
226 | #elif defined(__WXMAC__) |
227 | #include "wx/mac/toplevel.h" | |
228 | #define wxTopLevelWindowNative wxTopLevelWindowMac | |
e64df9bc DE |
229 | #elif defined(__WXCOCOA__) |
230 | #include "wx/cocoa/toplevel.h" | |
231 | #define wxTopLevelWindowNative wxTopLevelWindowCocoa | |
c9782ca3 DW |
232 | #elif defined(__WXPM__) |
233 | #include "wx/os2/toplevel.h" | |
234 | #define wxTopLevelWindowNative wxTopLevelWindowOS2 | |
798a4529 MB |
235 | #elif defined(__WXMOTIF__) |
236 | #include "wx/motif/toplevel.h" | |
237 | #define wxTopLevelWindowNative wxTopLevelWindowMotif | |
7d9f12f3 VS |
238 | #endif |
239 | ||
240 | #ifdef __WXUNIVERSAL__ | |
241 | #include "wx/univ/toplevel.h" | |
242 | #else // !__WXUNIVERSAL__ | |
243 | #ifdef wxTopLevelWindowNative | |
244 | class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative | |
245 | { | |
246 | public: | |
247 | // construction | |
248 | wxTopLevelWindow() { Init(); } | |
249 | wxTopLevelWindow(wxWindow *parent, | |
d9e2e4c2 | 250 | wxWindowID winid, |
7d9f12f3 VS |
251 | const wxString& title, |
252 | const wxPoint& pos = wxDefaultPosition, | |
253 | const wxSize& size = wxDefaultSize, | |
254 | long style = wxDEFAULT_FRAME_STYLE, | |
255 | const wxString& name = wxFrameNameStr) | |
256 | { | |
257 | Init(); | |
d9e2e4c2 | 258 | Create(parent, winid, title, pos, size, style, name); |
7d9f12f3 VS |
259 | } |
260 | ||
fc7a2a60 | 261 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow) |
7d9f12f3 VS |
262 | }; |
263 | #endif // wxTopLevelWindowNative | |
264 | #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__ | |
265 | ||
266 | ||
267 | #endif // _WX_TOPLEVEL_BASE_H_ |