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