1 ///////////////////////////////////////////////////////////////////////////////
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
9 // Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Vaclav Slavik <vaclav@wxwidgets.org>
11 // Licence: wxWindows licence
12 ///////////////////////////////////////////////////////////////////////////////
14 #ifndef _WX_TOPLEVEL_BASE_H_
15 #define _WX_TOPLEVEL_BASE_H_
17 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
18 #pragma interface "toplevelbase.h"
21 // ----------------------------------------------------------------------------
23 // ----------------------------------------------------------------------------
25 #include "wx/window.h"
26 #include "wx/iconbndl.h"
28 // the default names for various classs
29 extern WXDLLEXPORT_DATA(const wxChar
*) wxFrameNameStr
;
31 class WXDLLEXPORT wxTopLevelWindowBase
;
33 // ----------------------------------------------------------------------------
35 // ----------------------------------------------------------------------------
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
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
51 // deprecated versions defined for compatibility reasons
52 #define wxRESIZE_BOX wxMAXIMIZE_BOX
53 #define wxTHICK_FRAME wxRESIZE_BORDER
55 // obsolete styles, unused any more
56 #define wxDIALOG_MODAL 0
57 #define wxDIALOG_MODELESS 0
59 #define wxUSER_COLOURS 0
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)
74 #define wxDEFAULT_FRAME_STYLE (wxNO_BORDER)
77 #define wxDEFAULT_FRAME_STYLE \
88 // Dialogs are created in a special way
89 #define wxTOPLEVEL_EX_DIALOG 0x00000008
91 // Styles for ShowFullScreen
92 // (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and
93 // wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow)
96 wxFULLSCREEN_NOMENUBAR
= 0x0001,
97 wxFULLSCREEN_NOTOOLBAR
= 0x0002,
98 wxFULLSCREEN_NOSTATUSBAR
= 0x0004,
99 wxFULLSCREEN_NOBORDER
= 0x0008,
100 wxFULLSCREEN_NOCAPTION
= 0x0010,
102 wxFULLSCREEN_ALL
= wxFULLSCREEN_NOMENUBAR
| wxFULLSCREEN_NOTOOLBAR
|
103 wxFULLSCREEN_NOSTATUSBAR
| wxFULLSCREEN_NOBORDER
|
104 wxFULLSCREEN_NOCAPTION
107 // Styles for RequestUserAttention
110 wxUSER_ATTENTION_INFO
= 1,
111 wxUSER_ATTENTION_ERROR
= 2
114 // ----------------------------------------------------------------------------
115 // wxTopLevelWindow: a top level (as opposed to child) window
116 // ----------------------------------------------------------------------------
118 class WXDLLEXPORT wxTopLevelWindowBase
: public wxWindow
122 wxTopLevelWindowBase();
123 virtual ~wxTopLevelWindowBase();
125 // top level wnd state
126 // --------------------
128 // maximize = true => maximize, otherwise - restore
129 virtual void Maximize(bool maximize
= true) = 0;
131 // undo Maximize() or Iconize()
132 virtual void Restore() = 0;
134 // iconize = true => iconize, otherwise - restore
135 virtual void Iconize(bool iconize
= true) = 0;
137 // return true if the frame is maximized
138 virtual bool IsMaximized() const = 0;
140 // return true if the frame is iconized
141 virtual bool IsIconized() const = 0;
143 // get the frame icon
144 const wxIcon
& GetIcon() const { return m_icons
.GetIcon( -1 ); }
146 // get the frame icons
147 const wxIconBundle
& GetIcons() const { return m_icons
; }
149 // set the frame icon
150 virtual void SetIcon(const wxIcon
& icon
) { m_icons
= wxIconBundle( icon
); }
152 // set the frame icons
153 virtual void SetIcons(const wxIconBundle
& icons
) { m_icons
= icons
; }
155 // maximize the window to cover entire screen
156 virtual bool ShowFullScreen(bool show
, long style
= wxFULLSCREEN_ALL
) = 0;
158 // return true if the frame is in fullscreen mode
159 virtual bool IsFullScreen() const = 0;
162 for now we already have them in wxWindow, but this is wrong: these
163 methods really only make sense for wxTopLevelWindow!
165 virtual void SetTitle(const wxString& title) = 0;
166 virtual wxString GetTitle() const = 0;
169 // Set the shape of the window to the given region.
170 // Returns true if the platform supports this feature (and the
171 // operation is successful.)
172 virtual bool SetShape(const wxRegion
& WXUNUSED(region
)) { return false; }
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
);
178 // Is this the active frame (highlighted in the taskbar)?
179 virtual bool IsActive()
180 { return (wxGetTopLevelParent(FindFocus()) == this); }
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__
187 // implementation only from now on
188 // -------------------------------
190 // override some base class virtuals
191 virtual bool Destroy();
192 virtual bool IsTopLevel() const { return true; }
193 virtual wxSize
GetMaxSize() const;
196 void OnCloseWindow(wxCloseEvent
& event
);
197 void OnSize(wxSizeEvent
& WXUNUSED(event
)) { DoLayout(); }
199 // Get rect to be used to center top-level children
200 virtual void GetRectForTopLevelChildren(int *x
, int *y
, int *w
, int *h
);
202 // this should go away, but for now it's called from docview.cpp,
203 // so should be there for all platforms
204 void OnActivate(wxActivateEvent
&WXUNUSED(event
)) { }
206 // do the window-specific processing after processing the update event
207 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
) ;
209 // Reserved for future use
210 virtual void ReservedTopLevelWindowFunc1() {}
211 virtual void ReservedTopLevelWindowFunc2() {}
212 virtual void ReservedTopLevelWindowFunc3() {}
213 virtual void ReservedTopLevelWindowFunc4() {}
214 virtual void ReservedTopLevelWindowFunc5() {}
215 virtual void ReservedTopLevelWindowFunc6() {}
216 virtual void ReservedTopLevelWindowFunc7() {}
217 virtual void ReservedTopLevelWindowFunc8() {}
218 virtual void ReservedTopLevelWindowFunc9() {}
221 // the frame client to screen translation should take account of the
222 // toolbar which may shift the origin of the client area
223 virtual void DoClientToScreen(int *x
, int *y
) const;
224 virtual void DoScreenToClient(int *x
, int *y
) const;
226 // test whether this window makes part of the frame
227 // (menubar, toolbar and statusbar are excluded from automatic layout)
228 virtual bool IsOneOfBars(const wxWindow
*WXUNUSED(win
)) const
231 // check if we should exit the program after deleting this top level
232 // window (this is used in common dtor and wxMSW code)
233 bool IsLastBeforeExit() const;
235 // send the iconize event, return true if processed
236 bool SendIconizeEvent(bool iconized
= true);
238 // do TLW-specific layout: we resize our unique child to fill the entire
242 // Get the default size for the new window if no explicit size given. If
243 // there are better default sizes then these can be changed, just as long
244 // as they are not too small for TLWs (and not larger than screen).
245 static wxSize
GetDefaultSize();
246 static int WidthDefault(int w
) { return w
== wxDefaultCoord
? GetDefaultSize().x
: w
; }
247 static int HeightDefault(int h
) { return h
== wxDefaultCoord
? GetDefaultSize().y
: h
; }
250 wxIconBundle m_icons
;
252 DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase
)
253 DECLARE_EVENT_TABLE()
257 // include the real class declaration
258 #if defined(__WXPALMOS__)
259 #include "wx/palmos/toplevel.h"
260 #define wxTopLevelWindowNative wxTopLevelWindowPalm
261 #elif defined(__WXMSW__)
262 #include "wx/msw/toplevel.h"
263 #define wxTopLevelWindowNative wxTopLevelWindowMSW
264 #elif defined(__WXGTK__)
265 #include "wx/gtk/toplevel.h"
266 #define wxTopLevelWindowNative wxTopLevelWindowGTK
267 #elif defined(__WXX11__)
268 #include "wx/x11/toplevel.h"
269 #define wxTopLevelWindowNative wxTopLevelWindowX11
270 #elif defined(__WXMGL__)
271 #include "wx/mgl/toplevel.h"
272 #define wxTopLevelWindowNative wxTopLevelWindowMGL
273 #elif defined(__WXMAC__)
274 #include "wx/mac/toplevel.h"
275 #define wxTopLevelWindowNative wxTopLevelWindowMac
276 #elif defined(__WXCOCOA__)
277 #include "wx/cocoa/toplevel.h"
278 #define wxTopLevelWindowNative wxTopLevelWindowCocoa
279 #elif defined(__WXPM__)
280 #include "wx/os2/toplevel.h"
281 #define wxTopLevelWindowNative wxTopLevelWindowOS2
282 #elif defined(__WXMOTIF__)
283 #include "wx/motif/toplevel.h"
284 #define wxTopLevelWindowNative wxTopLevelWindowMotif
287 #ifdef __WXUNIVERSAL__
288 #include "wx/univ/toplevel.h"
289 #else // !__WXUNIVERSAL__
290 #ifdef wxTopLevelWindowNative
291 class WXDLLEXPORT wxTopLevelWindow
: public wxTopLevelWindowNative
295 wxTopLevelWindow() { Init(); }
296 wxTopLevelWindow(wxWindow
*parent
,
298 const wxString
& title
,
299 const wxPoint
& pos
= wxDefaultPosition
,
300 const wxSize
& size
= wxDefaultSize
,
301 long style
= wxDEFAULT_FRAME_STYLE
,
302 const wxString
& name
= wxFrameNameStr
)
305 Create(parent
, winid
, title
, pos
, size
, style
, name
);
308 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow
)
310 #endif // wxTopLevelWindowNative
311 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
314 #endif // _WX_TOPLEVEL_BASE_H_