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