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{wxTopLevelWindow}{wxtoplevelwindow}\\
  16 \helpref{wxWindow}{wxwindow}\\
  17 \helpref{wxEvtHandler}{wxevthandler}\\
  18 \helpref{wxObject}{wxobject}
  19
  20 \wxheading{Include files}
  21
  22 <wx/frame.h>
  23
  24 \wxheading{Window styles}
  25
  26 \twocolwidtha{5cm}
  27 \begin{twocollist}\itemsep=0pt
  28 \twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX}.}
  29 \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. }
  30 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
  31 \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.}
  32 \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame.}
  33 \twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized. Windows only.}
  34 \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame.}
  35 \twocolitem{\windowstyle{wxCLOSE\_BOX}}{Displays a close box on the frame.}
  36 \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of all other windows,
  37 see also wxFRAME\_FLOAT\_ON\_PARENT. Windows only.}
  38 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu.}
  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 or GTK+ (note that it
  44 will minimize to the desktop window under Windows which may seem strange to the
  45 users and thus it might be better to use this style only without
  46 wxMINIMIZE\_BOX style). In wxGTK, the flag is respected only if GTK+ is at
  47 least version 2.2 and the window manager supports
  48 \urlref{\_NET\_WM\_STATE\_SKIP\_TASKBAR}{http://freedesktop.org/Standards/wm-spec/1.3/ar01s05.html} hint.
  49 Has no effect under other platforms.}
  50 \twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{The frame will always be
  51 on top of its parent (unlike wxSTAY\_ON\_TOP). A frame created with this style
  52 must have a non-NULL parent.}
  53 \twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
  54 caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send
  55 a wxEVT\_HELP event if the user clicked on an application window. {\it Note} that this is an extended
  56 style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction).
  57 You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
  58 you should use\rtfsp
  59 {\tt wxDEFAULT\_FRAME\_STYLE \& ~ (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
  60 frames having this style (the dialogs don't have a minimize or a maximize box by
  61 default)}
  62 \twocolitem{\windowstyle{wxFRAME\_SHAPED}}{Windows with this style are
  63   allowed to have their shape changed with the \helpref{SetShape}{wxframesetshape} method.}
  64 \end{twocollist}
  65
  66 The default frame style is for normal, resizeable frames. To create a frame
  67 which can not be resized by user, you may use the following combination of
  68 styles: {\tt wxDEFAULT\_FRAME\_STYLE \& ~ (wxRESIZE\_BORDER \pipe wxRESIZE\_BOX \pipe wxMAXIMIZE\_BOX)}.
  69 % Note: the space after the tilde is necessary or Tex2RTF complains.
  70
  71 See also \helpref{window styles overview}{windowstyles}.
  72
  73 \wxheading{Default event processing}
  74
  75 wxFrame processes the following events:
  76
  77 \begin{twocollist}\itemsep=0pt
  78 \twocolitem{\helpref{wxEVT\_SIZE}{wxsizeevent}}{If the frame has exactly one
  79 child window, not counting the status and toolbar, this child is resized to
  80 take the entire frame client area. If two or more windows are present, they
  81 should be laid out explicitly either by manually handling wxEVT\_SIZE or using
  82 \helpref{sizers}{sizeroverview}}
  83
  84 \twocolitem{\helpref{wxEVT\_MENU\_HIGHLIGHT}{wxmenuevent}}{The default
  85 implementation displays the \helpref{help string}{wxmenuitemgethelp} associated
  86 with the selected item in the first pane of the status bar, if there is one.}
  87 \end{twocollist}
  88
  89 \wxheading{Remarks}
  90
  91 An application should normally define an \helpref{wxCloseEvent}{wxcloseevent} handler for the
  92 frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
  93
  94 \wxheading{See also}
  95
  96 \helpref{wxMDIParentFrame}{wxmdiparentframe}, \helpref{wxMDIChildFrame}{wxmdichildframe},\rtfsp
  97 \helpref{wxMiniFrame}{wxminiframe}, \helpref{wxDialog}{wxdialog}
  98
  99 \latexignore{\rtfignore{\wxheading{Members}}}
 100
 101 \membersection{wxFrame::wxFrame}\label{wxframeconstr}
 102
 103 \func{}{wxFrame}{\void}
 104
 105 Default constructor.
 106
 107 \func{}{wxFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 108 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 109 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 110 \param{const wxString\& }{name = ``frame"}}
 111
 112 Constructor, creating the window.
 113
 114 \wxheading{Parameters}
 115
 116 \docparam{parent}{The window parent. This may be NULL. If it is non-NULL, the frame will
 117 always be displayed on top of the parent window on Windows.}
 118
 119 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
 120
 121 \docparam{title}{The caption to be displayed on the frame's title bar.}
 122
 123 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
 124 either the windowing system or wxWidgets, depending on platform.}
 125
 126 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
 127 either the windowing system or wxWidgets, depending on platform.}
 128
 129 \docparam{style}{The window style. See \helpref{wxFrame}{wxframe}.}
 130
 131 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
 132 allowing the application user to set Motif resource values for
 133 individual windows.}
 134
 135 \wxheading{Remarks}
 136
 137 For Motif, MWM (the Motif Window Manager) should be running for any window styles to work
 138 (otherwise all styles take effect).
 139
 140 \wxheading{See also}
 141
 142 \helpref{wxFrame::Create}{wxframecreate}
 143
 144 \membersection{wxFrame::\destruct{wxFrame}}
 145
 146 \func{void}{\destruct{wxFrame}}{\void}
 147
 148 Destructor. Destroys all child windows and menu bar if present.
 149
 150 \membersection{wxFrame::Centre}\label{wxframecentre}
 151
 152 \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
 153
 154 Centres the frame on the display.
 155
 156 \wxheading{Parameters}
 157
 158 \docparam{direction}{The parameter may be {\tt wxHORIZONTAL}, {\tt wxVERTICAL} or {\tt wxBOTH}.}
 159
 160 \membersection{wxFrame::Command}\label{wxframecommand}
 161
 162 \func{void}{Command}{\param{int }{id}}
 163
 164 Simulate a menu command.
 165
 166 \wxheading{Parameters}
 167
 168 \docparam{id}{The identifier for a menu item.}
 169
 170 \membersection{wxFrame::Create}\label{wxframecreate}
 171
 172 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 173 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 174 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 175 \param{const wxString\& }{name = ``frame"}}
 176
 177 Used in two-step frame construction. See \helpref{wxFrame::wxFrame}{wxframeconstr}\rtfsp
 178 for further details.
 179
 180 \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar}
 181
 182 \func{virtual wxStatusBar*}{CreateStatusBar}{\param{int}{ number = 1},
 183  \param{long}{ style = 0},
 184  \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "statusBar"}}
 185
 186 Creates a status bar at the bottom of the frame.
 187
 188 \wxheading{Parameters}
 189
 190 \docparam{number}{The number of fields to create. Specify a
 191 value greater than 1 to create a multi-field status bar.}
 192
 193 \docparam{style}{The status bar style. See \helpref{wxStatusBar}{wxstatusbar} for a list
 194 of valid styles.}
 195
 196 \docparam{id}{The status bar window identifier. If -1, an identifier will be chosen by
 197 wxWidgets.}
 198
 199 \docparam{name}{The status bar window name.}
 200
 201 \wxheading{Return value}
 202
 203 A pointer to the the status bar if it was created successfully, NULL otherwise.
 204
 205 \wxheading{Remarks}
 206
 207 The width of the status bar is the whole width of the frame (adjusted automatically when
 208 resizing), and the height and text size are chosen by the host windowing system.
 209
 210 By default, the status bar is an instance of wxStatusBar. To use a different class,
 211 override \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar}.
 212
 213 Note that you can put controls and other windows on the status bar if you wish.
 214
 215 \wxheading{See also}
 216
 217 \helpref{wxFrame::SetStatusText}{wxframesetstatustext},\rtfsp
 218 \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar},\rtfsp
 219 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 220
 221 \membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar}
 222
 223 \func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxNO\_BORDER \pipe wxTB\_HORIZONTAL},
 224  \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}}
 225
 226 Creates a toolbar at the top or left of the frame.
 227
 228 \wxheading{Parameters}
 229
 230 \docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list
 231 of valid styles.}
 232
 233 \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
 234 wxWidgets.}
 235
 236 \docparam{name}{The toolbar window name.}
 237
 238 \wxheading{Return value}
 239
 240 A pointer to the the toolbar if it was created successfully, NULL otherwise.
 241
 242 \wxheading{Remarks}
 243
 244 By default, the toolbar is an instance of wxToolBar (which is defined to be
 245 a suitable toolbar class on each platform, such as wxToolBar95). To use a different class,
 246 override \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar}.
 247
 248 When a toolbar has been created with this function, or made known to the frame
 249 with \helpref{wxFrame::SetToolBar}{wxframesettoolbar}, the frame will manage the toolbar
 250 position and adjust the return value from \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} to
 251 reflect the available space for application windows.
 252
 253 \wxheading{See also}
 254
 255 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp
 256 \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar},\rtfsp
 257 \helpref{wxFrame::SetToolBar}{wxframesettoolbar},\rtfsp
 258 \helpref{wxFrame::GetToolBar}{wxframegettoolbar}
 259
 260 \membersection{wxFrame::GetClientAreaOrigin}\label{wxframegetclientareaorigin}
 261
 262 \constfunc{wxPoint}{GetClientAreaOrigin}{\void}
 263
 264 Returns the origin of the frame client area (in client coordinates). It may be
 265 different from (0, 0) if the frame has a toolbar.
 266
 267 \membersection{wxFrame::GetMenuBar}\label{wxframegetmenubar}
 268
 269 \constfunc{wxMenuBar*}{GetMenuBar}{\void}
 270
 271 Returns a pointer to the menubar currently associated with the frame (if any).
 272
 273 \wxheading{See also}
 274
 275 \helpref{wxFrame::SetMenuBar}{wxframesetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}
 276
 277 \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar}
 278
 279 \constfunc{wxStatusBar*}{GetStatusBar}{\void}
 280
 281 Returns a pointer to the status bar currently associated with the frame (if any).
 282
 283 \wxheading{See also}
 284
 285 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
 286
 287 \membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane}
 288
 289 \func{int}{GetStatusBarPane}{\void}
 290
 291 Returns the status bar pane used to display menu and toolbar help.
 292
 293 \wxheading{See also}
 294
 295 \helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane}
 296
 297 \membersection{wxFrame::GetToolBar}\label{wxframegettoolbar}
 298
 299 \constfunc{wxToolBar*}{GetToolBar}{\void}
 300
 301 Returns a pointer to the toolbar currently associated with the frame (if any).
 302
 303 \wxheading{See also}
 304
 305 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
 306 \helpref{wxFrame::SetToolBar}{wxframesettoolbar}
 307
 308 \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar}
 309
 310 \func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number},
 311  \param{long}{ style},
 312  \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}
 313
 314 Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}.
 315
 316 \wxheading{Parameters}
 317
 318 \docparam{number}{The number of fields to create.}
 319
 320 \docparam{style}{The window style. See \helpref{wxStatusBar}{wxstatusbar} for a list
 321 of valid styles.}
 322
 323 \docparam{id}{The window identifier. If -1, an identifier will be chosen by
 324 wxWidgets.}
 325
 326 \docparam{name}{The window name.}
 327
 328 \wxheading{Return value}
 329
 330 A status bar object.
 331
 332 \wxheading{Remarks}
 333
 334 An application can override this function to return a different kind of status bar. The default
 335 implementation returns an instance of \helpref{wxStatusBar}{wxstatusbar}.
 336
 337 \wxheading{See also}
 338
 339 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}.
 340
 341 \membersection{wxFrame::OnCreateToolBar}\label{wxframeoncreatetoolbar}
 342
 343 \func{virtual wxToolBar*}{OnCreateToolBar}{\param{long}{ style},
 344  \param{wxWindowID}{ id}, \param{const wxString\&}{ name}}
 345
 346 Virtual function called when a toolbar is requested by \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
 347
 348 \wxheading{Parameters}
 349
 350 \docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list
 351 of valid styles.}
 352
 353 \docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by
 354 wxWidgets.}
 355
 356 \docparam{name}{The toolbar window name.}
 357
 358 \wxheading{Return value}
 359
 360 A toolbar object.
 361
 362 \wxheading{Remarks}
 363
 364 An application can override this function to return a different kind of toolbar. The default
 365 implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
 366
 367 \wxheading{See also}
 368
 369 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
 370
 371 \membersection{wxFrame::SendSizeEvent}\label{wxframesendsizeevent}
 372
 373 \func{void}{SendSizeEvent}{\void}
 374
 375 This function sends a dummy \helpref{size event}{wxsizeevent} to the frame
 376 forcing it to reevaluate its children positions. It is sometimes useful to call
 377 this function after adding or deleting a children after the frame creation or
 378 if a child size changes.
 379
 380 Note that if the frame is using either sizers or constraints for the children
 381 layout, it is enough to call \helpref{Layout()}{wxwindowlayout} directly and
 382 this function should not be used in this case.
 383
 384 % VZ: we don't have all this any more (18.08.00)
 385 %
 386 %Under Windows, instead of using {\bf SetIcon}, you can add the
 387 %following lines to your MS Windows resource file:
 388 %
 389 %\begin{verbatim}
 390 %wxSTD_MDIPARENTFRAME ICON icon1.ico
 391 %wxSTD_MDICHILDFRAME  ICON icon2.ico
 392 %wxSTD_FRAME          ICON icon3.ico
 393 %\end{verbatim}
 394 %
 395 %where icon1.ico will be used for the MDI parent frame, icon2.ico
 396 %will be used for MDI child frames, and icon3.ico will be used for
 397 %non-MDI frames.
 398 %
 399 %If these icons are not supplied, and {\bf SetIcon} is not called either,
 400 %then the following defaults apply if you have included wx.rc.
 401 %
 402 %\begin{verbatim}
 403 %wxDEFAULT_FRAME               ICON std.ico
 404 %wxDEFAULT_MDIPARENTFRAME      ICON mdi.ico
 405 %wxDEFAULT_MDICHILDFRAME       ICON child.ico
 406 %\end{verbatim}
 407 %
 408 %You can replace std.ico, mdi.ico and child.ico with your own defaults
 409 %for all your wxWidgets application. Currently they show the same icon.
 410
 411 \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar}
 412
 413 \func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}}
 414
 415 Tells the frame to show the given menu bar.
 416
 417 \wxheading{Parameters}
 418
 419 \docparam{menuBar}{The menu bar to associate with the frame.}
 420
 421 \wxheading{Remarks}
 422
 423 If the frame is destroyed, the
 424 menu bar and its menus will be destroyed also, so do not delete the menu
 425 bar explicitly (except by resetting the frame's menu bar to another
 426 frame or NULL).
 427
 428 Under Windows, a size event is generated, so be sure to initialize
 429 data members properly before calling {\bf SetMenuBar}.
 430
 431 Note that on some platforms, it is not possible to call this function twice for the same frame object.
 432
 433 \wxheading{See also}
 434
 435 \helpref{wxFrame::GetMenuBar}{wxframegetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}.
 436
 437 \membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar}
 438
 439 \func{void}{SetStatusBar}{\param{wxStatusBar*}{ statusBar}}
 440
 441 Associates a status bar with the frame.
 442
 443 \wxheading{See also}
 444
 445 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp
 446 \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
 447
 448 \membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane}
 449
 450 \func{void}{SetStatusBarPane}{\param{int}{ n}}
 451
 452 Set the status bar pane used to display menu and toolbar help.
 453 Using -1 disables help display.
 454
 455 \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
 456
 457 \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}
 458
 459 Sets the status bar text and redraws the status bar.
 460
 461 \wxheading{Parameters}
 462
 463 \docparam{text}{The text for the status field.}
 464
 465 \docparam{number}{The status field (starting from zero).}
 466
 467 \wxheading{Remarks}
 468
 469 Use an empty string to clear the status bar.
 470
 471 \wxheading{See also}
 472
 473 \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
 474
 475 \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths}
 476
 477 \func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}}
 478
 479 Sets the widths of the fields in the status bar.
 480
 481 \wxheading{Parameters}
 482
 483 \wxheading{n}{The number of fields in the status bar. It must be the
 484 same used in \helpref{CreateStatusBar}{wxframecreatestatusbar}.}
 485
 486 \docparam{widths}{Must contain an array of {\it n} integers, each of which is a status field width
 487 in pixels. A value of -1 indicates that the field is variable width; at least one
 488 field must be -1. You should delete this array after calling {\bf SetStatusWidths}.}
 489
 490 \wxheading{Remarks}
 491
 492 The widths of the variable fields are calculated from the total width of all fields,
 493 minus the sum of widths of the non-variable fields, divided by the number of
 494 variable fields.
 495
 496 \pythonnote{Only a single parameter is required, a Python list of
 497 integers.}
 498
 499 \perlnote{In wxPerl this method takes the field widths as parameters.}
 500
 501 \membersection{wxFrame::SetToolBar}\label{wxframesettoolbar}
 502
 503 \func{void}{SetToolBar}{\param{wxToolBar*}{ toolBar}}
 504
 505 Associates a toolbar with the frame.
 506
 507 \wxheading{See also}
 508
 509 \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp
 510 \helpref{wxFrame::GetToolBar}{wxframegettoolbar}
 511