avoid a bug in Carbon headers
[wxWidgets.git] / include / wx / frame.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/frame.h
3 // Purpose: wxFrame class interface
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 15.11.99
7 // RCS-ID: $Id$
8 // Copyright: (c) wxWindows team
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_FRAME_H_BASE_
13 #define _WX_FRAME_H_BASE_
14
15 // ----------------------------------------------------------------------------
16 // headers
17 // ----------------------------------------------------------------------------
18
19 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
20 #pragma interface "framebase.h"
21 #endif
22
23 #include "wx/toplevel.h" // the base class
24
25 // the default names for various classs
26 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
27 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
28 WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
29
30 class WXDLLEXPORT wxFrame;
31 class WXDLLEXPORT wxMenuBar;
32 class WXDLLEXPORT wxStatusBar;
33 class WXDLLEXPORT wxToolBar;
34
35 // ----------------------------------------------------------------------------
36 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
37 //
38 // For each of *bars, a frame may have several of them, but only one is
39 // managed by the frame, i.e. resized/moved when the frame is and whose size
40 // is accounted for in client size calculations - all others should be taken
41 // care of manually. The CreateXXXBar() functions create this, main, XXXBar,
42 // but the actual creation is done in OnCreateXXXBar() functions which may be
43 // overridden to create custom objects instead of standard ones when
44 // CreateXXXBar() is called.
45 // ----------------------------------------------------------------------------
46
47 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
48 {
49 public:
50 // construction
51 wxFrameBase();
52 virtual ~wxFrameBase();
53
54 wxFrame *New(wxWindow *parent,
55 wxWindowID winid,
56 const wxString& title,
57 const wxPoint& pos = wxDefaultPosition,
58 const wxSize& size = wxDefaultSize,
59 long style = wxDEFAULT_FRAME_STYLE,
60 const wxString& name = wxFrameNameStr);
61
62 // frame state
63 // -----------
64
65 // get the origin of the client area (which may be different from (0, 0)
66 // if the frame has a toolbar) in client coordinates
67 virtual wxPoint GetClientAreaOrigin() const;
68
69 // sends a size event to the window using its current size -- this has an
70 // effect of refreshing the window layout
71 //
72 // currently it is only implemented under MSW but is declared here to make
73 // it possible to call it in portable code without using #ifdef's
74 virtual void SendSizeEvent() { }
75
76 // menu bar functions
77 // ------------------
78
79 #if wxUSE_MENUS
80 virtual void SetMenuBar(wxMenuBar *menubar);
81 virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
82 #endif // wxUSE_MENUS
83
84 #ifdef WXWIN_COMPATIBILITY_2_2
85 // call this to simulate a menu command
86 bool Command(int winid) { return ProcessCommand(winid); }
87 #endif // WXWIN_COMPATIBILITY_2_2
88
89 // process menu command: returns TRUE if processed
90 bool ProcessCommand(int winid);
91
92 // status bar functions
93 // --------------------
94 #if wxUSE_STATUSBAR
95 // create the main status bar by calling OnCreateStatusBar()
96 virtual wxStatusBar* CreateStatusBar(int number = 1,
97 long style = wxST_SIZEGRIP,
98 wxWindowID winid = 0,
99 const wxString& name =
100 wxStatusLineNameStr);
101 // return a new status bar
102 virtual wxStatusBar *OnCreateStatusBar(int number,
103 long style,
104 wxWindowID winid,
105 const wxString& name);
106 // get the main status bar
107 virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
108
109 // sets the main status bar
110 void SetStatusBar(wxStatusBar *statBar) { m_frameStatusBar = statBar; }
111
112 // forward these to status bar
113 virtual void SetStatusText(const wxString &text, int number = 0);
114 virtual void SetStatusWidths(int n, const int widths_field[]);
115 void PushStatusText(const wxString &text, int number = 0);
116 void PopStatusText(int number = 0);
117
118 // set the status bar pane the help will be shown in
119 void SetStatusBarPane(int n) { m_statusBarPane = n; }
120 int GetStatusBarPane() const { return m_statusBarPane; }
121 #endif // wxUSE_STATUSBAR
122
123 // toolbar functions
124 // -----------------
125
126 #if wxUSE_TOOLBAR
127 // create main toolbar bycalling OnCreateToolBar()
128 virtual wxToolBar* CreateToolBar(long style = -1,
129 wxWindowID winid = -1,
130 const wxString& name = wxToolBarNameStr);
131 // return a new toolbar
132 virtual wxToolBar *OnCreateToolBar(long style,
133 wxWindowID winid,
134 const wxString& name );
135
136 // get/set the main toolbar
137 virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
138 virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
139 #endif // wxUSE_TOOLBAR
140
141 // implementation only from now on
142 // -------------------------------
143
144 // event handlers
145 void OnMenuOpen(wxMenuEvent& event);
146 void OnMenuHighlight(wxMenuEvent& event);
147
148 #if wxUSE_MENUS
149 // send wxUpdateUIEvents for all menu items in the menubar,
150 // or just for menu if non-NULL
151 void DoMenuUpdates(wxMenu* menu = NULL);
152 #endif // wxUSE_MENUS
153
154 // do the UI update processing for this window
155 virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
156
157 // Implement internal behaviour (menu updating on some platforms)
158 virtual void OnInternalIdle();
159
160 // if there is no real wxTopLevelWindow on this platform we have to define
161 // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
162 // old ports (wxMotif) which don't define them in wxFrame
163 #ifndef wxTopLevelWindowNative
164 virtual bool ShowFullScreen(bool WXUNUSED(show),
165 long WXUNUSED(style) = wxFULLSCREEN_ALL)
166 { return FALSE; }
167 virtual bool IsFullScreen() const
168 { return FALSE; }
169 #endif // no wxTopLevelWindowNative
170
171 // show help text (typically in the statusbar); show is FALSE
172 // if you are hiding the help, TRUE otherwise
173 virtual void DoGiveHelp(const wxString& text, bool show);
174
175 protected:
176 // the frame main menu/status/tool bars
177 // ------------------------------------
178
179 // this (non virtual!) function should be called from dtor to delete the
180 // main menubar, statusbar and toolbar (if any)
181 void DeleteAllBars();
182
183 // test whether this window makes part of the frame
184 virtual bool IsOneOfBars(const wxWindow *win) const;
185
186 #if wxUSE_MENUS
187 // override to update menu bar position when the frame size changes
188 virtual void PositionMenuBar() { }
189
190 // override to do something special when the menu bar is being removed
191 // from the frame
192 virtual void DetachMenuBar();
193
194 // override to do something special when the menu bar is attached to the
195 // frame
196 virtual void AttachMenuBar(wxMenuBar *menubar);
197
198 wxMenuBar *m_frameMenuBar;
199 #endif // wxUSE_MENUS
200
201 #if wxUSE_STATUSBAR
202 // override to update status bar position (or anything else) when
203 // something changes
204 virtual void PositionStatusBar() { }
205
206 // show the help string for this menu item in the given status bar: the
207 // status bar pointer can be NULL; return TRUE if help was shown
208 bool ShowMenuHelp(wxStatusBar *statbar, int helpid);
209
210 wxStatusBar *m_frameStatusBar;
211 #endif // wxUSE_STATUSBAR
212
213
214 int m_statusBarPane;
215
216 #if wxUSE_TOOLBAR
217 // override to update status bar position (or anything else) when
218 // something changes
219 virtual void PositionToolBar() { }
220
221 wxToolBar *m_frameToolBar;
222 #endif // wxUSE_TOOLBAR
223
224 DECLARE_EVENT_TABLE()
225 DECLARE_NO_COPY_CLASS(wxFrameBase)
226 };
227
228 // include the real class declaration
229 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
230 #include "wx/univ/frame.h"
231 #else // !__WXUNIVERSAL__
232 #if defined(__WXMSW__)
233 #include "wx/msw/frame.h"
234 #elif defined(__WXGTK__)
235 #include "wx/gtk/frame.h"
236 #elif defined(__WXMOTIF__)
237 #include "wx/motif/frame.h"
238 #elif defined(__WXMAC__)
239 #include "wx/mac/frame.h"
240 #elif defined(__WXCOCOA__)
241 #include "wx/cocoa/frame.h"
242 #elif defined(__WXPM__)
243 #include "wx/os2/frame.h"
244 #endif
245 #endif
246
247 #endif
248 // _WX_FRAME_H_BASE_