.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2025 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.aui.AuiNotebookPage:

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiNotebookPage**
==========================================================================================================================================

Holds information about a page in :ref:`wx.aui.AuiNotebook`. 
         

An object of this class is notably passed to :meth:`wx.aui.AuiTabArt.DrawTab`   and is used by it to render the pages tab accordingly. 









|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div class="collabsible-wrapper">
      <input id="collapsible-inheritance" class="collapsible-checkbox" type="checkbox">
      <label for="collapsible-inheritance" tabindex="0" title="Show inheritance diagram" class="collapsible-label">Inheritance diagram for class <strong>AuiNotebookPage</strong>:</label>
      <div class="collapsible-content">
         <p class="graphviz">
            <center><img src="_static/images/inheritance/wx.aui.AuiNotebookPage_inheritance.svg" alt="Inheritance diagram of AuiNotebookPage" usemap="#dummy" class="inheritance invert-in-dark-mode"/></center>
            <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.aui.AuiNotebookPage.html" title="Holds information about a page in wx.aui.AuiNotebook." alt="" coords="5,5,215,34"/> </map> 
         </p>
      </div>
   </div>
   <script type="text/javascript" src="_static/inheritancetoggle.js"></script>



|


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

================================================================================ ================================================================================
:attr:`~wx.aui.AuiNotebookPage.active`                                           A public C++ attribute of type ``bool``. True if the page is the currently selected page. 
                 
:attr:`~wx.aui.AuiNotebookPage.bitmap`                                           A public C++ attribute of type `~wx.BitmapBundle`     . Bitmap shown in the tab if valid. 
                 
:attr:`~wx.aui.AuiNotebookPage.caption`                                          A public C++ attribute of type ``string``. Text displayed on the tab. 
                 
:attr:`~wx.aui.AuiNotebookPage.rect`                                             A public C++ attribute of type `~wx.Rect`     . The bounding rectangle of this page tab. 
                 
:attr:`~wx.aui.AuiNotebookPage.tooltip`                                          A public C++ attribute of type ``string``. Tooltip displayed when hovering over tab title. 
                 
:attr:`~wx.aui.AuiNotebookPage.window`                                           A public C++ attribute of type `~wx.Window`     . Window shown on this page. 
                 
================================================================================ ================================================================================


|


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


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

   Holds information about a page in AuiNotebook.



   .. attribute:: active

      A public C++ attribute of type ``bool``. True if the page is the currently selected page. 
                 


   .. attribute:: bitmap

      A public C++ attribute of type `~wx.BitmapBundle`     . Bitmap shown in the tab if valid. 
                 


   .. attribute:: caption

      A public C++ attribute of type ``string``. Text displayed on the tab. 
                 


   .. attribute:: rect

      A public C++ attribute of type `~wx.Rect`     . The bounding rectangle of this page tab. 
                 


   .. attribute:: tooltip

      A public C++ attribute of type ``string``. Tooltip displayed when hovering over tab title. 
                 


   .. attribute:: window

      A public C++ attribute of type `~wx.Window`     . Window shown on this page.