.. 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



.. _wx.aui.AuiDockLayoutInfo:

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiDockLayoutInfo**
==========================================================================================================================================

Description of a docked element layout. 
         

The fields in this struct are shared by :ref:`wx.aui.AuiPaneLayoutInfo`  and :ref:`wx.aui.AuiTabLayoutInfo`  and contain information about the layout of a docked pane or tab layout. 

Note that when saving the objects of this type, fields that have the value of 0 can be omitted, as this is their default value in any case (except for  ``dock_direction``   which is never 0), to make the serialized representation more compact. 


         



.. versionadded:: 4.3/wxWidgets-3.3.0  
     







|

|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>AuiDockLayoutInfo</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.aui.AuiDockLayoutInfo_inheritance.svg" alt="Inheritance diagram of AuiDockLayoutInfo" 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.aui.AuiDockLayoutInfo.html" title="Description of a docked element layout." alt="" coords="5,5,219,34"/> </map> 
   </p>
   </div>

|


|sub_classes| Known Subclasses
==============================

:ref:`wx.aui.AuiPaneLayoutInfo`, :ref:`wx.aui.AuiTabLayoutInfo`

|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.aui.AuiDockLayoutInfo.dock_direction`                                 A public C++ attribute of type ``int``. Direction of the dock containing the pane. 
                 
:attr:`~wx.aui.AuiDockLayoutInfo.dock_layer`                                     A public C++ attribute of type ``int``. Layer of the dock containing the pane. 
                 
:attr:`~wx.aui.AuiDockLayoutInfo.dock_pos`                                       A public C++ attribute of type ``int``. Position of the pane in the dock containing it. 
                 
:attr:`~wx.aui.AuiDockLayoutInfo.dock_proportion`                                A public C++ attribute of type ``int``. Relative proportion of the dock allocated to this pane. 
                 
:attr:`~wx.aui.AuiDockLayoutInfo.dock_row`                                       A public C++ attribute of type ``int``. Row of the dock containing the pane. 
                 
:attr:`~wx.aui.AuiDockLayoutInfo.dock_size`                                      A public C++ attribute of type ``int``. Size of the containing dock. 
                 
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.aui.AuiDockLayoutInfo(object)

   Description of a docked element layout.



   .. attribute:: dock_direction

      A public C++ attribute of type ``int``. Direction of the dock containing the pane. 
                 


   .. attribute:: dock_layer

      A public C++ attribute of type ``int``. Layer of the dock containing the pane. 
                 


   .. attribute:: dock_pos

      A public C++ attribute of type ``int``. Position of the pane in the dock containing it. 
                 


   .. attribute:: dock_proportion

      A public C++ attribute of type ``int``. Relative proportion of the dock allocated to this pane. 
                 


   .. attribute:: dock_row

      A public C++ attribute of type ``int``. Row of the dock containing the pane. 
                 


   .. attribute:: dock_size

      A public C++ attribute of type ``int``. Size of the containing dock.