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
|
.. 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.AuiDockingGuideWindow:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.aui.framemanager.AuiDockingGuideWindow**
==========================================================================================================================================
Target class for :class:`AuiDockingGuide` and :class:`AuiCenterDockingGuide`.
|
|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>AuiDockingGuideWindow</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.AuiDockingGuideWindow_inheritance.png" alt="Inheritance diagram of AuiDockingGuideWindow" 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="80,5,181,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="132,83,243,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="127,160,248,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="205,5,287,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="143,237,232,267"/> <area shape="rect" id="node6" href="wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.html" title="wx.lib.agw.aui.framemanager.AuiDockingGuideWindow" alt="" coords="5,315,371,344"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.Window`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.__init__` Default class constructor. Used internally, do not call it in your code!
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.Draw` Draws the whole docking guide window (not used if the docking guide images are ok).
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.DrawArrow` Draws the docking guide arrow icon (not used if the docking guide images are ok).
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.DrawBackground` Draws the docking guide background.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.DrawDottedLine` Draws a dotted line (not used if the docking guide images are ok).
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.DrawIcon` Draws the docking guide icon (not used if the docking guide images are ok).
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.IsValid` Returns whether the docking direction is valid.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.OnEraseBackground` Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`AuiDockingGuideWindow`.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.OnPaint` Handles the ``wx.EVT_PAINT`` event for :class:`AuiDockingGuideWindow`.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.SetValid` Sets the docking direction as valid or invalid.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideWindow.UpdateDockGuide` Updates the docking guide images depending on the mouse position, using focused
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: AuiDockingGuideWindow(wx.Window)
Target class for :class:`AuiDockingGuide` and :class:`AuiCenterDockingGuide`.
.. method:: __init__(self, parent, rect, direction=0, center=False, useAero=False)
Default class constructor. Used internally, do not call it in your code!
:param `parent`: the :class:`AuiManager` parent;
:param wx.Rect `rect`: the window rect;
:param integer `direction`: one of ``wx.TOP``, ``wx.BOTTOM``, ``wx.LEFT``, ``wx.RIGHT``,
``wx.CENTER``;
:param bool `center`: whether the calling class is a :class:`AuiCenterDockingGuide`;
:param bool `useAero`: whether to use the new Aero-style bitmaps or Whidbey-style bitmaps
for the docking guide.
.. method:: Draw(self, dc)
Draws the whole docking guide window (not used if the docking guide images are ok).
:param `dc`: a :class:`wx.DC` device context object.
.. method:: DrawArrow(self, dc)
Draws the docking guide arrow icon (not used if the docking guide images are ok).
:param `dc`: a :class:`wx.DC` device context object.
.. method:: DrawBackground(self, dc)
Draws the docking guide background.
:param `dc`: a :class:`wx.DC` device context object.
.. method:: DrawDottedLine(self, dc, point, length, vertical)
Draws a dotted line (not used if the docking guide images are ok).
:param `dc`: a :class:`wx.DC` device context object;
:param `point`: a :class:`wx.Point` where to start drawing the dotted line;
:param integer `length`: the length of the dotted line;
:param bool `vertical`: whether it is a vertical docking guide window or not.
.. method:: DrawIcon(self, dc)
Draws the docking guide icon (not used if the docking guide images are ok).
:param `dc`: a :class:`wx.DC` device context object.
.. method:: IsValid(self)
Returns whether the docking direction is valid.
.. method:: OnEraseBackground(self, event)
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`AuiDockingGuideWindow`.
:param `event`: a :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:`AuiDockingGuideWindow`.
:param `event`: a :class:`PaintEvent` to be processed.
.. method:: SetValid(self, valid)
Sets the docking direction as valid or invalid.
:param bool `valid`: whether the docking direction is allowed or not.
.. method:: UpdateDockGuide(self, pos)
Updates the docking guide 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 `pos`: a :class:`wx.Point` mouse position.
|
