docs/latex/wx/mdi.tex

   1 \section{\class{wxMDIChildFrame}}\label{wxmdichildframe}
   2
   3 An MDI child frame is a frame that can only exist on a \helpref{wxMDIClientWindow}{wxmdiclientwindow},
   4 which is itself a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxFrame}{wxframe}\\
   9 \helpref{wxWindow}{wxwindow}\\
  10 \helpref{wxEvtHandler}{wxevthandler}\\
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/mdi.h>
  16
  17 \wxheading{Library}
  18
  19 \helpref{wxCore}{librarieslist}
  20
  21 \wxheading{Window styles}
  22
  23 \twocolwidtha{5cm}
  24 \begin{twocollist}\itemsep=0pt
  25 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
  26 \twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxTHICK\_FRAME \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.}
  27 \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized) (Windows only).}
  28 \twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized (Windows only).}
  29 \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame (Windows and Motif only).}
  30 \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}.}
  31 \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame (Windows and Motif only).}
  32 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Motif only;
  33 for Windows, it is implicit in wxTHICK\_FRAME).}
  34 \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows (Windows only).}
  35 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu (Windows and Motif only).}
  36 \twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).}
  37 \end{twocollist}
  38
  39 See also \helpref{window styles overview}{windowstyles}.
  40
  41 \wxheading{Remarks}
  42
  43 Although internally an MDI child frame is a child of the MDI client window, in wxWidgets
  44 you create it as a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}. You can usually
  45 forget that the client window exists.
  46
  47 MDI child frames are clipped to the area of the MDI client window, and may be iconized
  48 on the client window.
  49
  50 You can associate a menubar with a child frame as usual, although an MDI child doesn't display
  51 its menubar under its own title bar. The MDI parent frame's menubar will be changed to
  52 reflect the currently active child frame. If there are currently no children, the parent
  53 frame's own menubar will be displayed.
  54
  55 \wxheading{See also}
  56
  57 \helpref{wxMDIClientWindow}{wxmdiclientwindow}, \helpref{wxMDIParentFrame}{wxmdiparentframe},\rtfsp
  58 \helpref{wxFrame}{wxframe}
  59
  60 \latexignore{\rtfignore{\wxheading{Members}}}
  61
  62 \membersection{wxMDIChildFrame::wxMDIChildFrame}\label{wxmdichildframector}
  63
  64 \func{}{wxMDIChildFrame}{\void}
  65
  66 Default constructor.
  67
  68 \func{}{wxMDIChildFrame}{\param{wxMDIParentFrame* }{parent}, \param{wxWindowID }{id},\rtfsp
  69 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
  70 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
  71 \param{const wxString\& }{name = ``frame"}}
  72
  73 Constructor, creating the window.
  74
  75 \wxheading{Parameters}
  76
  77 \docparam{parent}{The window parent. This should not be NULL.}
  78
  79 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
  80
  81 \docparam{title}{The caption to be displayed on the frame's title bar.}
  82
  83 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
  84 either the windowing system or wxWidgets, depending on platform.}
  85
  86 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
  87 either the windowing system or wxWidgets, depending on platform.}
  88
  89 \docparam{style}{The window style. See \helpref{wxMDIChildFrame}{wxmdichildframe}.}
  90
  91 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
  92 allowing the application user to set Motif resource values for
  93 individual windows.}
  94
  95 \wxheading{Remarks}
  96
  97 None.
  98
  99 \wxheading{See also}
 100
 101 \helpref{wxMDIChildFrame::Create}{wxmdichildframecreate}
 102
 103 \membersection{wxMDIChildFrame::\destruct{wxMDIChildFrame}}\label{wxmdichildframedtor}
 104
 105 \func{}{\destruct{wxMDIChildFrame}}{\void}
 106
 107 Destructor. Destroys all child windows and menu bar if present.
 108
 109 \membersection{wxMDIChildFrame::Activate}\label{wxmdichildframeactivate}
 110
 111 \func{void}{Activate}{\void}
 112
 113 Activates this MDI child frame.
 114
 115 \wxheading{See also}
 116
 117 \helpref{wxMDIChildFrame::Maximize}{wxmdichildframemaximize},\rtfsp
 118 \helpref{wxMDIChildFrame::Restore}{wxmdichildframerestore}
 119
 120 \membersection{wxMDIChildFrame::Create}\label{wxmdichildframecreate}
 121
 122 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 123 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 124 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 125 \param{const wxString\& }{name = ``frame"}}
 126
 127 Used in two-step frame construction. See \helpref{wxMDIChildFrame::wxMDIChildFrame}{wxmdichildframector}\rtfsp
 128 for further details.
 129
 130 \membersection{wxMDIChildFrame::Maximize}\label{wxmdichildframemaximize}
 131
 132 \func{void}{Maximize}{\param{bool}{maximize}}
 133
 134 Maximizes this MDI child frame.
 135
 136 \wxheading{See also}
 137
 138 \helpref{wxMDIChildFrame::Activate}{wxmdichildframeactivate},\rtfsp
 139 \helpref{wxMDIChildFrame::Restore}{wxmdichildframerestore}
 140
 141 \membersection{wxMDIChildFrame::Restore}\label{wxmdichildframerestore}
 142
 143 \func{void}{Restore}{\void}
 144
 145 Restores this MDI child frame (unmaximizes).
 146
 147 \wxheading{See also}
 148
 149 \helpref{wxMDIChildFrame::Activate}{wxmdichildframeactivate},\rtfsp
 150 \helpref{wxMDIChildFrame::Maximize}{wxmdichildframemaximize}
 151
 152 \section{\class{wxMDIClientWindow}}\label{wxmdiclientwindow}
 153
 154 An MDI client window is a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}, and manages zero or
 155 more \helpref{wxMDIChildFrame}{wxmdichildframe} objects.
 156
 157 \wxheading{Derived from}
 158
 159 \helpref{wxWindow}{wxwindow}\\
 160 \helpref{wxEvtHandler}{wxevthandler}\\
 161 \helpref{wxObject}{wxobject}
 162
 163 \wxheading{Include files}
 164
 165 <wx/mdi.h>
 166
 167 \wxheading{Library}
 168
 169 \helpref{wxCore}{librarieslist}
 170
 171 \wxheading{Remarks}
 172
 173 The client window is the area where MDI child windows exist. It doesn't have to cover the whole
 174 parent frame; other windows such as toolbars and a help window might coexist with it.
 175 There can be scrollbars on a client window, which are controlled by the parent window style.
 176
 177 The {\bf wxMDIClientWindow} class is usually adequate without further derivation, and it is created
 178 automatically when the MDI parent frame is created. If the application needs to derive a new class,
 179 the function \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient} must be
 180 overridden in order to give an opportunity to use a different class of client window.
 181
 182 Under Windows 95, the client window will automatically have a sunken border style when
 183 the active child is not maximized, and no border style when a child is maximized.
 184
 185 \wxheading{See also}
 186
 187 \helpref{wxMDIChildFrame}{wxmdichildframe}, \helpref{wxMDIParentFrame}{wxmdiparentframe},\rtfsp
 188 \helpref{wxFrame}{wxframe}
 189
 190 \latexignore{\rtfignore{\wxheading{Members}}}
 191
 192 \membersection{wxMDIClientWindow::wxMDIClientWindow}\label{wxmdiclientwindowctor}
 193
 194 \func{}{wxMDIClientWindow}{\void}
 195
 196 Default constructor.
 197
 198 \func{}{wxMDIClientWindow}{\param{wxMDIParentFrame* }{parent}, \param{long}{ style = 0}}
 199
 200 Constructor, creating the window.
 201
 202 \wxheading{Parameters}
 203
 204 \docparam{parent}{The window parent.}
 205
 206 \docparam{style}{The window style. Currently unused.}
 207
 208 \wxheading{Remarks}
 209
 210 The second style of constructor is called within \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}.
 211
 212 \wxheading{See also}
 213
 214 \helpref{wxMDIParentFrame::wxMDIParentFrame}{wxmdiparentframector},\rtfsp
 215 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}
 216
 217 \membersection{wxMDIClientWindow::\destruct{wxMDIClientWindow}}\label{wxmdiclientwindowdtor}
 218
 219 \func{}{\destruct{wxMDIClientWindow}}{\void}
 220
 221 Destructor.
 222
 223 \membersection{wxMDIClientWindow::CreateClient}\label{wxmdiclientwindowcreateclient}
 224
 225 \func{bool}{CreateClient}{\param{wxMDIParentFrame* }{parent}, \param{long}{ style = 0}}
 226
 227 Used in two-step frame construction. See \helpref{wxMDIClientWindow::wxMDIClientWindow}{wxmdiclientwindowctor}\rtfsp
 228 for further details.
 229
 230 \section{\class{wxMDIParentFrame}}\label{wxmdiparentframe}
 231
 232 An MDI (Multiple Document Interface) parent frame is a window which can contain
 233 MDI child frames in its own `desktop'. It is a convenient way to avoid window clutter,
 234 and is used in many popular Windows applications, such as Microsoft Word(TM).
 235
 236 \wxheading{Derived from}
 237
 238 \helpref{wxFrame}{wxframe}\\
 239 \helpref{wxWindow}{wxwindow}\\
 240 \helpref{wxEvtHandler}{wxevthandler}\\
 241 \helpref{wxObject}{wxobject}
 242
 243 \wxheading{Include files}
 244
 245 <wx/mdi.h>
 246
 247 \wxheading{Library}
 248
 249 \helpref{wxCore}{librarieslist}
 250
 251 \wxheading{Remarks}
 252
 253 There may be multiple MDI parent frames in a single application, but this probably only makes sense
 254 within programming development environments.
 255
 256 Child frames may be of class \helpref{wxMDIChildFrame}{wxmdichildframe} (contained
 257 within the parent frame) or \helpref{wxFrame}{wxframe} (shown as a top-level frame).
 258
 259 An MDI parent frame always has a \helpref{wxMDIClientWindow}{wxmdiclientwindow} associated with it, which
 260 is the parent for MDI child frames.
 261 This client window may be resized to accommodate non-MDI windows, as seen in Microsoft Visual C++ (TM) and
 262 Microsoft Publisher (TM), where a documentation window is placed to one side of the workspace.
 263
 264 MDI remains popular despite dire warnings from Microsoft itself that MDI is an obsolete
 265 user interface style.
 266
 267 The implementation is native in Windows, and simulated under Motif. Under Motif,
 268 the child window frames will often have a different appearance from other frames
 269 because the window decorations are simulated.
 270
 271 \wxheading{Window styles}
 272
 273 \twocolwidtha{5cm}
 274 \begin{twocollist}\itemsep=0pt
 275 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
 276 \twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxTHICK\_FRAME \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.}
 277 \twocolitem{\windowstyle{wxHSCROLL}}{Displays a horizontal scrollbar in the {\it client window}, allowing
 278 the user to view child frames that are off the current view.}
 279 \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized) (Windows only).}
 280 \twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized (Windows only).}
 281 \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame (Windows and Motif only).}
 282 \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}.}
 283 \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame (Windows and Motif only).}
 284 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Motif only;
 285 for Windows, it is implicit in wxTHICK\_FRAME).}
 286 \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows (Windows only).}
 287 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu (Windows and Motif only).}
 288 \twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).}
 289 \twocolitem{\windowstyle{wxVSCROLL}}{Displays a vertical scrollbar in the {\it client window}, allowing
 290 the user to view child frames that are off the current view.}
 291 \twocolitem{\windowstyle{wxFRAME\_NO\_WINDOW\_MENU}}{Under Windows, removes the Window menu that is normally
 292 added automatically.}
 293 \end{twocollist}
 294
 295 See also \helpref{window styles overview}{windowstyles}.
 296
 297 \wxheading{See also}
 298
 299 \helpref{wxMDIChildFrame}{wxmdichildframe}, \helpref{wxMDIClientWindow}{wxmdiclientwindow},\rtfsp
 300 \helpref{wxFrame}{wxframe}, \helpref{wxDialog}{wxdialog}
 301
 302 \latexignore{\rtfignore{\wxheading{Members}}}
 303
 304 \membersection{wxMDIParentFrame::wxMDIParentFrame}\label{wxmdiparentframector}
 305
 306 \func{}{wxMDIParentFrame}{\void}
 307
 308 Default constructor.
 309
 310 \func{}{wxMDIParentFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 311 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 312 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp
 313 \param{const wxString\& }{name = ``frame"}}
 314
 315 Constructor, creating the window.
 316
 317 \wxheading{Parameters}
 318
 319 \docparam{parent}{The window parent. This should be NULL.}
 320
 321 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
 322
 323 \docparam{title}{The caption to be displayed on the frame's title bar.}
 324
 325 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
 326 either the windowing system or wxWidgets, depending on platform.}
 327
 328 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
 329 either the windowing system or wxWidgets, depending on platform.}
 330
 331 \docparam{style}{The window style. See \helpref{wxMDIParentFrame}{wxmdiparentframe}.}
 332
 333 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
 334 allowing the application user to set Motif resource values for
 335 individual windows.}
 336
 337 \wxheading{Remarks}
 338
 339 During the construction of the frame, the client window will be created. To use a different class
 340 from \helpref{wxMDIClientWindow}{wxmdiclientwindow}, override\rtfsp
 341 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}.
 342
 343 Under Windows 95, the client window will automatically have a sunken border style when
 344 the active child is not maximized, and no border style when a child is maximized.
 345
 346 \wxheading{See also}
 347
 348 \helpref{wxMDIParentFrame::Create}{wxmdiparentframecreate},\rtfsp
 349 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}
 350
 351 \membersection{wxMDIParentFrame::\destruct{wxMDIParentFrame}}\label{wxmdiparentframedtor}
 352
 353 \func{}{\destruct{wxMDIParentFrame}}{\void}
 354
 355 Destructor. Destroys all child windows and menu bar if present.
 356
 357 \membersection{wxMDIParentFrame::ActivateNext}\label{wxmdiparentframeactivatenext}
 358
 359 \func{void}{ActivateNext}{\void}
 360
 361 Activates the MDI child following the currently active one.
 362
 363 \wxheading{See also}
 364
 365 \helpref{wxMDIParentFrame::ActivatePrevious}{wxmdiparentframeactivateprevious}
 366
 367 \membersection{wxMDIParentFrame::ActivatePrevious}\label{wxmdiparentframeactivateprevious}
 368
 369 \func{void}{ActivatePrevious}{\void}
 370
 371 Activates the MDI child preceding the currently active one.
 372
 373 \wxheading{See also}
 374
 375 \helpref{wxMDIParentFrame::ActivateNext}{wxmdiparentframeactivatenext}
 376
 377
 378 \membersection{wxMDIParentFrame::ArrangeIcons}\label{wxmdiparentframearrangeicons}
 379
 380 \func{void}{ArrangeIcons}{\void}
 381
 382 Arranges any iconized (minimized) MDI child windows.
 383
 384 \wxheading{See also}
 385
 386 \helpref{wxMDIParentFrame::Cascade}{wxmdiparentframecascade},\rtfsp
 387 \helpref{wxMDIParentFrame::Tile}{wxmdiparentframetile}
 388
 389 \membersection{wxMDIParentFrame::Cascade}\label{wxmdiparentframecascade}
 390
 391 \func{void}{Cascade}{\void}
 392
 393 Arranges the MDI child windows in a cascade.
 394
 395 \wxheading{See also}
 396
 397 \helpref{wxMDIParentFrame::Tile}{wxmdiparentframetile},\rtfsp
 398 \helpref{wxMDIParentFrame::ArrangeIcons}{wxmdiparentframearrangeicons}
 399
 400 \membersection{wxMDIParentFrame::Create}\label{wxmdiparentframecreate}
 401
 402 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 403 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 404 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp
 405 \param{const wxString\& }{name = ``frame"}}
 406
 407 Used in two-step frame construction. See \helpref{wxMDIParentFrame::wxMDIParentFrame}{wxmdiparentframector}\rtfsp
 408 for further details.
 409
 410 \membersection{wxMDIParentFrame::GetClientSize}\label{wxmdiparentframegetclientsize}
 411
 412 \constfunc{virtual void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}}
 413
 414 This gets the size of the frame `client area' in pixels.
 415
 416 \wxheading{Parameters}
 417
 418 \docparam{width}{Receives the client width in pixels.}
 419
 420 \docparam{height}{Receives the client height in pixels.}
 421
 422 \wxheading{Remarks}
 423
 424 The client area is the area which may be drawn on by the programmer, excluding title bar, border, status bar,
 425 and toolbar if present.
 426
 427 If you wish to manage your own toolbar (or perhaps you have more than one),
 428 provide an {\bf OnSize} event handler. Call {\bf GetClientSize} to
 429 find how much space there is for your windows and don't forget to set the size and position
 430 of the MDI client window as well as your toolbar and other windows (but not the status bar).
 431
 432 If you have set a toolbar with \helpref{wxMDIParentFrame::SetToolbar}{wxmdiparentframesettoolbar},
 433 the client size returned will have subtracted the toolbar height. However, the available positions
 434 for the client window and other windows of the frame do not start at zero - you must add the toolbar height.
 435
 436 The position and size of the status bar and toolbar (if known to the frame) are always managed
 437 by {\bf wxMDIParentFrame}, regardless of what behaviour is defined in your {\bf OnSize} event handler.
 438 However, the client window position and size are always set in {\bf OnSize}, so if you override this
 439 event handler, make sure you deal with the client window.
 440
 441 You do not have to manage the size and position of MDI child windows, since they are managed
 442 automatically by the client window.
 443
 444 \wxheading{See also}
 445
 446 \helpref{wxMDIParentFrame::GetToolBar}{wxmdiparentframegettoolbar},\rtfsp
 447 \helpref{wxMDIParentFrame::SetToolBar}{wxmdiparentframesettoolbar},\rtfsp
 448 \helpref{wxMDIClientWindow}{wxmdiclientwindow}
 449
 450
 451 \pythonnote{The wxPython version of this method takes no arguments and
 452 returns a tuple containing width and height.}
 453
 454 \membersection{wxMDIParentFrame::GetActiveChild}\label{wxmdiparentframegetactivechild}
 455
 456 \constfunc{wxMDIChildFrame*}{GetActiveChild}{\void}
 457
 458 Returns a pointer to the active MDI child, if there is one.
 459
 460 \membersection{wxMDIParentFrame::GetClientWindow}\label{wxmdiparentframegetclientwindow}
 461
 462 \constfunc{wxMDIClientWindow*}{GetClientWindow}{\void}
 463
 464 Returns a pointer to the client window.
 465
 466 \wxheading{See also}
 467
 468 \helpref{wxMDIParentFrame::OnCreateClient}{wxmdiparentframeoncreateclient}
 469
 470 \membersection{wxMDIParentFrame::GetToolBar}\label{wxmdiparentframegettoolbar}
 471
 472 \constfunc{virtual wxWindow*}{GetToolBar}{\void}
 473
 474 Returns the window being used as the toolbar for this frame.
 475
 476 \wxheading{See also}
 477
 478 \helpref{wxMDIParentFrame::SetToolBar}{wxmdiparentframesettoolbar}
 479
 480 \membersection{wxMDIParentFrame::GetWindowMenu}\label{wxmdiparentframegetwindowmenu}
 481
 482 \constfunc{wxMenu*}{GetWindowMenu}{\void}
 483
 484 Returns the current Window menu (added by wxWidgets to the menubar). This function
 485 is available under Windows only.
 486
 487 \membersection{wxMDIParentFrame::OnCreateClient}\label{wxmdiparentframeoncreateclient}
 488
 489 \func{virtual wxMDIClientWindow*}{OnCreateClient}{\void}
 490
 491 Override this to return a different kind of client window. If you override this function,
 492 you must create your parent frame in two stages, or your function will never be called,
 493 due to the way C++ treats virtual functions called from constructors. For example:
 494
 495 \begin{verbatim}
 496   frame = new MyParentFrame;
 497   frame->Create(parent, myParentFrameId, wxT("My Parent Frame"));
 498 \end{verbatim}
 499
 500 \wxheading{Remarks}
 501
 502 You might wish to derive from \helpref{wxMDIClientWindow}{wxmdiclientwindow} in order
 503 to implement different erase behaviour, for example, such as painting a bitmap
 504 on the background.
 505
 506 Note that it is probably impossible to have a client window that scrolls as well as painting
 507 a bitmap or pattern, since in {\bf OnScroll}, the scrollbar positions always return zero.
 508 (Solutions to: {\tt julian.smart@btopenworld.com}).
 509
 510 \wxheading{See also}
 511
 512 \helpref{wxMDIParentFrame::GetClientWindow}{wxmdiparentframegetclientwindow},\rtfsp
 513 \helpref{wxMDIClientWindow}{wxmdiclientwindow}
 514
 515 \membersection{wxMDIParentFrame::SetToolBar}\label{wxmdiparentframesettoolbar}
 516
 517 \func{virtual void}{SetToolBar}{\param{wxWindow*}{ toolbar}}
 518
 519 Sets the window to be used as a toolbar for this
 520 MDI parent window. It saves the application having to manage the positioning
 521 of the toolbar MDI client window.
 522
 523 \wxheading{Parameters}
 524
 525 \docparam{toolbar}{Toolbar to manage.}
 526
 527 \wxheading{Remarks}
 528
 529 When the frame is resized, the toolbar is resized to be the width of
 530 the frame client area, and the toolbar height is kept the same.
 531
 532 The parent of the toolbar must be this frame.
 533
 534 If you wish to manage your own toolbar (or perhaps you have more than one),
 535 don't call this function, and instead manage your subwindows and the MDI client window by
 536 providing an {\bf OnSize} event handler. Call \helpref{wxMDIParentFrame::GetClientSize}{wxmdiparentframegetclientsize} to
 537 find how much space there is for your windows.
 538
 539 Note that SDI (normal) frames and MDI child windows must always have their
 540 toolbars managed by the application.
 541
 542 \wxheading{See also}
 543
 544 \helpref{wxMDIParentFrame::GetToolBar}{wxmdiparentframegettoolbar},\rtfsp
 545 \helpref{wxMDIParentFrame::GetClientSize}{wxmdiparentframegetclientsize}
 546
 547 \membersection{wxMDIParentFrame::SetWindowMenu}\label{wxmdiparentframesetwindowmenu}
 548
 549 \func{void}{SetWindowMenu}{\param{wxMenu*}{ menu}}
 550
 551 Call this to change the current Window menu. Ownership of the menu object passes to
 552 the frame when you call this function.
 553
 554 This call is available under Windows only.
 555
 556 To remove the window completely, use the wxFRAME\_NO\_WINDOW\_MENU window style.
 557
 558 \membersection{wxMDIParentFrame::Tile}\label{wxmdiparentframetile}
 559
 560 \func{void}{Tile}{\param{wxOrientation}{ orient = wxHORIZONTAL}}
 561
 562 Tiles the MDI child windows either horizontally or vertically depending on
 563 whether \arg{orient} is wxHORIZONTAL or wxVERTICAL.
 564
 565 Currently only implemented for MSW, does nothing under the other platforms.
 566
 567 \wxheading{See also}
 568
 569 \helpref{wxMDIParentFrame::Cascade}{wxmdiparentframecascade},\rtfsp
 570 \helpref{wxMDIParentFrame::ArrangeIcons}{wxmdiparentframearrangeicons}
 571
 572