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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.MiniFrame:
==========================================================================================================================================
|phoenix_title| **wx.MiniFrame**
==========================================================================================================================================
A miniframe is a frame with a small title bar.
It is suitable for floating toolbars that must not take up too much screen area.
An example of mini frame can be seen in the :ref:`Dialogs Sample <dialogs sample>` using the "Mini frame" command of the "Generic dialogs" submenu.
.. _MiniFrame-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.ICONIZE``: Display the frame iconized (minimized) (Windows only).
- ``wx.CAPTION``: Puts a caption on the frame.
- ``wx.MINIMIZE``: Identical to ``wx.ICONIZE``.
- ``wx.MINIMIZE_BOX``: Displays a minimize box on the frame (Windows and Motif only).
- ``wx.MAXIMIZE``: Displays the frame maximized (Windows only).
- ``wx.MAXIMIZE_BOX``: Displays a maximize box on the frame (Windows and Motif only).
- ``wx.CLOSE_BOX``: Displays a close box on the frame.
- ``wx.STAY_ON_TOP``: Stay on top of other windows (Windows only).
- ``wx.SYSTEM_MENU``: Displays a system menu (Windows and Motif only).
- ``wx.RESIZE_BORDER``: Displays a resizable border around the window.
.. note::
This class has miniframe functionality under Windows and GTK, i.e. the presence of mini frame will not be noted in the task bar and focus behaviour is different. On other platforms, it behaves like a normal frame.
.. seealso:: :ref:`wx.MDIParentFrame`, :ref:`wx.MDIChildFrame`, :ref:`wx.Frame`, :ref:`wx.Dialog`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>MiniFrame</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.MiniFrame_inheritance.png" alt="Inheritance diagram of MiniFrame" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Frame.html" title="wx.Frame" alt="" coords="63,392,144,421"/> <area shape="rect" id="node6" href="wx.MiniFrame.html" title="wx.MiniFrame" alt="" coords="51,469,157,499"/> <area shape="rect" id="node2" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="33,315,175,344"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node7" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,183,267"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.miniframe.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/../no_appearance.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.MiniFrame.__init__` Default constructor.
:meth:`~wx.MiniFrame.Create` Used in two-step frame construction.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.MiniFrame(Frame)
**Possible constructors**::
MiniFrame()
MiniFrame(parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition,
size=DefaultSize, style=CAPTION|RESIZE_BORDER, name=FrameNameStr)
A miniframe is a frame with a small title bar.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CAPTION|RESIZE_BORDER, name=FrameNameStr)`
Constructor, creating the window.
:param `parent`: The window parent. This may be ``None``. If it is non-NULL, the frame will always be displayed on top of the parent window on Windows.
:type `parent`: wx.Window
:param `id`: The window identifier. It may take a value of -1 to indicate a default value.
:type `id`: wx.WindowID
:param `title`: The caption to be displayed on the frame's title bar.
:type `title`: string
:param `pos`: The window position. The value DefaultPosition indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
:type `pos`: wx.Point
:param `size`: The window size. The value DefaultSize indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
:type `size`: wx.Size
:param `style`: The window style. See :ref:`wx.MiniFrame`.
:type `style`: long
:param `name`: The name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.
:type `name`: string
.. note::
The frame behaves like a normal frame on non-Windows platforms.
.. seealso:: :meth:`Create`
**~~~**
.. method:: Create(self, parent, id=ID_ANY, title=EmptyString, pos=DefaultPosition, size=DefaultSize, style=CAPTION|RESIZE_BORDER, name=FrameNameStr)
Used in two-step frame construction.
See :ref:`wx.MiniFrame` for further details.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `title`:
:type `title`: string
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
|
