]> git.saurik.com Git - wxWidgets.git/blame - include/wx/toplevel.h
Added simplistic makefile/project files for wxWinCE.
[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>
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
af49c4b8
GD
17#if defined(__GNUG__) && !defined(__APPLE__)
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
7d9f12f3 37// Dialogs are created in a special way
21f4383a 38#define wxTOPLEVEL_EX_DIALOG 0x00000008
7d9f12f3
VS
39
40// Styles for ShowFullScreen
41// (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and
42// wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow)
b22d16ad
VS
43enum
44{
45 wxFULLSCREEN_NOMENUBAR = 0x0001,
46 wxFULLSCREEN_NOTOOLBAR = 0x0002,
47 wxFULLSCREEN_NOSTATUSBAR = 0x0004,
48 wxFULLSCREEN_NOBORDER = 0x0008,
49 wxFULLSCREEN_NOCAPTION = 0x0010,
d4597e13
VZ
50
51 wxFULLSCREEN_ALL = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
52 wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |
b22d16ad
VS
53 wxFULLSCREEN_NOCAPTION
54};
55
ec4f95c4
VZ
56// ----------------------------------------------------------------------------
57// wxTopLevelWindow: a top level (as opposed to child) window
58// ----------------------------------------------------------------------------
59
7d9f12f3 60class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
ec4f95c4
VZ
61{
62public:
7d9f12f3
VS
63 // construction
64 wxTopLevelWindowBase();
799ea011 65 virtual ~wxTopLevelWindowBase();
b22d16ad 66
7d9f12f3
VS
67 // top level wnd state
68 // --------------------
69
70 // maximize = TRUE => maximize, otherwise - restore
71 virtual void Maximize(bool maximize = TRUE) = 0;
72
73 // undo Maximize() or Iconize()
74 virtual void Restore() = 0;
75
76 // iconize = TRUE => iconize, otherwise - restore
77 virtual void Iconize(bool iconize = TRUE) = 0;
78
79 // return TRUE if the frame is maximized
80 virtual bool IsMaximized() const = 0;
81
82 // return TRUE if the frame is iconized
83 virtual bool IsIconized() const = 0;
84
85 // get the frame icon
f618020a
MB
86 const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
87
88 // get the frame icons
89 const wxIconBundle& GetIcons() const { return m_icons; }
7d9f12f3
VS
90
91 // set the frame icon
f618020a
MB
92 virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
93
94 // set the frame icons
95 virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }
7d9f12f3 96
c8e8ae85
VS
97 // maximize the window to cover entire screen
98 virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
d4597e13 99
c8e8ae85
VS
100 // return TRUE if the frame is in fullscreen mode
101 virtual bool IsFullScreen() const = 0;
102
ec4f95c4
VZ
103 /*
104 for now we already have them in wxWindow, but this is wrong: these
105 methods really only make sense for wxTopLevelWindow!
106
7d9f12f3 107 virtual void SetTitle(const wxString& title) = 0;
ec4f95c4
VZ
108 virtual wxString GetTitle() const = 0;
109 */
7d9f12f3
VS
110
111 // old functions, use the new ones instead!
112#if WXWIN_COMPATIBILITY_2
113 bool Iconized() const { return IsIconized(); }
114#endif // WXWIN_COMPATIBILITY_2
115
116 // implementation only from now on
117 // -------------------------------
118
119 // override some base class virtuals
120 virtual bool Destroy();
121 virtual bool IsTopLevel() const { return TRUE; }
34c3ffca 122 virtual wxSize GetMaxSize() const;
7d9f12f3
VS
123
124 // event handlers
125 void OnCloseWindow(wxCloseEvent& event);
126 void OnSize(wxSizeEvent& event);
127
128 // this should go away, but for now it's called from docview.cpp,
129 // so should be there for all platforms
130 void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
131
132protected:
133 // the frame client to screen translation should take account of the
134 // toolbar which may shift the origin of the client area
135 virtual void DoClientToScreen(int *x, int *y) const;
136 virtual void DoScreenToClient(int *x, int *y) const;
137
1cbee0b4
VZ
138 // test whether this window makes part of the frame
139 // (menubar, toolbar and statusbar are excluded from automatic layout)
140 virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
141 { return FALSE; }
142
5c363878 143 // check if we should exit the program after deleting this top level
1cbee0b4 144 // window (this is used in common dtor and wxMSW code)
5c363878 145 bool IsLastBeforeExit() const;
1cbee0b4 146
7d9f12f3
VS
147 // send the iconize event, return TRUE if processed
148 bool SendIconizeEvent(bool iconized = TRUE);
149
150 // the frame icon
f618020a 151 wxIconBundle m_icons;
7d9f12f3 152
7d9f12f3 153 DECLARE_EVENT_TABLE()
ec4f95c4
VZ
154};
155
7d9f12f3
VS
156
157// include the real class declaration
82c9f85c
VZ
158#if defined(__WXMSW__)
159 #include "wx/msw/toplevel.h"
160 #define wxTopLevelWindowNative wxTopLevelWindowMSW
161#elif defined(__WXGTK__)
7d9f12f3
VS
162 #include "wx/gtk/toplevel.h"
163 #define wxTopLevelWindowNative wxTopLevelWindowGTK
83df96d6
JS
164#elif defined(__WXX11__)
165 #include "wx/x11/toplevel.h"
166 #define wxTopLevelWindowNative wxTopLevelWindowX11
7d9f12f3
VS
167#elif defined(__WXMGL__)
168 #include "wx/mgl/toplevel.h"
169 #define wxTopLevelWindowNative wxTopLevelWindowMGL
93b4dc4b
SC
170#elif defined(__WXMAC__)
171 #include "wx/mac/toplevel.h"
172 #define wxTopLevelWindowNative wxTopLevelWindowMac
c9782ca3
DW
173#elif defined(__WXPM__)
174 #include "wx/os2/toplevel.h"
175 #define wxTopLevelWindowNative wxTopLevelWindowOS2
7d9f12f3
VS
176#endif
177
178#ifdef __WXUNIVERSAL__
179 #include "wx/univ/toplevel.h"
180#else // !__WXUNIVERSAL__
181 #ifdef wxTopLevelWindowNative
182 class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
183 {
184 public:
185 // construction
186 wxTopLevelWindow() { Init(); }
187 wxTopLevelWindow(wxWindow *parent,
188 wxWindowID id,
189 const wxString& title,
190 const wxPoint& pos = wxDefaultPosition,
191 const wxSize& size = wxDefaultSize,
192 long style = wxDEFAULT_FRAME_STYLE,
193 const wxString& name = wxFrameNameStr)
194 {
195 Init();
196 Create(parent, id, title, pos, size, style, name);
197 }
198
199 DECLARE_DYNAMIC_CLASS(wxTopLevelWindow)
200 };
201 #endif // wxTopLevelWindowNative
202#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
203
204
205#endif // _WX_TOPLEVEL_BASE_H_
34c3ffca
RL
206
207// vi:sts=4:sw=4:et