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
|
.. 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.AuiDockingGuide:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.aui.framemanager.AuiDockingGuide**
==========================================================================================================================================
Base class for :class:`AuiSingleDockingGuide` 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>AuiDockingGuide</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.AuiDockingGuide_inheritance.png" alt="Inheritance diagram of AuiDockingGuide" 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.AuiDockingGuide.html" title="wx.lib.agw.aui.framemanager.AuiDockingGuide" alt="" coords="5,547,336,576"/> <area shape="rect" id="node2" href="wx.Frame.html" title="wx.Frame" alt="" coords="128,469,213,499"/> <area shape="rect" id="node3" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="93,392,248,421"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="87,315,255,344"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="122,237,219,267"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="106,160,235,189"/> <area shape="rect" id="node7" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="112,83,229,112"/> <area shape="rect" id="node8" href="wx.Object.html" title="wx.Object" alt="" coords="67,5,154,35"/> <area shape="rect" id="node9" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="179,5,285,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.aui.framemanager.AuiCenterDockingGuide`, :class:`wx.lib.agw.aui.framemanager.AuiSingleDockingGuide`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Frame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuide.__init__` Default class constructor. Used internally, do not call it in your code!
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuide.HitTest` To be overridden by parent classes.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuide.ValidateNotebookDocking` To be overridden by parent classes.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: AuiDockingGuide(wx.Frame)
Base class for :class:`AuiSingleDockingGuide` and :class:`AuiCenterDockingGuide`.
.. method:: __init__(self, parent, id=wx.ID_ANY, title="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.FRAME_TOOL_WINDOW | wx.STAY_ON_TOP | wx.FRAME_NO_TASKBAR | wx.NO_BORDER, name="AuiDockingGuide")
Default class constructor. Used internally, do not call it in your code!
:param `parent`: the :class:`AuiManager` parent;
: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 wx.Point `pos`: the window position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform.
:param wx.Size `size`: the window size. A value of (-1, -1) indicates a default size, chosen by
either the windowing system or wxPython, depending on platform.
:param integer `style`: the window style.
:param string `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.
.. method:: HitTest(self, x, y)
To be overridden by parent classes.
:param integer `x`: the `x` mouse position;
:param integer `y`: the `y` mouse position.
.. method:: ValidateNotebookDocking(self, valid)
To be overridden by parent classes.
:param bool `valid`: whether a pane can be docked on top to another to form an automatic
:class:`~wx.lib.agw.aui.auibook.AuiNotebook`.
|
