wxMDIParentFrame.3erl - Man Page

An MDI (Multiple Document Interface) parent frame is a window which can contain MDI child frames in its client area which emulates the full desktop.

MDI is a user-interface model in which all the window reside inside the single parent window as opposed to being separate from each other. It remains popular despite dire warnings from Microsoft itself (which popularized this model in the first model) that MDI is obsolete.

An MDI parent frame always has a wxMDIClientWindow associated with it, which is the parent for MDI child frames. In the simplest case, the client window takes up the entire parent frame area but it is also possible to resize it to be smaller in order to have other windows in the frame, a typical example is using a sidebar along one of the window edges.

The appearance of MDI applications differs between different ports. The classic MDI model, with child windows which can be independently moved, resized etc, is only available under MSW, which provides native support for it. In Mac ports, multiple top level windows are used for the MDI children too and the MDI parent frame itself is invisible, to accommodate the native look and feel requirements. In all the other ports, a tab-based MDI implementation (sometimes called TDI) is used and so at most one MDI child is visible at any moment (child frames are always maximized).

Although it is possible to have multiple MDI parent frames, a typical MDI application has a single MDI parent frame window inside which multiple MDI child frames, i.e. objects of class wxMDIChildFrame, can be created.

Styles

This class supports the following styles:

There are no special styles for this class, all wxFrame styles apply to it in the usual way. The only exception is that wxHSCROLL and wxVSCROLL styles apply not to the frame itself but to the client window, so that using them enables horizontal and vertical scrollbars for this window and not the frame.

See: wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog

This class is derived (and can use functions) from: wxFrame wxTopLevelWindow wxWindow wxEvtHandler

wxWidgets docs: wxMDIParentFrame

wxMDIParentFrame() = wx:wx_object()

new() -> wxMDIParentFrame()

new(Parent, Id, Title) -> wxMDIParentFrame()

Types:

Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()

new(Parent, Id, Title, Options :: [Option]) -> wxMDIParentFrame()

Types:

Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()
Option =
   {pos, {X :: integer(), Y :: integer()}} |
   {size, {W :: integer(), H :: integer()}} |
   {style, integer()}

destroy(This :: wxMDIParentFrame()) -> ok

activateNext(This) -> ok

Types:

This = wxMDIParentFrame()

activatePrevious(This) -> ok

Types:

This = wxMDIParentFrame()

arrangeIcons(This) -> ok

Types:

This = wxMDIParentFrame()

cascade(This) -> ok

Types:

This = wxMDIParentFrame()

create(This, Parent, Id, Title) -> boolean()

Types:

This = wxMDIParentFrame()
Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()

create(This, Parent, Id, Title, Options :: [Option]) -> boolean()

Types:

This = wxMDIParentFrame()
Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()
Option =
   {pos, {X :: integer(), Y :: integer()}} |
   {size, {W :: integer(), H :: integer()}} |
   {style, integer()}

getActiveChild(This) -> wxMDIChildFrame:wxMDIChildFrame()

Types:

This = wxMDIParentFrame()

getClientWindow(This) -> wxMDIClientWindow:wxMDIClientWindow()

Types:

This = wxMDIParentFrame()

tile(This) -> ok

Types:

This = wxMDIParentFrame()

tile(This, Options :: [Option]) -> ok

Types:

This = wxMDIParentFrame()
Option = {orient, wx:wx_enum()}