.. 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.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.svg" alt="Inheritance diagram of AuiDockingGuideInfo" 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.AuiDockingGuideInfo.html" title="A class which holds information about VS2005 docking guide windows." alt="" coords="5,5,396,34"/> </map> 
   </p>
   </div>

|


|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) -> Self

      Sets the guide window to bottom docking. 


   .. method:: Center(self) -> Self

      Sets the guide window to center docking. 


   .. method:: Centre(self) -> Self

      Sets the guide window to centre docking. 


   .. method:: Host(self, h) -> Self

      Hosts a docking guide window.
      
      :param `h`: an instance of :class:`AuiDockingGuideWindow` or :class:`AuiDockingHintWindow`.


   .. method:: Left(self) -> Self

      Sets the guide window to left docking. 


   .. method:: Right(self) -> Self

      Sets the guide window to right docking. 


   .. method:: Top(self) -> Self

      Sets the guide window to top docking.