]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/frame.tex
fixed typo
[wxWidgets.git] / docs / latex / wx / frame.tex
1 \section{\class{wxFrame}}\label{wxframe}
2
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.
7
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.
12
13 \wxheading{Derived from}
14
15 \helpref{wxWindow}{wxwindow}\\
16 \helpref{wxEvtHandler}{wxevthandler}\\
17 \helpref{wxObject}{wxobject}
18
19 \wxheading{Include files}
20
21 <wx/frame.h>
22
23 \wxheading{Window styles}
24
25 \twocolwidtha{5cm}
26 \begin{twocollist}\itemsep=0pt
27 \twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX}.}
28 \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. }
29 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
30 \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.}
31 \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame.}
32 \twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized. Windows only.}
33 \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame.}
34 \twocolitem{\windowstyle{wxCLOSE\_BOX}}{Displays a close box on the frame.}
35 \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of all other windows,
36 see also wxFRAME\_FLOAT\_ON\_PARENT. Windows only.}
37 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu.}
38 \twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays no border or decorations. GTK and Windows only.}
39 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.}
40 \twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small
41 titlebar to be created; the frame does not appear in the taskbar under Windows.}
42 \twocolitem{\windowstyle{wxFRAME\_NO\_TASKBAR}}{Creates an otherwise normal
43 frame but it does not appear in the taskbar under Windows (note that it will
44 minimize to the desktop window which may seem strange to the users and thus it
45 might be better to use this style only without wxMINIMIZE\_BOX style).
46 Has no effect under other platforms.}
47 \twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{The frame will always be
48 on top of its parent (unlike wxSTAY\_ON\_TOP). A frame created with this style
49 must have a non-NULL parent.}
50 \twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
51 caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send
52 a wxEVT\_HELP event if the user clicked on an application window. {\it Note} that this is an extended
53 style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction).
54 You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
55 you should use
56 {\tt wxDEFAULT\_FRAME\_STYLE \& (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
57 frames having this style (the dialogs don't have minimize nor maximize box by
58 default)}
59 \end{twocollist}
60
61 The default frame style is for normal, resizeable frames. To create a frame
62 which can not be resized by user, you may use the following combination of
63 styles: {\tt wxDEFAULT\_FRAME\_STYLE \& (wxRESIZE\_BORDER \pipe wxRESIZE\_BOX \pipe wxMAXIMIZE\_BOX)}.
64 % Note: the space after the tilde is necessary or Tex2RTF complains.
65
66 See also \helpref{window styles overview}{windowstyles}.
67
68 \wxheading{Default event processing}
69
70 wxFrame processes the following events:
71
72 \begin{twocollist}\itemsep=0pt
73 \twocolitem{\helpref{wxEVT\_SIZE}{wxsizeevent}}{If the frame has exactly one
74 child window, not counting the status and toolbar, this child is resized to
75 take the entire frame client area. If two or more windows are present, they
76 should be laid out explicitly either by manually handling wxEVT\_SIZE or using
77 \helpref{sizers}{sizeroverview}}
78
79 \twocolitem{\helpref{wxEVT\_MENU\_HIGHLIGHT}{wxmenuevent}}{The default
80 implementation displays the \helpref{help string}{wxmenuitemgethelp} associated
81 with the selected item in the first pane of the status bar, if there is one.}
82 \end{twocollist}
83
84 \wxheading{Remarks}
85
86 An application should normally define an \helpref{wxCloseEvent}{wxcloseevent} handler for the
87 frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
88
89 \wxheading{See also}
90
91 \helpref{wxMDIParentFrame}{wxmdiparentframe}, \helpref{wxMDIChildFrame}{wxmdichildframe},\rtfsp
92 \helpref{wxMiniFrame}{wxminiframe}, \helpref{wxDialog}{wxdialog}
93
94 \latexignore{\rtfignore{\wxheading{Members}}}
95
96 \membersection{wxFrame::wxFrame}\label{wxframeconstr}
97
98 \func{}{wxFrame}{\void}
99
100 Default constructor.
101
102 \func{}{wxFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
103 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
104 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
105 \param{const wxString\& }{name = ``frame"}}
106
107 Constructor, creating the window.
108
109 \wxheading{Parameters}
110
111 \docparam{parent}{The window parent. This may be NULL. If it is non-NULL, the frame will
112 always be displayed on top of the parent window on Windows.}
113
114 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
115
116 \docparam{title}{The caption to be displayed on the frame's title bar.}
117
118 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
119 either the windowing system or wxWindows, depending on platform.}
120
121 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
122 either the windowing system or wxWindows, depending on platform.}
123
124 \docparam{style}{The window style. See \helpref{wxFrame}{wxframe}.}
125
126 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
127 allowing the application user to set Motif resource values for
128 individual windows.}
129
130 \wxheading{Remarks}
131
132 For Motif, MWM (the Motif Window Manager) should be running for any window styles to work
133 (otherwise all styles take effect).
134
135 \wxheading{See also}
136
137 \helpref{wxFrame::Create}{wxframecreate}
138
139 \membersection{wxFrame::\destruct{wxFrame}}
140
141 \func{void}{\destruct{wxFrame}}{\void}
142
143 Destructor. Destroys all child windows and menu bar if present.
144
145 \membersection{wxFrame::Centre}\label{wxframecentre}
146
147 \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
148
149 Centres the frame on the display.
150
151 \wxheading{Parameters}
152
153 \docparam{direction}{The parameter may be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.}
154
155 \membersection{wxFrame::Command}\label{wxframecommand}
156
157 \func{void}{Command}{\param{int }{id}}
158
159 Simulate a menu command.
160
161 \wxheading{Parameters}
162
163 \docparam{id}{The identifier for a menu item.}
164
165 \membersection{wxFrame::Create}\label{wxframecreate}
166
167 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
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
172 Used in two-step frame construction. See \helpref{wxFrame::wxFrame}{wxframeconstr}\rtfsp
173 for further details.
174
175 \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar}
176
177 \func{virtual wxStatusBar*}{CreateStatusBar}{\param{int}{ number = 1},
178 \param{long}{ style = 0},
179 \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "statusBar"}}
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
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
192 wxWindows.}
193
194 \docparam{name}{The status bar window name.}
195
196 \wxheading{Return value}
197
198 A pointer to the the status bar if it was created successfully, NULL otherwise.
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
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
229 wxWindows.}
230
231 \docparam{name}{The toolbar window name.}
232
233 \wxheading{Return value}
234
235 A pointer to the the toolbar if it was created successfully, NULL otherwise.
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
248 \wxheading{See also}
249
250 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp
251 \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar},\rtfsp
252 \helpref{wxFrame::SetToolBar}{wxframesettoolbar},\rtfsp
253 \helpref{wxFrame::GetToolBar}{wxframegettoolbar}
254
255 \membersection{wxFrame::GetClientAreaOrigin}\label{wxframegetclientareaorigin}
256
257 \constfunc{wxPoint}{GetClientAreaOrigin}{\void}
258
259 Returns the origin of the frame client area (in client coordinates). It may be
260 different from (0, 0) if the frame has a toolbar.
261
262 \membersection{wxFrame::GetMenuBar}\label{wxframegetmenubar}
263
264 \constfunc{wxMenuBar*}{GetMenuBar}{\void}
265
266 Returns a pointer to the menubar currently associated with the frame (if any).
267
268 \wxheading{See also}
269
270 \helpref{wxFrame::SetMenuBar}{wxframesetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}
271
272 \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar}
273
274 \constfunc{wxStatusBar*}{GetStatusBar}{\void}
275
276 Returns a pointer to the status bar currently associated with the frame (if any).
277
278 \wxheading{See also}
279
280 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
281
282 \membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane}
283
284 \func{int}{GetStatusBarPane}{\void}
285
286 Returns the status bar pane used to display menu and toolbar help.
287
288 \wxheading{See also}
289
290 \helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane}
291
292 \membersection{wxFrame::GetTitle}\label{wxframegettitle}
293
294 \constfunc{wxString}{GetTitle}{\void}
295
296 Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}.
297
298 \membersection{wxFrame::GetToolBar}\label{wxframegettoolbar}
299
300 \constfunc{wxToolBar*}{GetToolBar}{\void}
301
302 Returns a pointer to the toolbar currently associated with the frame (if any).
303
304 \wxheading{See also}
305
306 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
307 \helpref{wxFrame::SetToolBar}{wxframesettoolbar}
308
309 \membersection{wxFrame::Iconize}\label{wxframeiconize}
310
311 \func{void}{Iconize}{\param{bool}{ iconize}}
312
313 Iconizes or restores the frame.
314
315 \wxheading{Parameters}
316
317 \docparam{iconize}{If true, iconizes the frame; if false, shows and restores it.}
318
319 \wxheading{See also}
320
321 \helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}.
322
323 \membersection{wxFrame::IsFullScreen}\label{wxframeisfullscreen}
324
325 \func{bool}{IsFullScreen}{\void}
326
327 Returns true if the frame is in fullscreen mode.
328
329 \wxheading{See also}
330
331 \helpref{wxFrame::ShowFullScreen}{wxframeshowfullscreen}
332
333 \membersection{wxFrame::IsIconized}\label{wxframeisiconized}
334
335 \constfunc{bool}{IsIconized}{\void}
336
337 Returns true if the frame is iconized.
338
339 \membersection{wxFrame::IsMaximized}\label{wxframeismaximized}
340
341 \constfunc{bool}{IsMaximized}{\void}
342
343 Returns true if the frame is maximized.
344
345 \membersection{wxFrame::Maximize}\label{wxframemaximize}
346
347 \func{void}{Maximize}{\param{bool }{maximize}}
348
349 Maximizes or restores the frame.
350
351 \wxheading{Parameters}
352
353 \docparam{maximize}{If true, maximizes the frame, otherwise it restores it.}
354
355 \wxheading{Remarks}
356
357 This function only works under Windows.
358
359 \wxheading{See also}
360
361 \helpref{wxFrame::Iconize}{wxframeiconize}
362
363 \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
364
365 \func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number},
366 \param{long}{ style},
367 \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}
368
369 Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}.
370
371 \wxheading{Parameters}
372
373 \docparam{number}{The number of fields to create.}
374
375 \docparam{style}{The window style. See \helpref{wxStatusBar}{wxstatusbar} for a list
376 of valid styles.}
377
378 \docparam{id}{The window identifier. If -1, an identifier will be chosen by
379 wxWindows.}
380
381 \docparam{name}{The window name.}
382
383 \wxheading{Return value}
384
385 A status bar object.
386
387 \wxheading{Remarks}
388
389 An application can override this function to return a different kind of status bar. The default
390 implementation returns an instance of \helpref{wxStatusBar}{wxstatusbar}.
391
392 \wxheading{See also}
393
394 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}.
395
396 \membersection{wxFrame::OnCreateToolBar}\label{wxframeoncreatetoolbar}
397
398 \func{virtual wxToolBar*}{OnCreateToolBar}{\param{long}{ style},
399 \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}
400
401 Virtual function called when a toolbar is requested by \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
402
403 \wxheading{Parameters}
404
405 \docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list
406 of valid styles.}
407
408 \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
409 wxWindows.}
410
411 \docparam{name}{The toolbar window name.}
412
413 \wxheading{Return value}
414
415 A toolbar object.
416
417 \wxheading{Remarks}
418
419 An application can override this function to return a different kind of toolbar. The default
420 implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
421
422 \wxheading{See also}
423
424 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
425
426 \membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent}
427
428 \func{void}{SendSizeEvent}{\void}
429
430 This function sends a dummy \helpref{size event}{wxsizeevent} to the frame
431 forcing it to reevaluate its children positions. It is sometimes useful to call
432 this function after adding or deleting a children after the frame creation or
433 if a child size changes.
434
435 Note that if the frame is using either sizers or constraints for the children
436 layout, it is enough to call \helpref{Layout()}{wxwindowlayout} directly and
437 this function should not be used in this case.
438
439 \membersection{wxFrame::SetIcon}\label{wxframeseticon}
440
441 \func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
442
443 Sets the icon for this frame.
444
445 \wxheading{Parameters}
446
447 \docparam{icon}{The icon to associate with this frame.}
448
449 \wxheading{Remarks}
450
451 The frame takes a `copy' of {\it icon}, but since it uses reference
452 counting, the copy is very quick. It is safe to delete {\it icon} after
453 calling this function.
454
455 See also \helpref{wxIcon}{wxicon}.
456
457 \membersection{wxFrame::SetIcons}\label{wxframeseticons}
458
459 \func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}
460
461 Sets the icons for this frame.
462
463 \wxheading{Parameters}
464
465 \docparam{icons}{The icons to associate with this frame.}
466
467 See also \helpref{wxIconBundle}{wxiconbundle}.
468
469 % VZ: we don't have all this any more (18.08.00)
470 %
471 %Under Windows, instead of using {\bf SetIcon}, you can add the
472 %following lines to your MS Windows resource file:
473 %
474 %\begin{verbatim}
475 %wxSTD_MDIPARENTFRAME ICON icon1.ico
476 %wxSTD_MDICHILDFRAME ICON icon2.ico
477 %wxSTD_FRAME ICON icon3.ico
478 %\end{verbatim}
479 %
480 %where icon1.ico will be used for the MDI parent frame, icon2.ico
481 %will be used for MDI child frames, and icon3.ico will be used for
482 %non-MDI frames.
483 %
484 %If these icons are not supplied, and {\bf SetIcon} is not called either,
485 %then the following defaults apply if you have included wx.rc.
486 %
487 %\begin{verbatim}
488 %wxDEFAULT_FRAME ICON std.ico
489 %wxDEFAULT_MDIPARENTFRAME ICON mdi.ico
490 %wxDEFAULT_MDICHILDFRAME ICON child.ico
491 %\end{verbatim}
492 %
493 %You can replace std.ico, mdi.ico and child.ico with your own defaults
494 %for all your wxWindows application. Currently they show the same icon.
495
496 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
497
498 \func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}}
499
500 Tells the frame to show the given menu bar.
501
502 \wxheading{Parameters}
503
504 \docparam{menuBar}{The menu bar to associate with the frame.}
505
506 \wxheading{Remarks}
507
508 If the frame is destroyed, the
509 menu bar and its menus will be destroyed also, so do not delete the menu
510 bar explicitly (except by resetting the frame's menu bar to another
511 frame or NULL).
512
513 Under Windows, a call to \helpref{wxFrame::OnSize}{wxframeonsize} is generated, so be sure to initialize
514 data members properly before calling {\bf SetMenuBar}.
515
516 Note that it is not possible to call this function twice for the same frame object.
517
518 \wxheading{See also}
519
520 \helpref{wxFrame::GetMenuBar}{wxframegetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}.
521
522 \membersection{wxFrame::SetShape}\label{wxframesetshape}
523
524 \func{bool}{SetShape}{\param{const wxRegion&}{ region}}
525
526 If the platform supports it, sets the shape of the window to that
527 depicted by \it{region}. The system will not display or
528 respond to any mouse event for the pixels that lie outside of the
529 region. To reset the window to the normal rectangular shape simply
530 call \it{SetShape} again with an empty region. Returns TRUE if the
531 operation is successful.
532
533 \membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar}
534
535 \func{void}{SetStatusBar}{\param{wxStatusBar*}{ statusBar}}
536
537 Associates a status bar with the frame.
538
539 \wxheading{See also}
540
541 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp
542 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
543
544 \membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane}
545
546 \func{void}{SetStatusBarPane}{\param{int}{ n}}
547
548 Set the status bar pane used to display menu and toolbar help.
549 Using -1 disables help display.
550
551 \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
552
553 \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}
554
555 Sets the status bar text and redraws the status bar.
556
557 \wxheading{Parameters}
558
559 \docparam{text}{The text for the status field.}
560
561 \docparam{number}{The status field (starting from zero).}
562
563 \wxheading{Remarks}
564
565 Use an empty string to clear the status bar.
566
567 \wxheading{See also}
568
569 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
570
571 \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths}
572
573 \func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}}
574
575 Sets the widths of the fields in the status bar.
576
577 \wxheading{Parameters}
578
579 \wxheading{n}{The number of fields in the status bar. It must be the
580 same used in \helpref{CreateStatusBar}{wxframecreatestatusbar}.}
581
582 \docparam{widths}{Must contain an array of {\it n} integers, each of which is a status field width
583 in pixels. A value of -1 indicates that the field is variable width; at least one
584 field must be -1. You should delete this array after calling {\bf SetStatusWidths}.}
585
586 \wxheading{Remarks}
587
588 The widths of the variable fields are calculated from the total width of all fields,
589 minus the sum of widths of the non-variable fields, divided by the number of
590 variable fields.
591
592 \pythonnote{Only a single parameter is required, a Python list of
593 integers.}
594
595 \perlnote{In wxPerl this method takes the field widths as parameters.}
596
597 \membersection{wxFrame::SetToolBar}\label{wxframesettoolbar}
598
599 \func{void}{SetToolBar}{\param{wxToolBar*}{ toolBar}}
600
601 Associates a toolbar with the frame.
602
603 \wxheading{See also}
604
605 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
606 \helpref{wxFrame::GetToolBar}{wxframegettoolbar}
607
608 \membersection{wxFrame::SetTitle}\label{wxframesettitle}
609
610 \func{virtual void}{SetTitle}{\param{const wxString\& }{ title}}
611
612 Sets the frame title.
613
614 \wxheading{Parameters}
615
616 \docparam{title}{The frame title.}
617
618 \wxheading{See also}
619
620 \helpref{wxFrame::GetTitle}{wxframegettitle}
621
622 \membersection{wxFrame::ShowFullScreen}\label{wxframeshowfullscreen}
623
624 \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}
625
626 Depending on the value of {\it show} parameter the frame is either shown full
627 screen or restored to its normal state. {\it style} is a bit list containing
628 some or all of the following values, which indicate what elements of the frame
629 to hide in full-screen mode:
630
631 \begin{itemize}\itemsep=0pt
632 \item wxFULLSCREEN\_NOMENUBAR
633 \item wxFULLSCREEN\_NOTOOLBAR
634 \item wxFULLSCREEN\_NOSTATUSBAR
635 \item wxFULLSCREEN\_NOBORDER
636 \item wxFULLSCREEN\_NOCAPTION
637 \item wxFULLSCREEN\_ALL (all of the above)
638 \end{itemize}
639
640 This function has not been tested with MDI frames.
641
642 Note that showing a frame full screen also actually
643 \helpref{Show()s}{wxwindowshow} if it hadn't been shown yet.
644
645 \wxheading{See also}
646
647 \helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}
648