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\_BOX \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.}
  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{wxSTAY\_ON\_TOP}}{Stay on top of other windows. Windows only.}
  35 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu.}
  36 \twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays no border or decorations. GTK and Windows only.}
  37 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.}
  38 \twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small
  39 titlebar to be created; the frame does not appear in the taskbar under Windows.}
  40 \twocolitem{\windowstyle{wxFRAME\_NO\_TASKBAR}}{Creates a normal frame but if
  41 this frame has a parent it does not appear in the taskbar under Windows. Note
  42 that a frame without parent will still appear in the taskbar even with this
  43 style. Has no effect under other platforms.}
  44 \twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{Unused any longer, use
  45 wxFRAME\_TOOL\_WINDOW or wxFRAME\_NO\_TASKBAR instead}
  46 \twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
  47 caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send
  48 a wxEVT\_HELP event if the user clicked on an application window. {\it Note} that this is an extended
  49 style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction).
  50 You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX.}
  51 \end{twocollist}
  52
  53 The default frame style is for normal, resizeable frames. To create a frame
  54 which can not be resized by user, you may use the following combination of
  55 styles: {\tt wxDEFAULT\_FRAME\_STYLE \& \~ (wxRESIZE\_BORDER \pipe wxRESIZE\_BOX \pipe wxMAXIMIZE\_BOX)}.
  56 % Note: the space after the tilde is necessary or Tex2RTF complains.
  57
  58 See also \helpref{window styles overview}{windowstyles}.
  59
  60 \wxheading{Remarks}
  61
  62 An application should normally define an \helpref{OnCloseWindow}{wxwindowonclosewindow} handler for the
  63 frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
  64
  65 \wxheading{See also}
  66
  67 \helpref{wxMDIParentFrame}{wxmdiparentframe}, \helpref{wxMDIChildFrame}{wxmdichildframe},\rtfsp
  68 \helpref{wxMiniFrame}{wxminiframe}, \helpref{wxDialog}{wxdialog}
  69
  70 \latexignore{\rtfignore{\wxheading{Members}}}
  71
  72 \membersection{wxFrame::wxFrame}\label{wxframeconstr}
  73
  74 \func{}{wxFrame}{\void}
  75
  76 Default constructor.
  77
  78 \func{}{wxFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
  79 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
  80 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
  81 \param{const wxString\& }{name = ``frame"}}
  82
  83 Constructor, creating the window.
  84
  85 \wxheading{Parameters}
  86
  87 \docparam{parent}{The window parent. This may be NULL. If it is non-NULL, the frame will
  88 always be displayed on top of the parent window on Windows.}
  89
  90 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
  91
  92 \docparam{title}{The caption to be displayed on the frame's title bar.}
  93
  94 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
  95 either the windowing system or wxWindows, depending on platform.}
  96
  97 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
  98 either the windowing system or wxWindows, depending on platform.}
  99
 100 \docparam{style}{The window style. See \helpref{wxFrame}{wxframe}.}
 101
 102 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
 103 allowing the application user to set Motif resource values for
 104 individual windows.}
 105
 106 \wxheading{Remarks}
 107
 108 For Motif, MWM (the Motif Window Manager) should be running for any window styles to work
 109 (otherwise all styles take effect).
 110
 111 \wxheading{See also}
 112
 113 \helpref{wxFrame::Create}{wxframecreate}
 114
 115 \membersection{wxFrame::\destruct{wxFrame}}
 116
 117 \func{void}{\destruct{wxFrame}}{\void}
 118
 119 Destructor. Destroys all child windows and menu bar if present.
 120
 121 \membersection{wxFrame::Centre}\label{wxframecentre}
 122
 123 \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
 124
 125 Centres the frame on the display.
 126
 127 \wxheading{Parameters}
 128
 129 \docparam{direction}{The parameter may be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.}
 130
 131 \membersection{wxFrame::Command}\label{wxframecommand}
 132
 133 \func{void}{Command}{\param{int }{id}}
 134
 135 Simulate a menu command.
 136
 137 \wxheading{Parameters}
 138
 139 \docparam{id}{The identifier for a menu item.}
 140
 141 \membersection{wxFrame::Create}\label{wxframecreate}
 142
 143 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 144 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 145 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 146 \param{const wxString\& }{name = ``frame"}}
 147
 148 Used in two-step frame construction. See \helpref{wxFrame::wxFrame}{wxframeconstr}\rtfsp
 149 for further details.
 150
 151 \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar}
 152
 153 \func{virtual wxStatusBar*}{CreateStatusBar}{\param{int}{ number = 1},
 154  \param{long}{ style = 0},
 155  \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "statusBar"}}
 156
 157 Creates a status bar at the bottom of the frame.
 158
 159 \wxheading{Parameters}
 160
 161 \docparam{number}{The number of fields to create. Specify a
 162 value greater than 1 to create a multi-field status bar.}
 163
 164 \docparam{style}{The status bar style. See \helpref{wxStatusBar}{wxstatusbar} for a list
 165 of valid styles.}
 166
 167 \docparam{id}{The status bar window identifier. If -1, an identifier will be chosen by
 168 wxWindows.}
 169
 170 \docparam{name}{The status bar window name.}
 171
 172 \wxheading{Return value}
 173
 174 A pointer to the the status bar if it was created successfully, NULL otherwise.
 175
 176 \wxheading{Remarks}
 177
 178 The width of the status bar is the whole width of the frame (adjusted automatically when
 179 resizing), and the height and text size are chosen by the host windowing system.
 180
 181 By default, the status bar is an instance of wxStatusBar. To use a different class,
 182 override \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar}.
 183
 184 Note that you can put controls and other windows on the status bar if you wish.
 185
 186 \wxheading{See also}
 187
 188 \helpref{wxFrame::SetStatusText}{wxframesetstatustext},\rtfsp
 189 \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar},\rtfsp
 190 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 191
 192 \membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar}
 193
 194 \func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxNO\_BORDER \pipe wxTB\_HORIZONTAL},
 195  \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}}
 196
 197 Creates a toolbar at the top or left of the frame.
 198
 199 \wxheading{Parameters}
 200
 201 \docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list
 202 of valid styles.}
 203
 204 \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
 205 wxWindows.}
 206
 207 \docparam{name}{The toolbar window name.}
 208
 209 \wxheading{Return value}
 210
 211 A pointer to the the toolbar if it was created successfully, NULL otherwise.
 212
 213 \wxheading{Remarks}
 214
 215 By default, the toolbar is an instance of wxToolBar (which is defined to be
 216 a suitable toolbar class on each platform, such as wxToolBar95). To use a different class,
 217 override \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar}.
 218
 219 When a toolbar has been created with this function, or made known to the frame
 220 with \helpref{wxFrame::SetToolBar}{wxframesettoolbar}, the frame will manage the toolbar
 221 position and adjust the return value from \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} to
 222 reflect the available space for application windows.
 223
 224 \wxheading{See also}
 225
 226 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp
 227 \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar},\rtfsp
 228 \helpref{wxFrame::SetToolBar}{wxframesettoolbar},\rtfsp
 229 \helpref{wxFrame::GetToolBar}{wxframegettoolbar}
 230
 231 \membersection{wxFrame::GetClientAreaOrigin}\label{wxframegetclientareaorigin}
 232
 233 \constfunc{wxPoint}{GetClientAreaOrigin}{\void}
 234
 235 Returns the origin of the frame client area (in client coordinates). It may be
 236 different from (0, 0) if the frame has a toolbar.
 237
 238 \membersection{wxFrame::GetMenuBar}\label{wxframegetmenubar}
 239
 240 \constfunc{wxMenuBar*}{GetMenuBar}{\void}
 241
 242 Returns a pointer to the menubar currently associated with the frame (if any).
 243
 244 \wxheading{See also}
 245
 246 \helpref{wxFrame::SetMenuBar}{wxframesetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}
 247
 248 \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar}
 249
 250 \constfunc{wxStatusBar*}{GetStatusBar}{\void}
 251
 252 Returns a pointer to the status bar currently associated with the frame (if any).
 253
 254 \wxheading{See also}
 255
 256 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
 257
 258 \membersection{wxFrame::GetTitle}\label{wxframegettitle}
 259
 260 \constfunc{wxString}{GetTitle}{\void}
 261
 262 Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}.
 263
 264 \membersection{wxFrame::GetToolBar}\label{wxframegettoolbar}
 265
 266 \constfunc{wxToolBar*}{GetToolBar}{\void}
 267
 268 Returns a pointer to the toolbar currently associated with the frame (if any).
 269
 270 \wxheading{See also}
 271
 272 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
 273 \helpref{wxFrame::SetToolBar}{wxframesettoolbar}
 274
 275 \membersection{wxFrame::Iconize}\label{wxframeiconize}
 276
 277 \func{void}{Iconize}{\param{bool}{ iconize}}
 278
 279 Iconizes or restores the frame. Windows only.
 280
 281 \wxheading{Parameters}
 282
 283 \docparam{izonize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.}
 284
 285 \wxheading{See also}
 286
 287 \helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}.
 288
 289 \membersection{wxFrame::IsFullScreen}\label{wxframeisfullscreen}
 290
 291 \func{bool}{IsFullScreen}{\void}
 292
 293 Returns TRUE if the frame is in fullscreen mode.
 294
 295 \wxheading{See also}
 296
 297 \helpref{wxFrame::ShowFullScreen}{wxframeshowfullscreen}
 298
 299 \membersection{wxFrame::IsIconized}\label{wxframeisiconized}
 300
 301 \constfunc{bool}{IsIconized}{\void}
 302
 303 Returns TRUE if the frame is iconized. Windows only.
 304
 305 \membersection{wxFrame::IsMaximized}\label{wxframeismaximized}
 306
 307 \constfunc{bool}{IsMaximized}{\void}
 308
 309 Returns TRUE if the frame is maximized.
 310
 311 \membersection{wxFrame::Maximize}\label{wxframemaximize}
 312
 313 \func{void}{Maximize}{\param{bool }{maximize}}
 314
 315 Maximizes or restores the frame.
 316
 317 \wxheading{Parameters}
 318
 319 \docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it.}
 320
 321 \wxheading{Remarks}
 322
 323 This function only works under Windows.
 324
 325 \wxheading{See also}
 326
 327 \helpref{wxFrame::Iconize}{wxframeiconize}
 328
 329 \membersection{wxFrame::OnActivate}
 330
 331 \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
 332
 333 Called when a window is activated or deactivated (MS Windows
 334 only). See also \helpref{wxActivateEvent}{wxactivateevent}.
 335
 336 \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
 337
 338 \func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number},
 339  \param{long}{ style},
 340  \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}
 341
 342 Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}.
 343
 344 \wxheading{Parameters}
 345
 346 \docparam{number}{The number of fields to create.}
 347
 348 \docparam{style}{The window style. See \helpref{wxStatusBar}{wxstatusbar} for a list
 349 of valid styles.}
 350
 351 \docparam{id}{The window identifier. If -1, an identifier will be chosen by
 352 wxWindows.}
 353
 354 \docparam{name}{The window name.}
 355
 356 \wxheading{Return value}
 357
 358 A status bar object.
 359
 360 \wxheading{Remarks}
 361
 362 An application can override this function to return a different kind of status bar. The default
 363 implementation returns an instance of \helpref{wxStatusBar}{wxstatusbar}.
 364
 365 \wxheading{See also}
 366
 367 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}.
 368
 369 \membersection{wxFrame::OnCreateToolBar}\label{wxframeoncreatetoolbar}
 370
 371 \func{virtual wxToolBar*}{OnCreateToolBar}{\param{long}{ style},
 372  \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}
 373
 374 Virtual function called when a toolbar is requested by \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
 375
 376 \wxheading{Parameters}
 377
 378 \docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list
 379 of valid styles.}
 380
 381 \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
 382 wxWindows.}
 383
 384 \docparam{name}{The toolbar window name.}
 385
 386 \wxheading{Return value}
 387
 388 A toolbar object.
 389
 390 \wxheading{Remarks}
 391
 392 An application can override this function to return a different kind of toolbar. The default
 393 implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
 394
 395 \wxheading{See also}
 396
 397 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
 398
 399 \membersection{wxFrame::OnMenuCommand}\label{wxframeonmenucommand}
 400
 401 \func{void}{OnMenuCommand}{\param{wxCommandEvent\&}{ event}}
 402
 403 See \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand}.
 404
 405 \membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight}
 406
 407 \func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}}
 408
 409 See \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}.
 410
 411 \membersection{wxFrame::OnSize}\label{wxframeonsize}
 412
 413 \func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
 414
 415 See \helpref{wxWindow::OnSize}{wxwindowonsize}.
 416
 417 The default {\bf wxFrame::OnSize} implementation looks for a single subwindow,
 418 and if one is found, resizes it to fit
 419 inside the frame. Override this member if more complex behaviour
 420 is required (for example, if there are several subwindows).
 421
 422 \membersection{wxFrame::SetIcon}\label{wxframeseticon}
 423
 424 \func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
 425
 426 Sets the icon for this frame.
 427
 428 \wxheading{Parameters}
 429
 430 \docparam{icon}{The icon to associate with this frame.}
 431
 432 \wxheading{Remarks}
 433
 434 The frame takes a `copy' of {\it icon}, but since it uses reference
 435 counting, the copy is very quick. It is safe to delete {\it icon} after
 436 calling this function.
 437
 438 % VZ: we don't have all this any more (18.08.00)
 439 %
 440 %Under Windows, instead of using {\bf SetIcon}, you can add the
 441 %following lines to your MS Windows resource file:
 442 %
 443 %\begin{verbatim}
 444 %wxSTD_MDIPARENTFRAME ICON icon1.ico
 445 %wxSTD_MDICHILDFRAME  ICON icon2.ico
 446 %wxSTD_FRAME          ICON icon3.ico
 447 %\end{verbatim}
 448 %
 449 %where icon1.ico will be used for the MDI parent frame, icon2.ico
 450 %will be used for MDI child frames, and icon3.ico will be used for
 451 %non-MDI frames.
 452 %
 453 %If these icons are not supplied, and {\bf SetIcon} is not called either,
 454 %then the following defaults apply if you have included wx.rc.
 455 %
 456 %\begin{verbatim}
 457 %wxDEFAULT_FRAME               ICON std.ico
 458 %wxDEFAULT_MDIPARENTFRAME      ICON mdi.ico
 459 %wxDEFAULT_MDICHILDFRAME       ICON child.ico
 460 %\end{verbatim}
 461 %
 462 %You can replace std.ico, mdi.ico and child.ico with your own defaults
 463 %for all your wxWindows application. Currently they show the same icon.
 464
 465 See also \helpref{wxIcon}{wxicon}.
 466
 467 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 468
 469 \func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}}
 470
 471 Tells the frame to show the given menu bar.
 472
 473 \wxheading{Parameters}
 474
 475 \docparam{menuBar}{The menu bar to associate with the frame.}
 476
 477 \wxheading{Remarks}
 478
 479 If the frame is destroyed, the
 480 menu bar and its menus will be destroyed also, so do not delete the menu
 481 bar explicitly (except by resetting the frame's menu bar to another
 482 frame or NULL).
 483
 484 Under Windows, a call to \helpref{wxFrame::OnSize}{wxframeonsize} is generated, so be sure to initialize
 485 data members properly before calling {\bf SetMenuBar}.
 486
 487 Note that it is not possible to call this function twice for the same frame object.
 488
 489 \wxheading{See also}
 490
 491 \helpref{wxFrame::GetMenuBar}{wxframegetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}.
 492
 493 \membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar}
 494
 495 \func{void}{SetStatusBar}{\param{wxStatusBar*}{ statusBar}}
 496
 497 Associates a status bar with the frame.
 498
 499 \wxheading{See also}
 500
 501 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp
 502 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 503
 504 \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
 505
 506 \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}
 507
 508 Sets the status bar text and redraws the status bar.
 509
 510 \wxheading{Parameters}
 511
 512 \docparam{text}{The text for the status field.}
 513
 514 \docparam{number}{The status field (starting from zero).}
 515
 516 \wxheading{Remarks}
 517
 518 Use an empty string to clear the status bar.
 519
 520 \wxheading{See also}
 521
 522 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
 523
 524 \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths}
 525
 526 \func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}}
 527
 528 Sets the widths of the fields in the status bar.
 529
 530 \wxheading{Parameters}
 531
 532 \wxheading{n}{The number of fields in the status bar. It must be the
 533 same used in \helpref{CreateStatusBar}{wxframecreatestatusbar}.}
 534
 535 \docparam{widths}{Must contain an array of {\it n} integers, each of which is a status field width
 536 in pixels. A value of -1 indicates that the field is variable width; at least one
 537 field must be -1. You should delete this array after calling {\bf SetStatusWidths}.}
 538
 539 \wxheading{Remarks}
 540
 541 The widths of the variable fields are calculated from the total width of all fields,
 542 minus the sum of widths of the non-variable fields, divided by the number of
 543 variable fields.
 544
 545 \pythonnote{Only a single parameter is required, a Python list of
 546 integers.}
 547
 548 \perlnote{In wxPerl this method takes the field widths as parameters.}
 549
 550 \membersection{wxFrame::SetToolBar}\label{wxframesettoolbar}
 551
 552 \func{void}{SetToolBar}{\param{wxToolBar*}{ toolBar}}
 553
 554 Associates a toolbar with the frame.
 555
 556 \wxheading{See also}
 557
 558 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
 559 \helpref{wxFrame::GetToolBar}{wxframegettoolbar}
 560
 561 \membersection{wxFrame::SetTitle}\label{wxframesettitle}
 562
 563 \func{virtual void}{SetTitle}{\param{const wxString\& }{ title}}
 564
 565 Sets the frame title.
 566
 567 \wxheading{Parameters}
 568
 569 \docparam{title}{The frame title.}
 570
 571 \wxheading{See also}
 572
 573 \helpref{wxFrame::GetTitle}{wxframegettitle}
 574
 575 \membersection{wxFrame::ShowFullScreen}\label{wxframeshowfullscreen}
 576
 577 \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}
 578
 579 Passing TRUE to {\it shows} shows the frame full-screen, and passing FALSE restores the frame
 580 again. {\it style} is a bit list containing some or all of the following values, which
 581 indicate what elements of the frame to hide in full-screen mode:
 582
 583 \begin{itemize}\itemsep=0pt
 584 \item wxFULLSCREEN\_NOMENUBAR
 585 \item wxFULLSCREEN\_NOTOOLBAR
 586 \item wxFULLSCREEN\_NOSTATUSBAR
 587 \item wxFULLSCREEN\_NOBORDER
 588 \item wxFULLSCREEN\_NOCAPTION
 589 \item wxFULLSCREEN\_ALL (all of the above)
 590 \end{itemize}
 591
 592 This function has not been tested with MDI frames.
 593
 594 \wxheading{See also}
 595
 596 \helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}