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