

.. module:: wx.aui


.. include:: headings.inc

=========================================================================
**wx.aui**
=========================================================================

`wx.aui` provides a set of classes for implementing an "Advanced User Interface".
More specifically, these classes enable to you present some of your application in
floating or dockable panels, notebooks with floatable tabs, etc.

There is also a pure-python implementation of these classes available in the
`wx.lib.agw.aui` package.


Class Summary
=============

================================================================================ ================================================================================
**Class**                                                                        **Short Description**
================================================================================ ================================================================================
`~wx.aui.AuiBookDeserializer`                                                    :ref:`wx.aui.AuiBookDeserializer`  is used for deserializing :ref:`wx.aui.AuiNotebook`  layout.
`~wx.aui.AuiBookSerializer`                                                      :ref:`wx.aui.AuiBookSerializer`  is used for serializing :ref:`wx.aui.AuiNotebook`  layout.
`~wx.aui.AuiDefaultDockArt`                                                      This is the default art provider for :ref:`wx.aui.AuiManager`.
`~wx.aui.AuiDefaultToolBarArt`                                                   :ref:`wx.aui.AuiDefaultToolBarArt`  is part of the ``AUI`` class framework.
`~wx.aui.AuiDeserializer`                                                        :ref:`wx.aui.AuiDeserializer`  is used by :meth:`wx.aui.AuiManager.LoadLayout`   to restore layout information saved by :meth:`wx.aui.AuiManager.SaveLayout` .
`~wx.aui.AuiDockArt`                                                             :ref:`wx.aui.AuiDockArt`  is part of the ``AUI`` class framework.
`~wx.aui.AuiDockInfo`                                                            
`~wx.aui.AuiDockLayoutInfo`                                                      Description of a docked element layout.
`~wx.aui.AuiDockUIPart`                                                          
`~wx.aui.AuiFlatTabArt`                                                          An art provider for :ref:`wx.aui.AuiNotebook`  implementing "flat" look.
`~wx.aui.AuiFloatingFrame`                                                       
`~wx.aui.AuiGenericTabArt`                                                       An art provider for :ref:`wx.aui.AuiNotebook`  implementing "glossy" look.
`~wx.aui.AuiManager`                                                             :ref:`wx.aui.AuiManager`  is the central class of the ``AUI`` class framework.
`~wx.aui.AuiManagerEvent`                                                        Event used to indicate various actions taken with :ref:`wx.aui.AuiManager`.
`~wx.aui.AuiMDIChildFrame`                                                       
`~wx.aui.AuiMDIClientWindow`                                                     
`~wx.aui.AuiMDIParentFrame`                                                      
`~wx.aui.AuiNotebook`                                                            :ref:`wx.aui.AuiNotebook`  is part of the ``AUI`` class framework, which represents a notebook control, managing multiple windows with associated tabs.
`~wx.aui.AuiNotebookEvent`                                                       This class is used by the events generated by :ref:`wx.aui.AuiNotebook`.
`~wx.aui.AuiNotebookPage`                                                        Holds information about a page in :ref:`wx.aui.AuiNotebook`.
`~wx.aui.AuiNotebookPosition`                                                    Simple struct combining :ref:`wx.aui.AuiTabCtrl`  with the position inside it.
`~wx.aui.AuiPaneInfo`                                                            :ref:`wx.aui.AuiPaneInfo`  is part of the ``AUI`` class framework.
`~wx.aui.AuiPaneLayoutInfo`                                                      Description of user-modifiable pane layout information.
`~wx.aui.AuiSerializer`                                                          :ref:`wx.aui.AuiSerializer`  is used by :meth:`wx.aui.AuiManager.SaveLayout`   to store layout information.
`~wx.aui.AuiSimpleTabArt`                                                        Another standard tab art provider for :ref:`wx.aui.AuiNotebook`.
`~wx.aui.AuiTabArt`                                                              Tab art provider defines all the drawing functions used by :ref:`wx.aui.AuiNotebook`.
`~wx.aui.AuiTabContainer`                                                        :ref:`wx.aui.AuiTabContainer`  is a class which contains information about each tab.
`~wx.aui.AuiTabContainerButton`                                                  A simple class which holds information about :ref:`wx.aui.AuiNotebook`  tab buttons and their state.
`~wx.aui.AuiTabCtrl`                                                             
`~wx.aui.AuiTabLayoutInfo`                                                       Contains information about the layout of a tab control in a :ref:`wx.aui.AuiNotebook`.
`~wx.aui.AuiToolBar`                                                             :ref:`wx.aui.AuiToolBar`  is a dockable toolbar, part of the ``AUI`` class framework.
`~wx.aui.AuiToolBarArt`                                                          :ref:`wx.aui.AuiToolBarArt`  is part of the ``AUI`` class framework and is the base class defining the interface for rendering :ref:`wx.aui.AuiToolBar`.
`~wx.aui.AuiToolBarEvent`                                                        :ref:`wx.aui.AuiToolBarEvent`  is used for the events generated by :ref:`wx.aui.AuiToolBar`.
`~wx.aui.AuiToolBarItem`                                                         :ref:`wx.aui.AuiToolBarItem`  is part of the ``AUI`` class framework, representing a toolbar element.
`~wx.aui.AuiTabContainer.HitTestResult`                                          
================================================================================ ================================================================================


.. toctree::
   :maxdepth: 1
   :hidden:

   wx.aui.AuiBookDeserializer
   wx.aui.AuiBookSerializer
   wx.aui.AuiButtonId.enumeration
   wx.aui.AuiDefaultDockArt
   wx.aui.AuiDefaultToolBarArt
   wx.aui.AuiDeserializer
   wx.aui.AuiDockArt
   wx.aui.AuiDockInfo
   wx.aui.AuiDockLayoutInfo
   wx.aui.AuiDockUIPart
   wx.aui.AuiFlatTabArt
   wx.aui.AuiFloatingFrame
   wx.aui.AuiGenericTabArt
   wx.aui.AuiMDIChildFrame
   wx.aui.AuiMDIClientWindow
   wx.aui.AuiMDIParentFrame
   wx.aui.AuiManager
   wx.aui.AuiManagerDock.enumeration
   wx.aui.AuiManagerEvent
   wx.aui.AuiManagerOption.enumeration
   wx.aui.AuiMinDockOption.enumeration
   wx.aui.AuiNotebook
   wx.aui.AuiNotebookEvent
   wx.aui.AuiNotebookOption.enumeration
   wx.aui.AuiNotebookPage
   wx.aui.AuiNotebookPosition
   wx.aui.AuiPaneButtonState.enumeration
   wx.aui.AuiPaneDockArtGradients.enumeration
   wx.aui.AuiPaneDockArtSetting.enumeration
   wx.aui.AuiPaneInfo
   wx.aui.AuiPaneLayoutInfo
   wx.aui.AuiSerializer
   wx.aui.AuiSimpleTabArt
   wx.aui.AuiTabArt
   wx.aui.AuiTabContainer
   wx.aui.AuiTabContainer.HitTestResult
   wx.aui.AuiTabContainerButton
   wx.aui.AuiTabCtrl
   wx.aui.AuiTabKind.enumeration
   wx.aui.AuiTabLayoutInfo
   wx.aui.AuiTextDirection.enumeration
   wx.aui.AuiToolBar
   wx.aui.AuiToolBarArt
   wx.aui.AuiToolBarArtSetting.enumeration
   wx.aui.AuiToolBarEvent
   wx.aui.AuiToolBarItem
   wx.aui.AuiToolBarStyle.enumeration
   wx.aui.AuiToolBarToolTextOrientation.enumeration

