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

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiBookSerializer**
==========================================================================================================================================

:ref:`wx.aui.AuiBookSerializer`  is used for serializing :ref:`wx.aui.AuiNotebook`  layout. 
         

This includes the tab controls layout and the order of pages in them. 

It can be used standalone with :meth:`wx.aui.AuiNotebook.SaveLayout`   or as base class of :ref:`wx.aui.AuiSerializer`  for saving and restoring the entire layout. 








         



.. 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>AuiBookSerializer</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.AuiBookSerializer_inheritance.svg" alt="Inheritance diagram of AuiBookSerializer" 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.AuiBookSerializer.html" title="wx.aui.AuiBookSerializer  is used for serializing wx.aui.AuiNotebook  layout." alt="" coords="5,5,213,34"/> </map> 
   </p>
   </div>

|


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

:ref:`wx.aui.AuiSerializer`

|


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

================================================================================ ================================================================================
:meth:`~wx.aui.AuiBookSerializer.__init__`                                       Trivial default constructor.
:meth:`~wx.aui.AuiBookSerializer.AfterSaveNotebook`                              Called after saving information about all the pages of the notebook in the ``AUI`` pane with the given name.
:meth:`~wx.aui.AuiBookSerializer.BeforeSaveNotebook`                             Called before starting to save information about the tabs in the notebook in the ``AUI`` pane with the given name.
:meth:`~wx.aui.AuiBookSerializer.SaveNotebookTabControl`                         Called to save information about a single tab control in the given notebook.
================================================================================ ================================================================================


|


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


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

   **Possible constructors**::

       AuiBookSerializer() -> None
       
   
   AuiBookSerializer is used for serializing AuiNotebook layout.



   .. method:: __init__(self)

      Trivial default constructor. 
                 

      :rtype: `None`     








   .. method:: AfterSaveNotebook(self)

      Called after saving information about all the pages of the notebook in the ``AUI`` pane with the given name. 
                 

      Does nothing by default. 
                 

      :rtype: `None`     








   .. method:: BeforeSaveNotebook(self, name)

      Called before starting to save information about the tabs in the notebook in the ``AUI`` pane with the given name. 
                 

      This function needs to be overridden to keep record of the notebook for which :meth:`SaveNotebookTabControl`   will be called next. 

      If this class is used as a base class of :ref:`wx.aui.AuiSerializer`, saving notebook layout may be unnecessary, e.g. because the program doesn't use :ref:`wx.aui.AuiNotebook`  at all, and the implementation can be trivial and just do nothing because it is not going to be called at all if there are no notebooks in the full layout. 

      When using :meth:`wx.aui.AuiNotebook.SaveLayout`   directly, this function is always called and is the first function of this class to be called. 
                 


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




      :rtype: `None`     








   .. method:: SaveNotebookTabControl(self, tab)

      Called to save information about a single tab control in the given notebook. 
                 

      This function will be called for all tab controls in the notebook after :meth:`BeforeSaveNotebook` . 

      As with that function, it has to be implemented, but can simply do nothing if saving notebook layout is not necessary. 
                 


      :param `tab`: 
      :type `tab`: wx.aui.AuiTabLayoutInfo




      :rtype: `None`