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
|
.. 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
.. currentmodule:: wx.lib.agw.aui.framemanager
.. highlight:: python
.. _wx.lib.agw.aui.framemanager.AuiFloatingFrame:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.aui.framemanager.AuiFloatingFrame**
==========================================================================================================================================
AuiFloatingFrame is the frame class that holds floating panes.
|
|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>AuiFloatingFrame</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.lib.agw.aui.framemanager.AuiFloatingFrame_inheritance.png" alt="Inheritance diagram of AuiFloatingFrame" 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.Trackable.html" title="wx.Trackable" alt="" coords="56,5,157,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="108,83,219,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="103,160,224,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="181,5,263,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="119,237,208,267"/> <area shape="rect" id="node7" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="85,315,243,344"/> <area shape="rect" id="node6" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="93,392,235,421"/> <area shape="rect" id="node8" href="wx.Frame.html" title="wx.Frame" alt="" coords="123,469,204,499"/> <area shape="rect" id="node9" href="wx.MiniFrame.html" title="wx.MiniFrame" alt="" coords="111,547,217,576"/> <area shape="rect" id="node10" href="wx.lib.agw.aui.framemanager.AuiFloatingFrame.html" title="wx.lib.agw.aui.framemanager.AuiFloatingFrame" alt="" coords="4,624,323,653"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.MiniFrame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.__init__` Default class constructor. Used internally, do not call it in your code!
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.CopyAttributes` Copies all the attributes of the input `pane` into another :class:`AuiPaneInfo`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.FadeOut` Actually starts the fading out of the floating pane.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.FlyOut` Starts the flying in and out of a floating pane.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.GetOwnerManager` Returns the :class:`AuiManager` that manages the pane.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnActivate` Handles the ``wx.EVT_ACTIVATE`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnCheckFlyTimer` Handles the ``wx.EVT_TIMER`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnClose` Handles the ``wx.EVT_CLOSE`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnFindManager` Handles the ``EVT_AUI_FIND_MANAGER`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnFlyTimer` Handles the ``wx.EVT_TIMER`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnIdle` Handles the ``wx.EVT_IDLE`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnMove` Handles the ``wx.EVT_MOVE`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnMoveEvent` Handles the ``wx.EVT_MOVE`` and ``wx.EVT_MOVING`` events for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnMoveFinished` The user has just finished moving the floating pane.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnMoveStart` The user has just started moving the floating pane.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnMoving` The user is moving the floating pane.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.OnSize` Handles the ``wx.EVT_SIZE`` event for :class:`AuiFloatingFrame`.
:meth:`~wx.lib.agw.aui.framemanager.AuiFloatingFrame.SetPaneWindow` Sets all the properties of a pane.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: AuiFloatingFrame(wx.MiniFrame)
AuiFloatingFrame is the frame class that holds floating panes.
.. method:: __init__(self, parent, owner_mgr, pane=None, id=wx.ID_ANY, title="", style=wx.FRAME_TOOL_WINDOW | wx.FRAME_FLOAT_ON_PARENT | wx.FRAME_NO_TASKBAR | wx.CLIP_CHILDREN)
Default class constructor. Used internally, do not call it in your code!
:param `parent`: the :class:`AuiManager` parent;
:param `owner_mgr`: the :class:`AuiManager` that manages the floating pane;
:param `pane`: the :class:`AuiPaneInfo` pane that is about to float;
:param integer `id`: the window identifier. It may take a value of -1 to indicate a default value.
:param string `title`: the caption to be displayed on the frame's title bar.
:param integer `style`: the window style.
.. method:: CopyAttributes(self, pane)
Copies all the attributes of the input `pane` into another :class:`AuiPaneInfo`.
:param `pane`: the source :class:`AuiPaneInfo` from where to copy attributes.
.. method:: FadeOut(self)
Actually starts the fading out of the floating pane.
.. method:: FlyOut(self)
Starts the flying in and out of a floating pane.
.. method:: GetOwnerManager(self)
Returns the :class:`AuiManager` that manages the pane.
.. method:: OnActivate(self, event)
Handles the ``wx.EVT_ACTIVATE`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`ActivateEvent` to be processed.
.. method:: OnCheckFlyTimer(self, event)
Handles the ``wx.EVT_TIMER`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`TimerEvent` to be processed.
:note: This is used solely for "fly-out" panes.
.. method:: OnClose(self, event)
Handles the ``wx.EVT_CLOSE`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`CloseEvent` to be processed.
.. method:: OnFindManager(self, event)
Handles the ``EVT_AUI_FIND_MANAGER`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`AuiManagerEvent` event to be processed.
.. method:: OnFlyTimer(self, event)
Handles the ``wx.EVT_TIMER`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`TimerEvent` to be processed.
.. method:: OnIdle(self, event)
Handles the ``wx.EVT_IDLE`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`IdleEvent` event to be processed.
.. note::
This event is only processed on wxMAC if :class:`AuiManager` is using the
``AUI_MGR_USE_NATIVE_MINIFRAMES`` style.
.. method:: OnMove(self, event)
Handles the ``wx.EVT_MOVE`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`MoveEvent` to be processed.
.. note::
This event is not processed on wxMAC or if :class:`AuiManager` is not using the
``AUI_MGR_USE_NATIVE_MINIFRAMES`` style.
.. method:: OnMoveEvent(self, event)
Handles the ``wx.EVT_MOVE`` and ``wx.EVT_MOVING`` events for :class:`AuiFloatingFrame`.
:param `event`: a :class:`MoveEvent` to be processed.
.. note::
This event is only processed on wxMAC or if :class:`AuiManager` is using the
``AUI_MGR_USE_NATIVE_MINIFRAMES`` style.
.. method:: OnMoveFinished(self)
The user has just finished moving the floating pane.
.. note::
This method is used only on wxMAC if :class:`AuiManager` is using the
``AUI_MGR_USE_NATIVE_MINIFRAMES`` style.
.. method:: OnMoveStart(self, event)
The user has just started moving the floating pane.
:param `event`: an instance of :class:`MouseEvent`.
.. note::
This event is only processed on wxMAC if :class:`AuiManager` is using the
``AUI_MGR_USE_NATIVE_MINIFRAMES`` style.
.. method:: OnMoving(self, rect, direction)
The user is moving the floating pane.
:param wx.Rect `rect`: the pane client rectangle;
:param integer `direction`: the direction in which the pane is moving, can be one of
``wx.NORTH``, ``wx.SOUTH``, ``wx.EAST`` or ``wx.WEST``.
.. note::
This event is only processed on wxMAC if :class:`AuiManager` is using the
``AUI_MGR_USE_NATIVE_MINIFRAMES`` style.
.. method:: OnSize(self, event)
Handles the ``wx.EVT_SIZE`` event for :class:`AuiFloatingFrame`.
:param `event`: a :class:`wx.SizeEvent` to be processed.
.. method:: SetPaneWindow(self, pane)
Sets all the properties of a pane.
:param `pane`: the :class:`AuiPaneInfo` to analyze.
|
