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