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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.aui.framemanager
.. highlight:: python
.. _wx.lib.agw.aui.framemanager.AuiCenterDockingGuide:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.aui.framemanager.AuiCenterDockingGuide**
==========================================================================================================================================
A docking guide window for multiple docking hint (diamond-shaped HUD).
|
|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>AuiCenterDockingGuide</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.AuiCenterDockingGuide_inheritance.png" alt="Inheritance diagram of AuiCenterDockingGuide" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.html" title="wx.lib.agw.aui.framemanager.AuiCenterDockingGuide" alt="" coords="5,624,380,653"/> <area shape="rect" id="node2" href="wx.lib.agw.aui.framemanager.AuiDockingGuide.html" title="wx.lib.agw.aui.framemanager.AuiDockingGuide" alt="" coords="27,547,358,576"/> <area shape="rect" id="node3" href="wx.Frame.html" title="wx.Frame" alt="" coords="150,469,235,499"/> <area shape="rect" id="node4" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="115,392,270,421"/> <area shape="rect" id="node5" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="109,315,277,344"/> <area shape="rect" id="node6" href="wx.Window.html" title="wx.Window" alt="" coords="144,237,241,267"/> <area shape="rect" id="node7" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="128,160,257,189"/> <area shape="rect" id="node8" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="134,83,251,112"/> <area shape="rect" id="node9" href="wx.Object.html" title="wx.Object" alt="" coords="89,5,176,35"/> <area shape="rect" id="node10" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="201,5,307,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.aui.framemanager.AuiDockingGuide`
|
|method_summary| Methods Summary
================================
================================================================================== ================================================================================
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.__init__` Default class constructor.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.AeroMove` Moves the docking guide window to the new position.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.CreateShapesWithStyle` Creates the docking guide window shape based on which docking bitmaps are used.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.HitTest` Checks if the mouse position is inside the target windows rect.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.OnEraseBackground` Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`AuiCenterDockingGuide`.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.OnPaint` Handles the ``wx.EVT_PAINT`` event for :class:`AuiCenterDockingGuide`.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.SetGuideShape` Sets the correct shape for the docking guide window.
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.UpdateDockGuide` Updates the docking guides images depending on the mouse position, using focused
:meth:`~wx.lib.agw.aui.framemanager.AuiCenterDockingGuide.ValidateNotebookDocking` Sets whether a pane can be docked on top of another to create an automatic
================================================================================== ================================================================================
|
|api| Class API
===============
.. class:: AuiCenterDockingGuide(AuiDockingGuide)
A docking guide window for multiple docking hint (diamond-shaped HUD).
.. method:: __init__(self, parent)
Default class constructor.
Used internally, do not call it in your code!
:param `parent`: the :class:`AuiManager` parent.
.. method:: AeroMove(self, pos)
Moves the docking guide window to the new position.
:param wx.Point `pos`: the new docking guide position.
.. method:: CreateShapesWithStyle(self)
Creates the docking guide window shape based on which docking bitmaps are used.
.. method:: HitTest(self, x, y)
Checks if the mouse position is inside the target windows rect.
:param integer `x`: the `x` mouse position;
:param integer `y`: the `y` mouse position.
.. method:: OnEraseBackground(self, event)
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`AuiCenterDockingGuide`.
:param `event`: :class:`EraseEvent` to be processed.
:note: This is intentionally empty to reduce flickering while drawing.
.. method:: OnPaint(self, event)
Handles the ``wx.EVT_PAINT`` event for :class:`AuiCenterDockingGuide`.
:param `event`: a :class:`PaintEvent` to be processed.
.. method:: SetGuideShape(self, event=None)
Sets the correct shape for the docking guide window.
:param `event`: on wxGTK, a :class:`wx.WindowCreateEvent` event to process.
.. method:: UpdateDockGuide(self, pos)
Updates the docking guides images depending on the mouse position, using focused
images if the mouse is inside the docking guide or unfocused images if it is
outside.
:param wx.Point `pos`: the mouse position.
.. method:: ValidateNotebookDocking(self, valid)
Sets whether a pane can be docked on top of another to create an automatic
:class:`~wx.lib.agw.aui.auibook.AuiNotebook`.
:param bool `valid`: whether a pane can be docked on top to another to form an automatic
:class:`~wx.lib.agw.aui.auibook.AuiNotebook`.
|
