]> git.saurik.com Git - wxWidgets.git/blob - include/wx/frame.h
cleanup
[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) wxWidgets 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 #include "wx/toplevel.h" // the base class
20
21 // the default names for various classs
22 extern WXDLLEXPORT_DATA(const char) wxStatusLineNameStr[];
23 extern WXDLLEXPORT_DATA(const char) wxToolBarNameStr[];
24
25 class WXDLLIMPEXP_FWD_CORE wxFrame;
26 class WXDLLIMPEXP_FWD_CORE wxMenuBar;
27 class WXDLLIMPEXP_FWD_CORE wxMenuItem;
28 class WXDLLIMPEXP_FWD_CORE wxStatusBar;
29 class WXDLLIMPEXP_FWD_CORE wxToolBar;
30
31 // ----------------------------------------------------------------------------
32 // constants
33 // ----------------------------------------------------------------------------
34
35 // wxFrame-specific (i.e. not for wxDialog) styles
36 #define wxFRAME_NO_TASKBAR 0x0002 // No taskbar button (MSW only)
37 #define wxFRAME_TOOL_WINDOW 0x0004 // No taskbar button, no system menu
38 #define wxFRAME_FLOAT_ON_PARENT 0x0008 // Always above its parent
39 #define wxFRAME_SHAPED 0x0010 // Create a window that is able to be shaped
40
41 // ----------------------------------------------------------------------------
42 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
43 //
44 // For each of *bars, a frame may have several of them, but only one is
45 // managed by the frame, i.e. resized/moved when the frame is and whose size
46 // is accounted for in client size calculations - all others should be taken
47 // care of manually. The CreateXXXBar() functions create this, main, XXXBar,
48 // but the actual creation is done in OnCreateXXXBar() functions which may be
49 // overridden to create custom objects instead of standard ones when
50 // CreateXXXBar() is called.
51 // ----------------------------------------------------------------------------
52
53 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
54 {
55 public:
56 // construction
57 wxFrameBase();
58 virtual ~wxFrameBase();
59
60 wxFrame *New(wxWindow *parent,
61 wxWindowID winid,
62 const wxString& title,
63 const wxPoint& pos = wxDefaultPosition,
64 const wxSize& size = wxDefaultSize,
65 long style = wxDEFAULT_FRAME_STYLE,
66 const wxString& name = wxFrameNameStr);
67
68 // frame state
69 // -----------
70
71 // get the origin of the client area (which may be different from (0, 0)
72 // if the frame has a toolbar) in client coordinates
73 virtual wxPoint GetClientAreaOrigin() const;
74
75 // sends a size event to the window using its current size -- this has an
76 // effect of refreshing the window layout
77 virtual void SendSizeEvent();
78
79 // menu bar functions
80 // ------------------
81
82 #if wxUSE_MENUS
83 virtual void SetMenuBar(wxMenuBar *menubar);
84 virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
85
86 // find the item by id in the frame menu bar: this is an internal function
87 // and exists mainly in order to be overridden in the MDI parent frame
88 // which also looks at its active child menu bar
89 virtual const wxMenuItem *FindItemInMenuBar(int menuId) const;
90 #endif // wxUSE_MENUS
91
92 // process menu command: returns true if processed
93 bool ProcessCommand(int winid);
94
95 // status bar functions
96 // --------------------
97 #if wxUSE_STATUSBAR
98 // create the main status bar by calling OnCreateStatusBar()
99 virtual wxStatusBar* CreateStatusBar(int number = 1,
100 long style = wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
101 wxWindowID winid = 0,
102 const wxString& name =
103 wxStatusLineNameStr);
104 // return a new status bar
105 virtual wxStatusBar *OnCreateStatusBar(int number,
106 long style,
107 wxWindowID winid,
108 const wxString& name);
109 // get the main status bar
110 virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
111
112 // sets the main status bar
113 virtual void SetStatusBar(wxStatusBar *statBar);
114
115 // forward these to status bar
116 virtual void SetStatusText(const wxString &text, int number = 0);
117 virtual void SetStatusWidths(int n, const int widths_field[]);
118 void PushStatusText(const wxString &text, int number = 0);
119 void PopStatusText(int number = 0);
120
121 // set the status bar pane the help will be shown in
122 void SetStatusBarPane(int n) { m_statusBarPane = n; }
123 int GetStatusBarPane() const { return m_statusBarPane; }
124 #endif // wxUSE_STATUSBAR
125
126 // toolbar functions
127 // -----------------
128
129 #if wxUSE_TOOLBAR
130 // create main toolbar bycalling OnCreateToolBar()
131 virtual wxToolBar* CreateToolBar(long style = -1,
132 wxWindowID winid = wxID_ANY,
133 const wxString& name = wxToolBarNameStr);
134 // return a new toolbar
135 virtual wxToolBar *OnCreateToolBar(long style,
136 wxWindowID winid,
137 const wxString& name );
138
139 // get/set the main toolbar
140 virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
141 virtual void SetToolBar(wxToolBar *toolbar);
142 #endif // wxUSE_TOOLBAR
143
144 // implementation only from now on
145 // -------------------------------
146
147 // event handlers
148 #if wxUSE_MENUS
149 #if wxUSE_STATUSBAR
150 void OnMenuOpen(wxMenuEvent& event);
151 void OnMenuClose(wxMenuEvent& event);
152 void OnMenuHighlight(wxMenuEvent& event);
153 #endif // wxUSE_STATUSBAR
154
155 // send wxUpdateUIEvents for all menu items in the menubar,
156 // or just for menu if non-NULL
157 virtual void DoMenuUpdates(wxMenu* menu = NULL);
158 #endif // wxUSE_MENUS
159
160 // do the UI update processing for this window
161 virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
162
163 // Implement internal behaviour (menu updating on some platforms)
164 virtual void OnInternalIdle();
165
166 // if there is no real wxTopLevelWindow on this platform we have to define
167 // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
168 // old ports (wxMotif) which don't define them in wxFrame
169 #ifndef wxTopLevelWindowNative
170 virtual bool ShowFullScreen(bool WXUNUSED(show),
171 long WXUNUSED(style) = wxFULLSCREEN_ALL)
172 { return false; }
173 virtual bool IsFullScreen() const
174 { return false; }
175 #endif // no wxTopLevelWindowNative
176
177 #if wxUSE_MENUS || wxUSE_TOOLBAR
178 // show help text for the currently selected menu or toolbar item
179 // (typically in the status bar) or hide it and restore the status bar text
180 // originally shown before the menu was opened if show == false
181 virtual void DoGiveHelp(const wxString& text, bool show);
182 #endif
183
184 virtual bool IsClientAreaChild(const wxWindow *child) const
185 {
186 return !IsOneOfBars(child) && wxTopLevelWindow::IsClientAreaChild(child);
187 }
188
189 protected:
190 // the frame main menu/status/tool bars
191 // ------------------------------------
192
193 // this (non virtual!) function should be called from dtor to delete the
194 // main menubar, statusbar and toolbar (if any)
195 void DeleteAllBars();
196
197 // test whether this window makes part of the frame
198 virtual bool IsOneOfBars(const wxWindow *win) const;
199
200 #if wxUSE_MENUS
201 // override to update menu bar position when the frame size changes
202 virtual void PositionMenuBar() { }
203
204 // override to do something special when the menu bar is being removed
205 // from the frame
206 virtual void DetachMenuBar();
207
208 // override to do something special when the menu bar is attached to the
209 // frame
210 virtual void AttachMenuBar(wxMenuBar *menubar);
211
212 wxMenuBar *m_frameMenuBar;
213 #endif // wxUSE_MENUS
214
215 #if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR)
216 // the saved status bar text overwritten by DoGiveHelp()
217 wxString m_oldStatusText;
218 #endif
219
220 #if wxUSE_STATUSBAR
221 // override to update status bar position (or anything else) when
222 // something changes
223 virtual void PositionStatusBar() { }
224
225 // show the help string for the given menu item using DoGiveHelp() if the
226 // given item does have a help string (as determined by FindInMenuBar()),
227 // return false if there is no help for such item
228 bool ShowMenuHelp(int helpid);
229
230 wxStatusBar *m_frameStatusBar;
231 #endif // wxUSE_STATUSBAR
232
233
234 int m_statusBarPane;
235
236 #if wxUSE_TOOLBAR
237 // override to update status bar position (or anything else) when
238 // something changes
239 virtual void PositionToolBar() { }
240
241 wxToolBar *m_frameToolBar;
242 #endif // wxUSE_TOOLBAR
243
244 #if wxUSE_MENUS && wxUSE_STATUSBAR
245 DECLARE_EVENT_TABLE()
246 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
247
248 DECLARE_NO_COPY_CLASS(wxFrameBase)
249 };
250
251 // include the real class declaration
252 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
253 #include "wx/univ/frame.h"
254 #else // !__WXUNIVERSAL__
255 #if defined(__WXPALMOS__)
256 #include "wx/palmos/frame.h"
257 #elif defined(__WXMSW__)
258 #include "wx/msw/frame.h"
259 #elif defined(__WXGTK20__)
260 #include "wx/gtk/frame.h"
261 #elif defined(__WXGTK__)
262 #include "wx/gtk1/frame.h"
263 #elif defined(__WXMOTIF__)
264 #include "wx/motif/frame.h"
265 #elif defined(__WXMAC__)
266 #include "wx/mac/frame.h"
267 #elif defined(__WXCOCOA__)
268 #include "wx/cocoa/frame.h"
269 #elif defined(__WXPM__)
270 #include "wx/os2/frame.h"
271 #endif
272 #endif
273
274 #endif
275 // _WX_FRAME_H_BASE_