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

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiPaneLayoutInfo**
==========================================================================================================================================

Description of user-modifiable pane layout information. 
         

This struct is used with :ref:`wx.aui.AuiSerializer`  and :ref:`wx.aui.AuiDeserializer`  to store the pane layout. Its fields, including the inherited ones from :ref:`wx.aui.AuiDockLayoutInfo`, have the same meaning as the corresponding fields in :ref:`wx.aui.AuiPaneInfo`  (with the exception of  ``is_maximized``   and   ``is_hidden`` , which rather correspond to the individual bits of its state field), but it doesn't contain the fields that it wouldn't make sense to serialize. 


         



.. 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>AuiPaneLayoutInfo</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.AuiPaneLayoutInfo_inheritance.svg" alt="Inheritance diagram of AuiPaneLayoutInfo" 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.AuiPaneLayoutInfo.html" title="Description of user-modifiable pane layout information." alt="" coords="5,82,220,111"/> <area shape="rect" id="node2" href="wx.aui.AuiDockLayoutInfo.html" title="Description of a docked element layout." alt="" coords="6,5,220,34"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.aui.AuiPaneLayoutInfo.__init__`                                       Ctor sets the name, which is always required.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.aui.AuiPaneLayoutInfo.floating_pos`                                   A public C++ attribute of type `~wx.Point`     . Position of the pane when floating, may be invalid. 
                 
:attr:`~wx.aui.AuiPaneLayoutInfo.floating_size`                                  A public C++ attribute of type `~wx.Size`     . Size of the pane when floating, may be invalid. 
                 
:attr:`~wx.aui.AuiPaneLayoutInfo.is_hidden`                                      A public C++ attribute of type ``bool``. True if the pane is currently hidden. 
                 
:attr:`~wx.aui.AuiPaneLayoutInfo.is_maximized`                                   A public C++ attribute of type ``bool``. True if the pane is currently maximized. 
                 
:attr:`~wx.aui.AuiPaneLayoutInfo.name`                                           A public C++ attribute of type ``string``. Unique name of the pane. 
                 
================================================================================ ================================================================================


|


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


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

   **Possible constructors**::

       AuiPaneLayoutInfo(name) -> None
       
   
   Description of user-modifiable pane layout information.



   .. method:: __init__(self, name)

      Ctor sets the name, which is always required. 
                 


      :param `name`: 
      :type `name`: string




      :rtype: `None`     








   .. attribute:: floating_pos

      A public C++ attribute of type `~wx.Point`     . Position of the pane when floating, may be invalid. 
                 


   .. attribute:: floating_size

      A public C++ attribute of type `~wx.Size`     . Size of the pane when floating, may be invalid. 
                 


   .. attribute:: is_hidden

      A public C++ attribute of type ``bool``. True if the pane is currently hidden. 
                 


   .. attribute:: is_maximized

      A public C++ attribute of type ``bool``. True if the pane is currently maximized. 
                 


   .. attribute:: name

      A public C++ attribute of type ``string``. Unique name of the pane.