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
|
.. 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.AuiDockingGuideInfo:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.aui.framemanager.AuiDockingGuideInfo**
==========================================================================================================================================
A class which holds information about VS2005 docking guide windows.
|
|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>AuiDockingGuideInfo</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.AuiDockingGuideInfo_inheritance.png" alt="Inheritance diagram of AuiDockingGuideInfo" 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.lib.agw.aui.framemanager.AuiDockingGuideInfo.html" title="wx.lib.agw.aui.framemanager.AuiDockingGuideInfo" alt="" coords="5,5,347,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.__init__` Default class constructor.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Assign` Assigns the properties of the `other` :class:`AuiDockingGuideInfo` to `self`.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Bottom` Sets the guide window to bottom docking.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Center` Sets the guide window to center docking.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Centre` Sets the guide window to centre docking.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Host` Hosts a docking guide window.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Left` Sets the guide window to left docking.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Right` Sets the guide window to right docking.
:meth:`~wx.lib.agw.aui.framemanager.AuiDockingGuideInfo.Top` Sets the guide window to top docking.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: AuiDockingGuideInfo(object)
A class which holds information about VS2005 docking guide windows.
.. method:: __init__(self, other=None)
Default class constructor.
Used internally, do not call it in your code!
:param `other`: another instance of :class:`AuiDockingGuideInfo`.
.. method:: Assign(self, other)
Assigns the properties of the `other` :class:`AuiDockingGuideInfo` to `self`.
:param `other`: another instance of :class:`AuiDockingGuideInfo`.
.. method:: Bottom(self)
Sets the guide window to bottom docking.
.. method:: Center(self)
Sets the guide window to center docking.
.. method:: Centre(self)
Sets the guide window to centre docking.
.. method:: Host(self, h)
Hosts a docking guide window.
:param `h`: an instance of :class:`AuiDockingGuideWindow` or :class:`AuiDockingHintWindow`.
.. method:: Left(self)
Sets the guide window to left docking.
.. method:: Right(self)
Sets the guide window to right docking.
.. method:: Top(self)
Sets the guide window to top docking.
|