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

NAME

6       wxMDIChildFrame - Functions for wxMDIChildFrame class
7

DESCRIPTION

9       An  MDI child frame is a frame that can only exist inside a wxMDIClien‐
10       tWindow, which is itself a child of wxMDIParentFrame.
11
12       Styles
13
14       This class supports the following styles:
15
16       All of the standard wxFrame styles can be used but most of them are ig‐
17       nored by TDI-based MDI implementations.
18
19       Remark:  Although  internally  an MDI child frame is a child of the MDI
20       client window, in wxWidgets you create it as a  child  of  wxMDIParent‐
21       Frame.  In  fact, you can usually forget that the client window exists.
22       MDI child frames are clipped to the area of the MDI client window,  and
23       may  be iconized on the client window. You can associate a menubar with
24       a child frame as usual, although  an  MDI  child  doesn't  display  its
25       menubar under its own title bar. The MDI parent frame's menubar will be
26       changed to reflect the currently active child frame. If there are  cur‐
27       rently no children, the parent frame's own menubar will be displayed.
28
29       See: wxMDIClientWindow, wxMDIParentFrame, wxFrame
30
31       This class is derived (and can use functions) from: wxFrame wxTopLevel‐
32       Window wxWindow wxEvtHandler
33
34       wxWidgets docs: wxMDIChildFrame
35

DATA TYPES

37       wxMDIChildFrame() = wx:wx_object()
38

EXPORTS

40       new() -> wxMDIChildFrame()
41
42              Default constructor.
43
44       new(Parent, Id, Title) -> wxMDIChildFrame()
45
46              Types:
47
48                 Parent = wxMDIParentFrame:wxMDIParentFrame()
49                 Id = integer()
50                 Title = unicode:chardata()
51
52       new(Parent, Id, Title, Options :: [Option]) -> wxMDIChildFrame()
53
54              Types:
55
56                 Parent = wxMDIParentFrame:wxMDIParentFrame()
57                 Id = integer()
58                 Title = unicode:chardata()
59                 Option =
60                     {pos, {X :: integer(), Y :: integer()}} |
61                     {size, {W :: integer(), H :: integer()}} |
62                     {style, integer()}
63
64              Constructor, creating the window.
65
66              See: create/5
67
68       destroy(This :: wxMDIChildFrame()) -> ok
69
70              Destructor.
71
72              Destroys all child windows and menu bar if present.
73
74       activate(This) -> ok
75
76              Types:
77
78                 This = wxMDIChildFrame()
79
80              Activates this MDI child frame.
81
82              See: maximize/2, restore/1
83
84       create(This, Parent, Id, Title) -> boolean()
85
86              Types:
87
88                 This = wxMDIChildFrame()
89                 Parent = wxMDIParentFrame:wxMDIParentFrame()
90                 Id = integer()
91                 Title = unicode:chardata()
92
93       create(This, Parent, Id, Title, Options :: [Option]) -> boolean()
94
95              Types:
96
97                 This = wxMDIChildFrame()
98                 Parent = wxMDIParentFrame:wxMDIParentFrame()
99                 Id = integer()
100                 Title = unicode:chardata()
101                 Option =
102                     {pos, {X :: integer(), Y :: integer()}} |
103                     {size, {W :: integer(), H :: integer()}} |
104                     {style, integer()}
105
106              Used in two-step frame construction.
107
108              See new/4 for further details.
109
110       maximize(This) -> ok
111
112              Types:
113
114                 This = wxMDIChildFrame()
115
116       maximize(This, Options :: [Option]) -> ok
117
118              Types:
119
120                 This = wxMDIChildFrame()
121                 Option = {maximize, boolean()}
122
123              Maximizes this MDI child frame.
124
125              This function doesn't do anything  if  IsAlwaysMaximized()  (not
126              implemented in wx) returns true.
127
128              See: activate/1, restore/1
129
130       restore(This) -> ok
131
132              Types:
133
134                 This = wxMDIChildFrame()
135
136              Restores this MDI child frame (unmaximizes).
137
138              This  function  doesn't  do anything if IsAlwaysMaximized() (not
139              implemented in wx) returns true.
140
141              See: activate/1, maximize/2
142
143
144
145wxWidgets team.                     wx 2.1                  wxMDIChildFrame(3)