]> git.saurik.com Git - wxWidgets.git/blame - include/wx/toplevel.h
Remove a(nother) guaranteed build failure until what is it testing
[wxWidgets.git] / include / wx / toplevel.h
CommitLineData
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
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
29WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
30
31class 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
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
74 #define wxDEFAULT_FRAME_STYLE (0)
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
94enum
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
108enum
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 118class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
ec4f95c4
VZ
119{
120public:
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
cb719f2e 140 // return true if the frame is iconized
7d9f12f3
VS
141 virtual bool IsIconized() const = 0;
142
143 // get the frame icon
f618020a
MB
144 const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
145
146 // get the frame icons
147 const wxIconBundle& GetIcons() const { return m_icons; }
7d9f12f3
VS
148
149 // set the frame icon
f618020a
MB
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; }
7d9f12f3 154
c8e8ae85
VS
155 // maximize the window to cover entire screen
156 virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
d4597e13 157
cb719f2e 158 // return true if the frame is in fullscreen mode
c8e8ae85
VS
159 virtual bool IsFullScreen() const = 0;
160
ec4f95c4
VZ
161 /*
162 for now we already have them in wxWindow, but this is wrong: these
163 methods really only make sense for wxTopLevelWindow!
164
7d9f12f3 165 virtual void SetTitle(const wxString& title) = 0;
ec4f95c4
VZ
166 virtual wxString GetTitle() const = 0;
167 */
7d9f12f3 168
1542ea39 169 // Set the shape of the window to the given region.
cb719f2e 170 // Returns true if the platform supports this feature (and the
1542ea39 171 // operation is successful.)
cb719f2e 172 virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }
1542ea39 173
dc92adaf
VZ
174 // Attracts the users attention to this window if the application is
175 // inactive (should be called when a background event occurs)
176 virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
9b141468 177
35ff90a0 178 // Is this the active frame (highlighted in the taskbar)?
6b30a44e 179 virtual bool IsActive()
35ff90a0 180 { return (wxGetTopLevelParent(FindFocus()) == this); }
dc92adaf 181
9b141468
WS
182#if defined(__SMARTPHONE__)
183 virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
184 virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
185#endif // __SMARTPHONE__
186
7d9f12f3
VS
187 // implementation only from now on
188 // -------------------------------
189
190 // override some base class virtuals
191 virtual bool Destroy();
cb719f2e 192 virtual bool IsTopLevel() const { return true; }
34c3ffca 193 virtual wxSize GetMaxSize() const;
7d9f12f3
VS
194
195 // event handlers
196 void OnCloseWindow(wxCloseEvent& event);
5e62d4a5 197 void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
7d9f12f3
VS
198
199 // this should go away, but for now it's called from docview.cpp,
200 // so should be there for all platforms
201 void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
202
e39af974
JS
203 // do the window-specific processing after processing the update event
204 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
205
7d9f12f3
VS
206protected:
207 // the frame client to screen translation should take account of the
208 // toolbar which may shift the origin of the client area
209 virtual void DoClientToScreen(int *x, int *y) const;
210 virtual void DoScreenToClient(int *x, int *y) const;
211
1cbee0b4
VZ
212 // test whether this window makes part of the frame
213 // (menubar, toolbar and statusbar are excluded from automatic layout)
214 virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
cb719f2e 215 { return false; }
1cbee0b4 216
5c363878 217 // check if we should exit the program after deleting this top level
1cbee0b4 218 // window (this is used in common dtor and wxMSW code)
5c363878 219 bool IsLastBeforeExit() const;
1cbee0b4 220
cb719f2e
WS
221 // send the iconize event, return true if processed
222 bool SendIconizeEvent(bool iconized = true);
7d9f12f3 223
5e62d4a5
VZ
224 // do TLW-specific layout: we resize our unique child to fill the entire
225 // client area
226 void DoLayout();
227
66202a7e
RD
228 // Get the default size for the new window if no explicit size given. If
229 // there are better default sizes then these can be changed, just as long
0c089c08
VZ
230 // as they are not too small for TLWs (and not larger than screen).
231 static wxSize GetDefaultSize();
cb719f2e
WS
232 static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
233 static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }
66202a7e 234
7d9f12f3 235 // the frame icon
f618020a 236 wxIconBundle m_icons;
7d9f12f3 237
fc7a2a60 238 DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
7d9f12f3 239 DECLARE_EVENT_TABLE()
ec4f95c4
VZ
240};
241
7d9f12f3
VS
242
243// include the real class declaration
ffecfa5a
JS
244#if defined(__PALMOS__)
245 #include "wx/palmos/toplevel.h"
246 #define wxTopLevelWindowNative wxTopLevelWindowPalm
247#elif defined(__WXMSW__)
82c9f85c
VZ
248 #include "wx/msw/toplevel.h"
249 #define wxTopLevelWindowNative wxTopLevelWindowMSW
250#elif defined(__WXGTK__)
7d9f12f3
VS
251 #include "wx/gtk/toplevel.h"
252 #define wxTopLevelWindowNative wxTopLevelWindowGTK
83df96d6
JS
253#elif defined(__WXX11__)
254 #include "wx/x11/toplevel.h"
255 #define wxTopLevelWindowNative wxTopLevelWindowX11
7d9f12f3
VS
256#elif defined(__WXMGL__)
257 #include "wx/mgl/toplevel.h"
258 #define wxTopLevelWindowNative wxTopLevelWindowMGL
93b4dc4b
SC
259#elif defined(__WXMAC__)
260 #include "wx/mac/toplevel.h"
261 #define wxTopLevelWindowNative wxTopLevelWindowMac
e64df9bc
DE
262#elif defined(__WXCOCOA__)
263 #include "wx/cocoa/toplevel.h"
264 #define wxTopLevelWindowNative wxTopLevelWindowCocoa
c9782ca3
DW
265#elif defined(__WXPM__)
266 #include "wx/os2/toplevel.h"
267 #define wxTopLevelWindowNative wxTopLevelWindowOS2
798a4529
MB
268#elif defined(__WXMOTIF__)
269 #include "wx/motif/toplevel.h"
270 #define wxTopLevelWindowNative wxTopLevelWindowMotif
7d9f12f3
VS
271#endif
272
273#ifdef __WXUNIVERSAL__
274 #include "wx/univ/toplevel.h"
275#else // !__WXUNIVERSAL__
276 #ifdef wxTopLevelWindowNative
277 class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
278 {
279 public:
280 // construction
281 wxTopLevelWindow() { Init(); }
282 wxTopLevelWindow(wxWindow *parent,
d9e2e4c2 283 wxWindowID winid,
7d9f12f3
VS
284 const wxString& title,
285 const wxPoint& pos = wxDefaultPosition,
286 const wxSize& size = wxDefaultSize,
287 long style = wxDEFAULT_FRAME_STYLE,
288 const wxString& name = wxFrameNameStr)
289 {
290 Init();
d9e2e4c2 291 Create(parent, winid, title, pos, size, style, name);
7d9f12f3
VS
292 }
293
fc7a2a60 294 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)
7d9f12f3
VS
295 };
296 #endif // wxTopLevelWindowNative
297#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
298
299
300#endif // _WX_TOPLEVEL_BASE_H_