1wxMDIParentFrame(3)        Erlang Module Definition        wxMDIParentFrame(3)
2
3
4

NAME

6       wxMDIParentFrame - Functions for wxMDIParentFrame class
7

DESCRIPTION

9       An MDI (Multiple Document Interface) parent frame is a window which can
10       contain MDI child frames in its client area  which  emulates  the  full
11       desktop.
12
13       MDI is a user-interface model in which all the window reside inside the
14       single parent window as opposed to being separate from each  other.  It
15       remains popular despite dire warnings from Microsoft itself (which pop‐
16       ularized this model in the first model) that MDI is obsolete.
17
18       An MDI parent frame always has a wxMDIClientWindow associated with  it,
19       which  is  the  parent  for MDI child frames. In the simplest case, the
20       client window takes up the entire parent frame area but it is also pos‐
21       sible  to resize it to be smaller in order to have other windows in the
22       frame, a typical example is using a sidebar along  one  of  the  window
23       edges.
24
25       The appearance of MDI applications differs between different ports. The
26       classic MDI model, with child windows which can be independently moved,
27       resized etc, is only available under MSW, which provides native support
28       for it. In Mac ports, multiple top level windows are used for  the  MDI
29       children  too and the MDI parent frame itself is invisible, to accommo‐
30       date the native look and feel requirements. In all the other  ports,  a
31       tab-based  MDI  implementation (sometimes called TDI) is used and so at
32       most one MDI child is visible at any moment (child  frames  are  always
33       maximized).
34
35       Although  it  is possible to have multiple MDI parent frames, a typical
36       MDI application has a single MDI parent frame window inside which  mul‐
37       tiple  MDI  child frames, i.e. objects of class wxMDIChildFrame, can be
38       created.
39
40       Styles
41
42       This class supports the following styles:
43
44       There are no special styles for this class, all wxFrame styles apply to
45       it in the usual way. The only exception is that wxHSCROLL and wxVSCROLL
46       styles apply not to the frame itself but to the client window, so  that
47       using  them  enables horizontal and vertical scrollbars for this window
48       and not the frame.
49
50       See: wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog
51
52       This class is derived (and can use functions) from: wxFrame wxTopLevel‐
53       Window wxWindow wxEvtHandler
54
55       wxWidgets docs: wxMDIParentFrame
56

DATA TYPES

58       wxMDIParentFrame() = wx:wx_object()
59

EXPORTS

61       new() -> wxMDIParentFrame()
62
63              Default constructor.
64
65              Use create/5 for the objects created using this constructor.
66
67       new(Parent, Id, Title) -> wxMDIParentFrame()
68
69              Types:
70
71                 Parent = wxWindow:wxWindow()
72                 Id = integer()
73                 Title = unicode:chardata()
74
75       new(Parent, Id, Title, Options :: [Option]) -> wxMDIParentFrame()
76
77              Types:
78
79                 Parent = wxWindow:wxWindow()
80                 Id = integer()
81                 Title = unicode:chardata()
82                 Option =
83                     {pos, {X :: integer(), Y :: integer()}} |
84                     {size, {W :: integer(), H :: integer()}} |
85                     {style, integer()}
86
87              Constructor, creating the window.
88
89              Notice that if you override virtual OnCreateClient() (not imple‐
90              mented in wx) method you shouldn't be using this constructor but
91              the  default constructor and create/5 as otherwise your overrid‐
92              den method is never going to be called because of the usual  C++
93              virtual call resolution rules.
94
95              Under  wxMSW, the client window will automatically have a sunken
96              border style when the active child is not maximized, and no bor‐
97              der style when a child is maximized.
98
99              See: create/5, OnCreateClient() (not implemented in wx)
100
101       destroy(This :: wxMDIParentFrame()) -> ok
102
103              Destructor.
104
105              Destroys all child windows and menu bar if present.
106
107       activateNext(This) -> ok
108
109              Types:
110
111                 This = wxMDIParentFrame()
112
113              Activates the MDI child following the currently active one.
114
115              The  MDI  children  are  maintained  in an ordered list and this
116              function switches to the next element  in  this  list,  wrapping
117              around  the  end of it if the currently active child is the last
118              one.
119
120              See: activatePrevious/1
121
122       activatePrevious(This) -> ok
123
124              Types:
125
126                 This = wxMDIParentFrame()
127
128              Activates the MDI child preceding the currently active one.
129
130              See: activateNext/1
131
132       arrangeIcons(This) -> ok
133
134              Types:
135
136                 This = wxMDIParentFrame()
137
138              Arranges any iconized (minimized) MDI child windows.
139
140              This method is only implemented in MSW  MDI  implementation  and
141              does nothing under the other platforms.
142
143              See: cascade/1, tile/2
144
145       cascade(This) -> ok
146
147              Types:
148
149                 This = wxMDIParentFrame()
150
151              Arranges the MDI child windows in a cascade.
152
153              This  method  is  only implemented in MSW MDI implementation and
154              does nothing under the other platforms.
155
156              See: tile/2, arrangeIcons/1
157
158       create(This, Parent, Id, Title) -> boolean()
159
160              Types:
161
162                 This = wxMDIParentFrame()
163                 Parent = wxWindow:wxWindow()
164                 Id = integer()
165                 Title = unicode:chardata()
166
167       create(This, Parent, Id, Title, Options :: [Option]) -> boolean()
168
169              Types:
170
171                 This = wxMDIParentFrame()
172                 Parent = wxWindow:wxWindow()
173                 Id = integer()
174                 Title = unicode:chardata()
175                 Option =
176                     {pos, {X :: integer(), Y :: integer()}} |
177                     {size, {W :: integer(), H :: integer()}} |
178                     {style, integer()}
179
180              Used in two-step frame construction.
181
182              See new/4 for further details.
183
184       getActiveChild(This) -> wxMDIChildFrame:wxMDIChildFrame()
185
186              Types:
187
188                 This = wxMDIParentFrame()
189
190              Returns a pointer to the active MDI child, if there is one.
191
192              If there are any children at all this function  returns  a  non-
193              NULL pointer.
194
195       getClientWindow(This) -> wxMDIClientWindow:wxMDIClientWindow()
196
197              Types:
198
199                 This = wxMDIParentFrame()
200
201              Returns a pointer to the client window.
202
203              See: OnCreateClient() (not implemented in wx)
204
205       tile(This) -> ok
206
207              Types:
208
209                 This = wxMDIParentFrame()
210
211       tile(This, Options :: [Option]) -> ok
212
213              Types:
214
215                 This = wxMDIParentFrame()
216                 Option = {orient, wx:wx_enum()}
217
218              Tiles  the  MDI  child windows either horizontally or vertically
219              depending on whether orient is wxHORIZONTAL or wxVERTICAL.
220
221              This method is only implemented in MSW  MDI  implementation  and
222              does nothing under the other platforms.
223
224
225
226wxWidgets team.                    wx 2.2.2                wxMDIParentFrame(3)