summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxMDIChildFrame.xml
blob: 1ed1d0a21d2402117d15e3b389af223a827d626f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxMDIChildFrame</title>
</header>
<module>wxMDIChildFrame</module>
<modulesummary>Functions for wxMDIChildFrame class</modulesummary>
<description><p>An MDI child frame is a frame that can only exist inside a <seeerl marker="wxMDIClientWindow"><c>wxMDIClientWindow</c></seeerl>, which is itself a child of <seeerl marker="wxMDIParentFrame"><c>wxMDIParentFrame</c></seeerl>.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p> All of the standard <seeerl marker="wxFrame"><c>wxFrame</c></seeerl> styles can be used but most of them are ignored by TDI-based MDI implementations.  
      </p><p>Remark: Although internally an MDI child frame is a child of the MDI client window, in wxWidgets you create it as a child of <seeerl marker="wxMDIParentFrame"><c>wxMDIParentFrame</c></seeerl>. In fact, you can usually forget that the client window exists. MDI child frames are clipped to the area of the MDI client window, and may be iconized on the client window. You can associate a menubar with a child frame as usual, although an MDI child doesn't display its menubar under its own title bar. The MDI parent frame's menubar will be changed to reflect the currently active child frame. If there are currently no children, the parent frame's own menubar will be displayed.
      </p><p>See: <seeerl marker="wxMDIClientWindow"><c>wxMDIClientWindow</c></seeerl>, <seeerl marker="wxMDIParentFrame"><c>wxMDIParentFrame</c></seeerl>, <seeerl marker="wxFrame"><c>wxFrame</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxFrame"><c>wxFrame</c></seeerl> <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_m_d_i_child_frame.html">wxMDIChildFrame</url></p>
  </description>
<datatypes><datatype><name name="wxMDIChildFrame"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>new/4</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="4" clause_i="1" since=""/>
    <fsummary>Constructor, creating the window. </fsummary>
    <desc><p>Constructor, creating the window. 
      </p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p><p>Destroys all child windows and menu bar if present. 
      </p></desc>
  </func>
  
  <func>
    <name name="activate" arity="1" clause_i="1" since=""/>
    <fsummary>Activates this MDI child frame. </fsummary>
    <desc><p>Activates this MDI child frame. 
      </p><p>See: <seemfa marker="#maximize/2"><c>maximize/2</c></seemfa>, <seemfa marker="#restore/1"><c>restore/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>See: <c>create/5</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="5" clause_i="1" since=""/>
    <fsummary>Used in two-step frame construction. </fsummary>
    <desc><p>Used in two-step frame construction. 
      </p><p>See <seemfa marker="#new/4"><c>new/4</c></seemfa> for further details. 
      </p></desc>
  </func>
  
  <func>
    <name name="maximize" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>maximize/2</c></fsummary>
  </func>
  
  <func>
    <name name="maximize" arity="2" clause_i="1" since=""/>
    <fsummary>Maximizes this MDI child frame. </fsummary>
    <desc><p>Maximizes this MDI child frame. 
      </p><p>This function doesn't do anything if <c>IsAlwaysMaximized()</c> (not implemented in wx) returns true.
      </p><p>See: <seemfa marker="#activate/1"><c>activate/1</c></seemfa>, <seemfa marker="#restore/1"><c>restore/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="restore" arity="1" clause_i="1" since=""/>
    <fsummary>Restores this MDI child frame (unmaximizes). </fsummary>
    <desc><p>Restores this MDI child frame (unmaximizes). 
      </p><p>This function doesn't do anything if <c>IsAlwaysMaximized()</c> (not implemented in wx) returns true.
      </p><p>See: <seemfa marker="#activate/1"><c>activate/1</c></seemfa>, <seemfa marker="#maximize/2"><c>maximize/2</c></seemfa>
      </p></desc>
  </func>
  </funcs>
</erlref>