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