]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/frame.h
renamed wxWave to wxSound
[wxWidgets.git] / include / wx / frame.h
... / ...
CommitLineData
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
26WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
27WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
28WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
29
30class WXDLLEXPORT wxFrame;
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
47class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
48{
49public:
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 // process menu command: returns TRUE if processed
85 bool ProcessCommand(int winid);
86
87 // status bar functions
88 // --------------------
89#if wxUSE_STATUSBAR
90 // create the main status bar by calling OnCreateStatusBar()
91 virtual wxStatusBar* CreateStatusBar(int number = 1,
92 long style = wxST_SIZEGRIP,
93 wxWindowID winid = 0,
94 const wxString& name =
95 wxStatusLineNameStr);
96 // return a new status bar
97 virtual wxStatusBar *OnCreateStatusBar(int number,
98 long style,
99 wxWindowID winid,
100 const wxString& name);
101 // get the main status bar
102 virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
103
104 // sets the main status bar
105 void SetStatusBar(wxStatusBar *statBar) { m_frameStatusBar = statBar; }
106
107 // forward these to status bar
108 virtual void SetStatusText(const wxString &text, int number = 0);
109 virtual void SetStatusWidths(int n, const int widths_field[]);
110 void PushStatusText(const wxString &text, int number = 0);
111 void PopStatusText(int number = 0);
112
113 // set the status bar pane the help will be shown in
114 void SetStatusBarPane(int n) { m_statusBarPane = n; }
115 int GetStatusBarPane() const { return m_statusBarPane; }
116#endif // wxUSE_STATUSBAR
117
118 // toolbar functions
119 // -----------------
120
121#if wxUSE_TOOLBAR
122 // create main toolbar bycalling OnCreateToolBar()
123 virtual wxToolBar* CreateToolBar(long style = -1,
124 wxWindowID winid = -1,
125 const wxString& name = wxToolBarNameStr);
126 // return a new toolbar
127 virtual wxToolBar *OnCreateToolBar(long style,
128 wxWindowID winid,
129 const wxString& name );
130
131 // get/set the main toolbar
132 virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
133 virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
134#endif // wxUSE_TOOLBAR
135
136 // implementation only from now on
137 // -------------------------------
138
139 // event handlers
140#if wxUSE_MENUS
141#if wxUSE_STATUSBAR
142 void OnMenuOpen(wxMenuEvent& event);
143 void OnMenuClose(wxMenuEvent& event);
144 void OnMenuHighlight(wxMenuEvent& event);
145#endif // wxUSE_STATUSBAR
146
147 // send wxUpdateUIEvents for all menu items in the menubar,
148 // or just for menu if non-NULL
149 void DoMenuUpdates(wxMenu* menu = NULL);
150#endif // wxUSE_MENUS
151
152 // do the UI update processing for this window
153 virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
154
155 // Implement internal behaviour (menu updating on some platforms)
156 virtual void OnInternalIdle();
157
158 // if there is no real wxTopLevelWindow on this platform we have to define
159 // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
160 // old ports (wxMotif) which don't define them in wxFrame
161#ifndef wxTopLevelWindowNative
162 virtual bool ShowFullScreen(bool WXUNUSED(show),
163 long WXUNUSED(style) = wxFULLSCREEN_ALL)
164 { return FALSE; }
165 virtual bool IsFullScreen() const
166 { return FALSE; }
167#endif // no wxTopLevelWindowNative
168
169 // show help text (typically in the statusbar); show is FALSE
170 // if you are hiding the help, TRUE otherwise
171 virtual void DoGiveHelp(const wxString& text, bool show);
172
173#if WXWIN_COMPATIBILITY_2_2
174 // call this to simulate a menu command
175 bool Command(int winid) { return ProcessCommand(winid); }
176#endif // WXWIN_COMPATIBILITY_2_2
177
178protected:
179 // the frame main menu/status/tool bars
180 // ------------------------------------
181
182 // this (non virtual!) function should be called from dtor to delete the
183 // main menubar, statusbar and toolbar (if any)
184 void DeleteAllBars();
185
186 // test whether this window makes part of the frame
187 virtual bool IsOneOfBars(const wxWindow *win) const;
188
189#if wxUSE_MENUS
190 // override to update menu bar position when the frame size changes
191 virtual void PositionMenuBar() { }
192
193 // override to do something special when the menu bar is being removed
194 // from the frame
195 virtual void DetachMenuBar();
196
197 // override to do something special when the menu bar is attached to the
198 // frame
199 virtual void AttachMenuBar(wxMenuBar *menubar);
200
201 wxMenuBar *m_frameMenuBar;
202
203#if wxUSE_STATUSBAR
204 // the saved status bar text overwritten by DoGiveHelp()
205 wxString m_oldStatusText;
206#endif // wxUSE_STATUSBAR
207#endif // wxUSE_MENUS
208
209#if wxUSE_STATUSBAR
210 // override to update status bar position (or anything else) when
211 // something changes
212 virtual void PositionStatusBar() { }
213
214 // show the help string for this menu item in the given status bar: the
215 // status bar pointer can be NULL; return TRUE if help was shown
216 bool ShowMenuHelp(wxStatusBar *statbar, int helpid);
217
218 wxStatusBar *m_frameStatusBar;
219#endif // wxUSE_STATUSBAR
220
221
222 int m_statusBarPane;
223
224#if wxUSE_TOOLBAR
225 // override to update status bar position (or anything else) when
226 // something changes
227 virtual void PositionToolBar() { }
228
229 wxToolBar *m_frameToolBar;
230#endif // wxUSE_TOOLBAR
231
232#if wxUSE_MENUS && wxUSE_STATUSBAR
233 DECLARE_EVENT_TABLE()
234#endif // wxUSE_MENUS && wxUSE_STATUSBAR
235
236 DECLARE_NO_COPY_CLASS(wxFrameBase)
237};
238
239// include the real class declaration
240#if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
241 #include "wx/univ/frame.h"
242#else // !__WXUNIVERSAL__
243 #if defined(__WXMSW__)
244 #include "wx/msw/frame.h"
245 #elif defined(__WXGTK__)
246 #include "wx/gtk/frame.h"
247 #elif defined(__WXMOTIF__)
248 #include "wx/motif/frame.h"
249 #elif defined(__WXMAC__)
250 #include "wx/mac/frame.h"
251 #elif defined(__WXCOCOA__)
252 #include "wx/cocoa/frame.h"
253 #elif defined(__WXPM__)
254 #include "wx/os2/frame.h"
255 #endif
256#endif
257
258#endif
259 // _WX_FRAME_H_BASE_