]> git.saurik.com Git - wxWidgets.git/blame - include/wx/frame.h
UMAPr.. calls for classic only
[wxWidgets.git] / include / wx / frame.h
CommitLineData
7c0ea335
VZ
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
371a5b4e 9// Licence: wxWindows licence
7c0ea335
VZ
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_FRAME_H_BASE_
13#define _WX_FRAME_H_BASE_
c801d85f 14
7c0ea335
VZ
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
af49c4b8 19#if defined(__GNUG__) && !defined(__APPLE__)
7c0ea335
VZ
20 #pragma interface "framebase.h"
21#endif
22
7d9f12f3 23#include "wx/toplevel.h" // the base class
7c0ea335
VZ
24
25// the default names for various classs
26WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
27WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
28WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
29
1e6feb95 30class WXDLLEXPORT wxFrame;
7c0ea335
VZ
31class WXDLLEXPORT wxMenuBar;
32class WXDLLEXPORT wxStatusBar;
33class 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
7d9f12f3 47class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
7c0ea335
VZ
48{
49public:
50 // construction
51 wxFrameBase();
799ea011 52 virtual ~wxFrameBase();
7c0ea335
VZ
53
54 wxFrame *New(wxWindow *parent,
d9e2e4c2 55 wxWindowID winid,
7c0ea335
VZ
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
1c4f8f8d
VZ
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
a4f25aef
VZ
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
7c0ea335
VZ
76 // menu bar functions
77 // ------------------
78
1e6feb95 79#if wxUSE_MENUS
6522713c 80 virtual void SetMenuBar(wxMenuBar *menubar);
7c0ea335 81 virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
1e6feb95 82#endif // wxUSE_MENUS
7c0ea335 83
2b5f62a0 84#ifdef WXWIN_COMPATIBILITY_2_2
7c0ea335 85 // call this to simulate a menu command
d9e2e4c2 86 bool Command(int winid) { return ProcessCommand(winid); }
2b5f62a0 87#endif // WXWIN_COMPATIBILITY_2_2
7c0ea335
VZ
88
89 // process menu command: returns TRUE if processed
d9e2e4c2 90 bool ProcessCommand(int winid);
7c0ea335
VZ
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,
d9e2e4c2 98 wxWindowID winid = 0,
7c0ea335
VZ
99 const wxString& name =
100 wxStatusLineNameStr);
101 // return a new status bar
102 virtual wxStatusBar *OnCreateStatusBar(int number,
103 long style,
d9e2e4c2 104 wxWindowID winid,
7c0ea335
VZ
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[]);
1f361cdd
MB
115 void PushStatusText(const wxString &text, int number = 0);
116 void PopStatusText(int number = 0);
e4a55e21
RD
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; }
7c0ea335
VZ
121#endif // wxUSE_STATUSBAR
122
123 // toolbar functions
124 // -----------------
125#if wxUSE_TOOLBAR
126 // create main toolbar bycalling OnCreateToolBar()
127 virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL,
d9e2e4c2 128 wxWindowID winid = -1,
7c0ea335
VZ
129 const wxString& name = wxToolBarNameStr);
130 // return a new toolbar
131 virtual wxToolBar *OnCreateToolBar(long style,
d9e2e4c2 132 wxWindowID winid,
7c0ea335
VZ
133 const wxString& name );
134
135 // get/set the main toolbar
136 virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
137 virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
138#endif // wxUSE_TOOLBAR
139
7c0ea335
VZ
140 // implementation only from now on
141 // -------------------------------
142
7c0ea335
VZ
143 // event handlers
144 void OnIdle(wxIdleEvent& event);
7c0ea335 145 void OnMenuHighlight(wxMenuEvent& event);
7c0ea335 146
1e6feb95 147#if wxUSE_MENUS
7c0ea335
VZ
148 // send wxUpdateUIEvents for all menu items (called from OnIdle())
149 void DoMenuUpdates();
150 void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
1e6feb95 151#endif // wxUSE_MENUS
7c0ea335 152
5e6e6e73
VZ
153 // if there is no real wxTopLevelWindow on this platform we have to define
154 // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
155 // old ports (wxMotif) which don't define them in wxFrame
156#ifndef wxTopLevelWindowNative
157 virtual bool ShowFullScreen(bool WXUNUSED(show),
158 long WXUNUSED(style) = wxFULLSCREEN_ALL)
159 { return FALSE; }
160 virtual bool IsFullScreen() const
161 { return FALSE; }
162#endif // no wxTopLevelWindowNative
163
1f361cdd
MB
164 // show help text (typically in the statusbar); show is FALSE
165 // if you are hiding the help, TRUE otherwise
166 virtual void DoGiveHelp(const wxString& text, bool show);
167
7c0ea335
VZ
168protected:
169 // the frame main menu/status/tool bars
170 // ------------------------------------
171
172 // this (non virtual!) function should be called from dtor to delete the
173 // main menubar, statusbar and toolbar (if any)
174 void DeleteAllBars();
175
1e6feb95
VZ
176 // test whether this window makes part of the frame
177 virtual bool IsOneOfBars(const wxWindow *win) const;
178
179#if wxUSE_MENUS
180 // override to update menu bar position when the frame size changes
181 virtual void PositionMenuBar() { }
182
6522713c
VZ
183 // override to do something special when the menu bar is being removed
184 // from the frame
185 virtual void DetachMenuBar();
186
187 // override to do something special when the menu bar is attached to the
188 // frame
189 virtual void AttachMenuBar(wxMenuBar *menubar);
190
7c0ea335 191 wxMenuBar *m_frameMenuBar;
1e6feb95 192#endif // wxUSE_MENUS
7c0ea335
VZ
193
194#if wxUSE_STATUSBAR
195 // override to update status bar position (or anything else) when
196 // something changes
197 virtual void PositionStatusBar() { }
198
f6bcfd97
BP
199 // show the help string for this menu item in the given status bar: the
200 // status bar pointer can be NULL; return TRUE if help was shown
d9e2e4c2 201 bool ShowMenuHelp(wxStatusBar *statbar, int helpid);
f6bcfd97 202
7c0ea335
VZ
203 wxStatusBar *m_frameStatusBar;
204#endif // wxUSE_STATUSBAR
205
1f361cdd
MB
206
207 int m_statusBarPane;
208
7c0ea335
VZ
209#if wxUSE_TOOLBAR
210 // override to update status bar position (or anything else) when
211 // something changes
212 virtual void PositionToolBar() { }
213
214 wxToolBar *m_frameToolBar;
215#endif // wxUSE_TOOLBAR
216
7c0ea335 217 DECLARE_EVENT_TABLE()
22f3361e 218 DECLARE_NO_COPY_CLASS(wxFrameBase)
7c0ea335
VZ
219};
220
221// include the real class declaration
c67d6888 222#if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
1e6feb95 223 #include "wx/univ/frame.h"
af8964c4 224#else // !__WXUNIVERSAL__
0d53fc34
VS
225 #if defined(__WXMSW__)
226 #include "wx/msw/frame.h"
227 #elif defined(__WXGTK__)
228 #include "wx/gtk/frame.h"
229 #elif defined(__WXMOTIF__)
230 #include "wx/motif/frame.h"
231 #elif defined(__WXMAC__)
232 #include "wx/mac/frame.h"
e64df9bc
DE
233 #elif defined(__WXCOCOA__)
234 #include "wx/cocoa/frame.h"
0d53fc34
VS
235 #elif defined(__WXPM__)
236 #include "wx/os2/frame.h"
237 #endif
238#endif
1e6feb95 239
c801d85f 240#endif
34138703 241 // _WX_FRAME_H_BASE_