]> git.saurik.com Git - wxWidgets.git/blob - include/wx/toplevel.h
added another AddPane() call which allows the caller to add a new window at a certain...
[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 always maximized
141 // due to native guidelines or current policy
142 virtual bool IsAlwaysMaximized() const;
143
144 // return true if the frame is iconized
145 virtual bool IsIconized() const = 0;
146
147 // get the frame icon
148 const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
149
150 // get the frame icons
151 const wxIconBundle& GetIcons() const { return m_icons; }
152
153 // set the frame icon
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; }
158
159 // maximize the window to cover entire screen
160 virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
161
162 // return true if the frame is in fullscreen mode
163 virtual bool IsFullScreen() const = 0;
164
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
167 virtual void SetTitle(const wxString& title) = 0;
168 virtual wxString GetTitle() const = 0;
169
170 // Set the shape of the window to the given region.
171 // Returns true if the platform supports this feature (and the
172 // operation is successful.)
173 virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }
174
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);
178
179 // Is this the active frame (highlighted in the taskbar)?
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
189
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
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
199 // Set window transparency if the platform supports it
200 virtual bool SetTranslucency(int WXUNUSED(alpha)) { return false; }
201 virtual bool CanSetTranslucency() { return false; }
202
203
204 // implementation only from now on
205 // -------------------------------
206
207 // override some base class virtuals
208 virtual bool Destroy();
209 virtual bool IsTopLevel() const { return true; }
210 virtual wxSize GetMaxSize() const;
211
212 // event handlers
213 void OnCloseWindow(wxCloseEvent& event);
214 void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
215
216 // Get rect to be used to center top-level children
217 virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h);
218
219 // this should go away, but for now it's called from docview.cpp,
220 // so should be there for all platforms
221 void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
222
223 // do the window-specific processing after processing the update event
224 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
225
226 protected:
227 // the frame client to screen translation should take account of the
228 // toolbar which may shift the origin of the client area
229 virtual void DoClientToScreen(int *x, int *y) const;
230 virtual void DoScreenToClient(int *x, int *y) const;
231
232 // add support for wxCENTRE_ON_SCREEN
233 virtual void DoCentre(int dir);
234
235 // no need to do client to screen translation to get our position in screen
236 // coordinates: this is already the case
237 virtual void DoGetScreenPosition(int *x, int *y) const
238 {
239 DoGetPosition(x, y);
240 }
241
242 // test whether this window makes part of the frame
243 // (menubar, toolbar and statusbar are excluded from automatic layout)
244 virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
245 { return false; }
246
247 // check if we should exit the program after deleting this window
248 bool IsLastBeforeExit() const;
249
250 // send the iconize event, return true if processed
251 bool SendIconizeEvent(bool iconized = true);
252
253 // do TLW-specific layout: we resize our unique child to fill the entire
254 // client area
255 void DoLayout();
256
257 // Get the default size for the new window if no explicit size given. If
258 // there are better default sizes then these can be changed, just as long
259 // as they are not too small for TLWs (and not larger than screen).
260 static wxSize GetDefaultSize();
261 static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
262 static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }
263
264 // the frame icon
265 wxIconBundle m_icons;
266
267 DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
268 DECLARE_EVENT_TABLE()
269 };
270
271
272 // include the real class declaration
273 #if defined(__WXPALMOS__)
274 #include "wx/palmos/toplevel.h"
275 #define wxTopLevelWindowNative wxTopLevelWindowPalm
276 #elif defined(__WXMSW__)
277 #include "wx/msw/toplevel.h"
278 #define wxTopLevelWindowNative wxTopLevelWindowMSW
279 #elif defined(__WXGTK20__)
280 #include "wx/gtk/toplevel.h"
281 #define wxTopLevelWindowNative wxTopLevelWindowGTK
282 #elif defined(__WXGTK__)
283 #include "wx/gtk1/toplevel.h"
284 #define wxTopLevelWindowNative wxTopLevelWindowGTK
285 #elif defined(__WXX11__)
286 #include "wx/x11/toplevel.h"
287 #define wxTopLevelWindowNative wxTopLevelWindowX11
288 #elif defined(__WXMGL__)
289 #include "wx/mgl/toplevel.h"
290 #define wxTopLevelWindowNative wxTopLevelWindowMGL
291 #elif defined(__WXMAC__)
292 #include "wx/mac/toplevel.h"
293 #define wxTopLevelWindowNative wxTopLevelWindowMac
294 #elif defined(__WXCOCOA__)
295 #include "wx/cocoa/toplevel.h"
296 #define wxTopLevelWindowNative wxTopLevelWindowCocoa
297 #elif defined(__WXPM__)
298 #include "wx/os2/toplevel.h"
299 #define wxTopLevelWindowNative wxTopLevelWindowOS2
300 #elif defined(__WXMOTIF__)
301 #include "wx/motif/toplevel.h"
302 #define wxTopLevelWindowNative wxTopLevelWindowMotif
303 #endif
304
305 #ifdef __WXUNIVERSAL__
306 #include "wx/univ/toplevel.h"
307 #else // !__WXUNIVERSAL__
308 #ifdef wxTopLevelWindowNative
309 class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
310 {
311 public:
312 // construction
313 wxTopLevelWindow() { Init(); }
314 wxTopLevelWindow(wxWindow *parent,
315 wxWindowID winid,
316 const wxString& title,
317 const wxPoint& pos = wxDefaultPosition,
318 const wxSize& size = wxDefaultSize,
319 long style = wxDEFAULT_FRAME_STYLE,
320 const wxString& name = wxFrameNameStr)
321 {
322 Init();
323 Create(parent, winid, title, pos, size, style, name);
324 }
325
326 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)
327 };
328 #endif // wxTopLevelWindowNative
329 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
330
331
332 #endif // _WX_TOPLEVEL_BASE_H_