]>
Commit | Line | Data |
---|---|---|
a660d684 KB |
1 | \section{\class{wxFrame}}\label{wxframe} |
2 | ||
1c4f8f8d VZ |
3 | A frame is a window whose size and position can (usually) be changed by the |
4 | user. It usually has thick borders and a title bar, and can optionally contain | |
5 | a menu bar, toolbar and status bar. A frame can contain any window that is not | |
6 | a frame or dialog. | |
a660d684 | 7 | |
1c4f8f8d VZ |
8 | A frame that has a status bar and toolbar created via the |
9 | CreateStatusBar/CreateToolBar functions manages these windows, and adjusts the | |
10 | value returned by GetClientSize to reflect the remaining size available to | |
11 | application windows. | |
81d66cf3 | 12 | |
a660d684 KB |
13 | \wxheading{Derived from} |
14 | ||
834ed994 | 15 | \helpref{wxTopLevelWindow}{wxtoplevelwindow}\\ |
a660d684 KB |
16 | \helpref{wxWindow}{wxwindow}\\ |
17 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
18 | \helpref{wxObject}{wxobject} | |
19 | ||
954b8ae6 JS |
20 | \wxheading{Include files} |
21 | ||
22 | <wx/frame.h> | |
23 | ||
a7af285d VZ |
24 | \wxheading{Library} |
25 | ||
26 | \helpref{wxCore}{librarieslist} | |
27 | ||
a660d684 KB |
28 | \wxheading{Window styles} |
29 | ||
30 | \twocolwidtha{5cm} | |
31 | \begin{twocollist}\itemsep=0pt | |
01a01d10 | 32 | \twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX \pipe wxCLIP\_CHILDREN}.} |
6453876e | 33 | \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. } |
a660d684 | 34 | \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.} |
f6bcfd97 BP |
35 | \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.} |
36 | \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame.} | |
37 | \twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized. Windows only.} | |
38 | \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame.} | |
850c6ed4 | 39 | \twocolitem{\windowstyle{wxCLOSE\_BOX}}{Displays a close box on the frame.} |
9dfef5ac | 40 | \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of all other windows, |
3faa8195 | 41 | see also wxFRAME\_FLOAT\_ON\_PARENT.} |
f6bcfd97 | 42 | \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu.} |
b3daa5a3 VZ |
43 | \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.} |
44 | \twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small | |
36d23121 | 45 | titlebar to be created; the frame does not appear in the taskbar under Windows or GTK+.} |
9dfef5ac | 46 | \twocolitem{\windowstyle{wxFRAME\_NO\_TASKBAR}}{Creates an otherwise normal |
baf277a2 VS |
47 | frame but it does not appear in the taskbar under Windows or GTK+ (note that it |
48 | will minimize to the desktop window under Windows which may seem strange to the | |
49 | users and thus it might be better to use this style only without | |
50 | wxMINIMIZE\_BOX style). In wxGTK, the flag is respected only if GTK+ is at | |
51 | least version 2.2 and the window manager supports | |
52 | \urlref{\_NET\_WM\_STATE\_SKIP\_TASKBAR}{http://freedesktop.org/Standards/wm-spec/1.3/ar01s05.html} hint. | |
9dfef5ac VZ |
53 | Has no effect under other platforms.} |
54 | \twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{The frame will always be | |
55 | on top of its parent (unlike wxSTAY\_ON\_TOP). A frame created with this style | |
56 | must have a non-NULL parent.} | |
26a80c22 | 57 | \twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the |
fc2171bd | 58 | caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send |
26a80c22 JS |
59 | a wxEVT\_HELP event if the user clicked on an application window. {\it Note} that this is an extended |
60 | style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction). | |
335c9e32 | 61 | You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so |
d2c2afc9 | 62 | you should use\rtfsp |
c8abcf33 | 63 | {\tt wxDEFAULT\_FRAME\_STYLE \& ~ (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the |
0032ddbb | 64 | frames having this style (the dialogs don't have a minimize or a maximize box by |
335c9e32 | 65 | default)} |
6a7e6411 | 66 | \twocolitem{\windowstyle{wxFRAME\_SHAPED}}{Windows with this style are |
8caac90d | 67 | allowed to have their shape changed with the \helpref{SetShape}{wxtoplevelwindowsetshape} method.} |
03d77609 | 68 | \twocolitem{\windowstyle{wxFRAME\_EX\_METAL}}{On Mac OS X, frames with this style will be shown with a metallic look. This is an {\it extra} style.} |
a660d684 KB |
69 | \end{twocollist} |
70 | ||
f6bcfd97 BP |
71 | The default frame style is for normal, resizeable frames. To create a frame |
72 | which can not be resized by user, you may use the following combination of | |
c8abcf33 | 73 | styles: {\tt wxDEFAULT\_FRAME\_STYLE \& ~ (wxRESIZE\_BORDER \pipe wxRESIZE\_BOX \pipe wxMAXIMIZE\_BOX)}. |
f6bcfd97 BP |
74 | % Note: the space after the tilde is necessary or Tex2RTF complains. |
75 | ||
6453876e | 76 | See also \helpref{window styles overview}{windowstyles}. |
a660d684 | 77 | |
9b67a3fd VZ |
78 | \wxheading{Default event processing} |
79 | ||
80 | wxFrame processes the following events: | |
81 | ||
82 | \begin{twocollist}\itemsep=0pt | |
974d9c98 VZ |
83 | \twocolitem{\helpref{wxEVT\_SIZE}{wxsizeevent}}{If the frame has exactly one |
84 | child window, not counting the status and toolbar, this child is resized to | |
85 | take the entire frame client area. If two or more windows are present, they | |
1542ea39 | 86 | should be laid out explicitly either by manually handling wxEVT\_SIZE or using |
9b67a3fd VZ |
87 | \helpref{sizers}{sizeroverview}} |
88 | ||
974d9c98 VZ |
89 | \twocolitem{\helpref{wxEVT\_MENU\_HIGHLIGHT}{wxmenuevent}}{The default |
90 | implementation displays the \helpref{help string}{wxmenuitemgethelp} associated | |
91 | with the selected item in the first pane of the status bar, if there is one.} | |
9b67a3fd VZ |
92 | \end{twocollist} |
93 | ||
a660d684 KB |
94 | \wxheading{Remarks} |
95 | ||
f4fcc291 | 96 | An application should normally define an \helpref{wxCloseEvent}{wxcloseevent} handler for the |
a660d684 KB |
97 | frame to respond to system close events, for example so that related data and subwindows can be cleaned up. |
98 | ||
99 | \wxheading{See also} | |
100 | ||
101 | \helpref{wxMDIParentFrame}{wxmdiparentframe}, \helpref{wxMDIChildFrame}{wxmdichildframe},\rtfsp | |
102 | \helpref{wxMiniFrame}{wxminiframe}, \helpref{wxDialog}{wxdialog} | |
103 | ||
104 | \latexignore{\rtfignore{\wxheading{Members}}} | |
105 | ||
f0e8a2d0 | 106 | \membersection{wxFrame::wxFrame}\label{wxframector} |
a660d684 KB |
107 | |
108 | \func{}{wxFrame}{\void} | |
109 | ||
110 | Default constructor. | |
111 | ||
eaaa6a06 | 112 | \func{}{wxFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp |
a660d684 KB |
113 | \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp |
114 | \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp | |
115 | \param{const wxString\& }{name = ``frame"}} | |
116 | ||
117 | Constructor, creating the window. | |
118 | ||
119 | \wxheading{Parameters} | |
120 | ||
121 | \docparam{parent}{The window parent. This may be NULL. If it is non-NULL, the frame will | |
122 | always be displayed on top of the parent window on Windows.} | |
123 | ||
124 | \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.} | |
125 | ||
126 | \docparam{title}{The caption to be displayed on the frame's title bar.} | |
127 | ||
128 | \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by | |
fc2171bd | 129 | either the windowing system or wxWidgets, depending on platform.} |
a660d684 KB |
130 | |
131 | \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by | |
fc2171bd | 132 | either the windowing system or wxWidgets, depending on platform.} |
a660d684 KB |
133 | |
134 | \docparam{style}{The window style. See \helpref{wxFrame}{wxframe}.} | |
135 | ||
136 | \docparam{name}{The name of the window. This parameter is used to associate a name with the item, | |
137 | allowing the application user to set Motif resource values for | |
138 | individual windows.} | |
139 | ||
140 | \wxheading{Remarks} | |
141 | ||
142 | For Motif, MWM (the Motif Window Manager) should be running for any window styles to work | |
143 | (otherwise all styles take effect). | |
144 | ||
145 | \wxheading{See also} | |
146 | ||
147 | \helpref{wxFrame::Create}{wxframecreate} | |
148 | ||
f0e8a2d0 | 149 | \membersection{wxFrame::\destruct{wxFrame}}\label{wxframedtor} |
a660d684 KB |
150 | |
151 | \func{void}{\destruct{wxFrame}}{\void} | |
152 | ||
153 | Destructor. Destroys all child windows and menu bar if present. | |
154 | ||
155 | \membersection{wxFrame::Centre}\label{wxframecentre} | |
156 | ||
eaaa6a06 | 157 | \func{void}{Centre}{\param{int}{ direction = wxBOTH}} |
a660d684 KB |
158 | |
159 | Centres the frame on the display. | |
160 | ||
161 | \wxheading{Parameters} | |
162 | ||
163 | \docparam{direction}{The parameter may be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.} | |
164 | ||
a660d684 KB |
165 | \membersection{wxFrame::Create}\label{wxframecreate} |
166 | ||
eaaa6a06 | 167 | \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp |
a660d684 KB |
168 | \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp |
169 | \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp | |
170 | \param{const wxString\& }{name = ``frame"}} | |
171 | ||
f0e8a2d0 | 172 | Used in two-step frame construction. See \helpref{wxFrame::wxFrame}{wxframector}\rtfsp |
a660d684 KB |
173 | for further details. |
174 | ||
175 | \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar} | |
176 | ||
81d66cf3 JS |
177 | \func{virtual wxStatusBar*}{CreateStatusBar}{\param{int}{ number = 1}, |
178 | \param{long}{ style = 0}, | |
179 | \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "statusBar"}} | |
a660d684 KB |
180 | |
181 | Creates a status bar at the bottom of the frame. | |
182 | ||
183 | \wxheading{Parameters} | |
184 | ||
185 | \docparam{number}{The number of fields to create. Specify a | |
186 | value greater than 1 to create a multi-field status bar.} | |
187 | ||
81d66cf3 JS |
188 | \docparam{style}{The status bar style. See \helpref{wxStatusBar}{wxstatusbar} for a list |
189 | of valid styles.} | |
190 | ||
191 | \docparam{id}{The status bar window identifier. If -1, an identifier will be chosen by | |
fc2171bd | 192 | wxWidgets.} |
81d66cf3 JS |
193 | |
194 | \docparam{name}{The status bar window name.} | |
195 | ||
a660d684 KB |
196 | \wxheading{Return value} |
197 | ||
43e8916f | 198 | A pointer to the status bar if it was created successfully, NULL otherwise. |
a660d684 KB |
199 | |
200 | \wxheading{Remarks} | |
201 | ||
202 | The width of the status bar is the whole width of the frame (adjusted automatically when | |
203 | resizing), and the height and text size are chosen by the host windowing system. | |
204 | ||
205 | By default, the status bar is an instance of wxStatusBar. To use a different class, | |
206 | override \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar}. | |
207 | ||
208 | Note that you can put controls and other windows on the status bar if you wish. | |
209 | ||
210 | \wxheading{See also} | |
211 | ||
212 | \helpref{wxFrame::SetStatusText}{wxframesetstatustext},\rtfsp | |
213 | \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar},\rtfsp | |
214 | \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar} | |
215 | ||
81d66cf3 JS |
216 | \membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar} |
217 | ||
218 | \func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxNO\_BORDER \pipe wxTB\_HORIZONTAL}, | |
219 | \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}} | |
220 | ||
221 | Creates a toolbar at the top or left of the frame. | |
222 | ||
223 | \wxheading{Parameters} | |
224 | ||
225 | \docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list | |
226 | of valid styles.} | |
227 | ||
228 | \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by | |
fc2171bd | 229 | wxWidgets.} |
81d66cf3 JS |
230 | |
231 | \docparam{name}{The toolbar window name.} | |
232 | ||
233 | \wxheading{Return value} | |
234 | ||
43e8916f | 235 | A pointer to the toolbar if it was created successfully, NULL otherwise. |
81d66cf3 JS |
236 | |
237 | \wxheading{Remarks} | |
238 | ||
239 | By default, the toolbar is an instance of wxToolBar (which is defined to be | |
240 | a suitable toolbar class on each platform, such as wxToolBar95). To use a different class, | |
241 | override \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar}. | |
242 | ||
243 | When a toolbar has been created with this function, or made known to the frame | |
244 | with \helpref{wxFrame::SetToolBar}{wxframesettoolbar}, the frame will manage the toolbar | |
245 | position and adjust the return value from \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} to | |
246 | reflect the available space for application windows. | |
247 | ||
a9102b36 JS |
248 | Under Pocket PC, you should {\it always} use this function for creating the toolbar |
249 | to be managed by the frame, so that wxWidgets can use a combined | |
250 | menubar and toolbar. Where you manage your own toolbars, create a wxToolBar | |
251 | as usual. | |
252 | ||
81d66cf3 JS |
253 | \wxheading{See also} |
254 | ||
255 | \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp | |
256 | \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar},\rtfsp | |
257 | \helpref{wxFrame::SetToolBar}{wxframesettoolbar},\rtfsp | |
258 | \helpref{wxFrame::GetToolBar}{wxframegettoolbar} | |
259 | ||
1c4f8f8d VZ |
260 | \membersection{wxFrame::GetClientAreaOrigin}\label{wxframegetclientareaorigin} |
261 | ||
262 | \constfunc{wxPoint}{GetClientAreaOrigin}{\void} | |
263 | ||
264 | Returns the origin of the frame client area (in client coordinates). It may be | |
265 | different from (0, 0) if the frame has a toolbar. | |
266 | ||
a660d684 KB |
267 | \membersection{wxFrame::GetMenuBar}\label{wxframegetmenubar} |
268 | ||
269 | \constfunc{wxMenuBar*}{GetMenuBar}{\void} | |
270 | ||
271 | Returns a pointer to the menubar currently associated with the frame (if any). | |
272 | ||
273 | \wxheading{See also} | |
274 | ||
275 | \helpref{wxFrame::SetMenuBar}{wxframesetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu} | |
276 | ||
277 | \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar} | |
278 | ||
fa482912 | 279 | \constfunc{wxStatusBar*}{GetStatusBar}{\void} |
a660d684 KB |
280 | |
281 | Returns a pointer to the status bar currently associated with the frame (if any). | |
282 | ||
283 | \wxheading{See also} | |
284 | ||
285 | \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar} | |
286 | ||
0b0625e9 JS |
287 | \membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane} |
288 | ||
289 | \func{int}{GetStatusBarPane}{\void} | |
290 | ||
291 | Returns the status bar pane used to display menu and toolbar help. | |
292 | ||
293 | \wxheading{See also} | |
294 | ||
295 | \helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane} | |
296 | ||
81d66cf3 JS |
297 | \membersection{wxFrame::GetToolBar}\label{wxframegettoolbar} |
298 | ||
fa482912 | 299 | \constfunc{wxToolBar*}{GetToolBar}{\void} |
81d66cf3 JS |
300 | |
301 | Returns a pointer to the toolbar currently associated with the frame (if any). | |
302 | ||
303 | \wxheading{See also} | |
304 | ||
305 | \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp | |
306 | \helpref{wxFrame::SetToolBar}{wxframesettoolbar} | |
307 | ||
a660d684 KB |
308 | \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar} |
309 | ||
dbdb39b2 | 310 | \func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number}, |
81d66cf3 JS |
311 | \param{long}{ style}, |
312 | \param{wxWindowID}{ id}, \param{const wxString\&}{ name}} | |
a660d684 KB |
313 | |
314 | Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}. | |
315 | ||
316 | \wxheading{Parameters} | |
317 | ||
318 | \docparam{number}{The number of fields to create.} | |
319 | ||
81d66cf3 JS |
320 | \docparam{style}{The window style. See \helpref{wxStatusBar}{wxstatusbar} for a list |
321 | of valid styles.} | |
322 | ||
323 | \docparam{id}{The window identifier. If -1, an identifier will be chosen by | |
fc2171bd | 324 | wxWidgets.} |
81d66cf3 JS |
325 | |
326 | \docparam{name}{The window name.} | |
327 | ||
a660d684 KB |
328 | \wxheading{Return value} |
329 | ||
330 | A status bar object. | |
331 | ||
332 | \wxheading{Remarks} | |
333 | ||
334 | An application can override this function to return a different kind of status bar. The default | |
335 | implementation returns an instance of \helpref{wxStatusBar}{wxstatusbar}. | |
336 | ||
337 | \wxheading{See also} | |
338 | ||
339 | \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}. | |
340 | ||
81d66cf3 JS |
341 | \membersection{wxFrame::OnCreateToolBar}\label{wxframeoncreatetoolbar} |
342 | ||
343 | \func{virtual wxToolBar*}{OnCreateToolBar}{\param{long}{ style}, | |
344 | \param{wxWindowID}{ id}, \param{const wxString\&}{ name}} | |
345 | ||
346 | Virtual function called when a toolbar is requested by \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}. | |
347 | ||
348 | \wxheading{Parameters} | |
349 | ||
350 | \docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list | |
351 | of valid styles.} | |
352 | ||
353 | \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by | |
fc2171bd | 354 | wxWidgets.} |
81d66cf3 JS |
355 | |
356 | \docparam{name}{The toolbar window name.} | |
357 | ||
358 | \wxheading{Return value} | |
359 | ||
360 | A toolbar object. | |
361 | ||
362 | \wxheading{Remarks} | |
363 | ||
364 | An application can override this function to return a different kind of toolbar. The default | |
365 | implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}. | |
366 | ||
367 | \wxheading{See also} | |
368 | ||
369 | \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}. | |
370 | ||
f6e9a818 RN |
371 | |
372 | \membersection{wxFrame::ProcessCommand}\label{wxframeprocesscommand} | |
373 | ||
374 | \func{void}{ProcessCommand}{\param{int }{id}} | |
375 | ||
376 | Simulate a menu command. | |
377 | ||
378 | \wxheading{Parameters} | |
379 | ||
380 | \docparam{id}{The identifier for a menu item.} | |
381 | ||
382 | ||
a4f25aef VZ |
383 | \membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent} |
384 | ||
385 | \func{void}{SendSizeEvent}{\void} | |
386 | ||
387 | This function sends a dummy \helpref{size event}{wxsizeevent} to the frame | |
388 | forcing it to reevaluate its children positions. It is sometimes useful to call | |
389 | this function after adding or deleting a children after the frame creation or | |
390 | if a child size changes. | |
391 | ||
392 | Note that if the frame is using either sizers or constraints for the children | |
393 | layout, it is enough to call \helpref{Layout()}{wxwindowlayout} directly and | |
394 | this function should not be used in this case. | |
395 | ||
1542ea39 | 396 | % VZ: we don't have all this any more (18.08.00) |
d9b815ac VZ |
397 | % |
398 | %Under Windows, instead of using {\bf SetIcon}, you can add the | |
399 | %following lines to your MS Windows resource file: | |
400 | % | |
401 | %\begin{verbatim} | |
402 | %wxSTD_MDIPARENTFRAME ICON icon1.ico | |
403 | %wxSTD_MDICHILDFRAME ICON icon2.ico | |
404 | %wxSTD_FRAME ICON icon3.ico | |
405 | %\end{verbatim} | |
406 | % | |
407 | %where icon1.ico will be used for the MDI parent frame, icon2.ico | |
408 | %will be used for MDI child frames, and icon3.ico will be used for | |
409 | %non-MDI frames. | |
410 | % | |
411 | %If these icons are not supplied, and {\bf SetIcon} is not called either, | |
412 | %then the following defaults apply if you have included wx.rc. | |
413 | % | |
414 | %\begin{verbatim} | |
415 | %wxDEFAULT_FRAME ICON std.ico | |
416 | %wxDEFAULT_MDIPARENTFRAME ICON mdi.ico | |
417 | %wxDEFAULT_MDICHILDFRAME ICON child.ico | |
418 | %\end{verbatim} | |
419 | % | |
420 | %You can replace std.ico, mdi.ico and child.ico with your own defaults | |
fc2171bd | 421 | %for all your wxWidgets application. Currently they show the same icon. |
a660d684 | 422 | |
a660d684 KB |
423 | \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar} |
424 | ||
425 | \func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}} | |
426 | ||
427 | Tells the frame to show the given menu bar. | |
428 | ||
429 | \wxheading{Parameters} | |
430 | ||
431 | \docparam{menuBar}{The menu bar to associate with the frame.} | |
432 | ||
433 | \wxheading{Remarks} | |
434 | ||
435 | If the frame is destroyed, the | |
436 | menu bar and its menus will be destroyed also, so do not delete the menu | |
437 | bar explicitly (except by resetting the frame's menu bar to another | |
438 | frame or NULL). | |
439 | ||
684761db | 440 | Under Windows, a size event is generated, so be sure to initialize |
a660d684 KB |
441 | data members properly before calling {\bf SetMenuBar}. |
442 | ||
684761db | 443 | Note that on some platforms, it is not possible to call this function twice for the same frame object. |
a660d684 KB |
444 | |
445 | \wxheading{See also} | |
446 | ||
447 | \helpref{wxFrame::GetMenuBar}{wxframegetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}. | |
448 | ||
81d66cf3 JS |
449 | \membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar} |
450 | ||
451 | \func{void}{SetStatusBar}{\param{wxStatusBar*}{ statusBar}} | |
452 | ||
453 | Associates a status bar with the frame. | |
454 | ||
455 | \wxheading{See also} | |
456 | ||
457 | \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp | |
458 | \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar} | |
459 | ||
0b0625e9 JS |
460 | \membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane} |
461 | ||
462 | \func{void}{SetStatusBarPane}{\param{int}{ n}} | |
463 | ||
464 | Set the status bar pane used to display menu and toolbar help. | |
465 | Using -1 disables help display. | |
466 | ||
a660d684 KB |
467 | \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext} |
468 | ||
eaaa6a06 | 469 | \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}} |
a660d684 KB |
470 | |
471 | Sets the status bar text and redraws the status bar. | |
472 | ||
473 | \wxheading{Parameters} | |
474 | ||
475 | \docparam{text}{The text for the status field.} | |
476 | ||
477 | \docparam{number}{The status field (starting from zero).} | |
478 | ||
479 | \wxheading{Remarks} | |
480 | ||
481 | Use an empty string to clear the status bar. | |
482 | ||
483 | \wxheading{See also} | |
484 | ||
485 | \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar} | |
486 | ||
487 | \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths} | |
488 | ||
eaaa6a06 | 489 | \func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}} |
a660d684 KB |
490 | |
491 | Sets the widths of the fields in the status bar. | |
492 | ||
493 | \wxheading{Parameters} | |
494 | ||
56aed4aa | 495 | \docparam{n}{The number of fields in the status bar. It must be the |
a660d684 KB |
496 | same used in \helpref{CreateStatusBar}{wxframecreatestatusbar}.} |
497 | ||
498 | \docparam{widths}{Must contain an array of {\it n} integers, each of which is a status field width | |
499 | in pixels. A value of -1 indicates that the field is variable width; at least one | |
500 | field must be -1. You should delete this array after calling {\bf SetStatusWidths}.} | |
501 | ||
502 | \wxheading{Remarks} | |
503 | ||
504 | The widths of the variable fields are calculated from the total width of all fields, | |
564747ee | 505 | minus the sum of widths of the non-variable fields, divided by the number of |
a660d684 KB |
506 | variable fields. |
507 | ||
564747ee RD |
508 | \pythonnote{Only a single parameter is required, a Python list of |
509 | integers.} | |
510 | ||
f3539882 | 511 | \perlnote{In wxPerl this method takes the field widths as parameters.} |
5873607e | 512 | |
81d66cf3 JS |
513 | \membersection{wxFrame::SetToolBar}\label{wxframesettoolbar} |
514 | ||
515 | \func{void}{SetToolBar}{\param{wxToolBar*}{ toolBar}} | |
516 | ||
517 | Associates a toolbar with the frame. | |
518 | ||
519 | \wxheading{See also} | |
520 | ||
521 | \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp | |
522 | \helpref{wxFrame::GetToolBar}{wxframegettoolbar} | |
523 |