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

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiFlatTabArt**
==========================================================================================================================================

An art provider for :ref:`wx.aui.AuiNotebook`  implementing "flat" look. 
         

This art provider is currently used as the default art provider. 








         



.. versionadded:: 4.3/wxWidgets-3.3.0  
     







|

|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>AuiFlatTabArt</strong>:</label>
      <div class="collapsible-content">
         <p class="graphviz">
            <center><img src="_static/images/inheritance/wx.aui.AuiFlatTabArt_inheritance.svg" alt="Inheritance diagram of AuiFlatTabArt" usemap="#dummy" class="inheritance invert-in-dark-mode"/></center>
            <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.aui.AuiFlatTabArt.html" title="An art provider for wx.aui.AuiNotebook  implementing 'flat' look." alt="" coords="5,82,181,111"/> <area shape="rect" id="node2" href="wx.aui.AuiTabArt.html" title="Tab art provider defines all the drawing functions used by wx.aui.AuiNotebook." alt="" coords="19,5,168,34"/> </map> 
         </p>
      </div>
   </div>
   <script type="text/javascript" src="_static/inheritancetoggle.js"></script>



|


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

================================================================================ ================================================================================
:meth:`~wx.aui.AuiFlatTabArt.__init__`                                           Default constructor.
:meth:`~wx.aui.AuiFlatTabArt.Clone`                                              Clones the art object.
:meth:`~wx.aui.AuiFlatTabArt.DrawBackground`                                     Draws a background on the given area.
:meth:`~wx.aui.AuiFlatTabArt.DrawButton`                                         Draws a button.
:meth:`~wx.aui.AuiFlatTabArt.GetIndentSize`                                      Returns the indent size.
:meth:`~wx.aui.AuiFlatTabArt.SetActiveColour`                                    Sets the colour of the selected tab.
:meth:`~wx.aui.AuiFlatTabArt.SetColour`                                          Sets the colour of the inactive tabs.
:meth:`~wx.aui.AuiFlatTabArt.SetFlags`                                           Sets flags.
:meth:`~wx.aui.AuiFlatTabArt.SetMeasuringFont`                                   Sets the font used for calculating measurements.
:meth:`~wx.aui.AuiFlatTabArt.SetNormalFont`                                      Sets the normal font for drawing labels.
:meth:`~wx.aui.AuiFlatTabArt.SetSelectedFont`                                    Sets the font for drawing text for selected UI elements.
:meth:`~wx.aui.AuiFlatTabArt.SetSizingInfo`                                      Sets sizing information.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.aui.AuiFlatTabArt.IndentSize`                                         See :meth:`~wx.aui.AuiFlatTabArt.GetIndentSize`
================================================================================ ================================================================================


|


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


.. class:: wx.aui.AuiFlatTabArt(AuiTabArt)

   **Possible constructors**::

       AuiFlatTabArt() -> None
       
   
   An art provider for AuiNotebook implementing "flat" look.



   .. method:: __init__(self)

      Default constructor. 
                 

      :rtype: `None`     








   .. method:: Clone(self)

      Clones the art object. 
                 

      :rtype: :ref:`wx.aui.AuiTabArt`








   .. method:: DrawBackground(self, dc, wnd, rect)

      Draws a background on the given area. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `wnd`: 
      :type `wnd`: wx.Window
      :param `rect`: 
      :type `rect`: wx.Rect




      :rtype: `None`     








   .. method:: DrawButton(self, dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect)

      Draws a button. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `wnd`: 
      :type `wnd`: wx.Window
      :param `in_rect`: 
      :type `in_rect`: wx.Rect
      :param `bitmap_id`: 
      :type `bitmap_id`: int
      :param `button_state`: 
      :type `button_state`: int
      :param `orientation`: 
      :type `orientation`: int
      :param `out_rect`: 
      :type `out_rect`: wx.Rect




      :rtype: `None`     








   .. method:: GetIndentSize(self)

      Returns the indent size. 
                 

      :rtype: `int`








   .. method:: SetActiveColour(self, colour)

      Sets the colour of the selected tab. 
                 


                


      :param `colour`: 
      :type `colour`: wx.Colour




      :rtype: `None`     







      .. versionadded:: 2.9.2 
     








   .. method:: SetColour(self, colour)

      Sets the colour of the inactive tabs. 
                 


                


      :param `colour`: 
      :type `colour`: wx.Colour




      :rtype: `None`     







      .. versionadded:: 2.9.2 
     








   .. method:: SetFlags(self, flags)

      Sets flags. 
                 


      :param `flags`: 
      :type `flags`: int




      :rtype: `None`     








   .. method:: SetMeasuringFont(self, font)

      Sets the font used for calculating measurements. 
                 


      :param `font`: 
      :type `font`: wx.Font




      :rtype: `None`     








   .. method:: SetNormalFont(self, font)

      Sets the normal font for drawing labels. 
                 


                


      :param `font`: 
      :type `font`: wx.Font




      :rtype: `None`     







      .. seealso:: :meth:`~wx.aui.AuiTabArt.GetNormalFont`     








   .. method:: SetSelectedFont(self, font)

      Sets the font for drawing text for selected UI elements. 
                 


                


      :param `font`: 
      :type `font`: wx.Font




      :rtype: `None`     







      .. seealso:: :meth:`~wx.aui.AuiTabArt.GetSelectedFont`     








   .. method:: SetSizingInfo(self, tab_ctrl_size, tab_count, wnd=None)

      Sets sizing information. 
                 

      The `wnd`  argument is only present in wxWidgets 3.1.6 and newer and is required, it only has nullptr default value for compatibility reasons. 
                 


      :param `tab_ctrl_size`: 
      :type `tab_ctrl_size`: wx.Size
      :param `tab_count`: 
      :type `tab_count`: int
      :param `wnd`: 
      :type `wnd`: wx.Window




      :rtype: `None`     








   .. attribute:: IndentSize

      See :meth:`~wx.aui.AuiFlatTabArt.GetIndentSize`