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

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiGenericTabArt**
==========================================================================================================================================

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

This art provider is used as fallback art provider for AuiNativeTabArt if there is no native tab art provider, but may also be used directly. 











.. seealso:: :ref:`wx.aui.AuiTabArt`  







|

|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>AuiGenericTabArt</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.AuiGenericTabArt_inheritance.svg" alt="Inheritance diagram of AuiGenericTabArt" 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.AuiGenericTabArt.html" title="An art provider for wx.aui.AuiNotebook  implementing 'glossy' look." alt="" coords="5,82,210,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="33,5,182,34"/> </map> 
   </p>
   </div>

|


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

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


|


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

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


|


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


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

   **Possible constructors**::

       AuiGenericTabArt() -> None
       
   
   An art provider for AuiNotebook implementing "glossy" look.



   .. method:: __init__(self)



      :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:: DrawTab(self, dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect, x_extent)

      Draws a tab. 
                 

      This function used to be pure virtual and so had to be overridden in the derived classes in the previous versions of wxWidgets, however since version 3.3.0 it doesn't have to be overridden if :meth:`~wx.aui.AuiTabArt.DrawPageTab`   is overridden and, moreover, it is recommended to override :meth:`~wx.aui.AuiTabArt.DrawPageTab`   instead of this function in the new code. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `wnd`: 
      :type `wnd`: wx.Window
      :param `page`: 
      :type `page`: wx.aui.AuiNotebookPage
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `close_button_state`: 
      :type `close_button_state`: int
      :param `out_tab_rect`: 
      :type `out_tab_rect`: wx.Rect
      :param `out_button_rect`: 
      :type `out_button_rect`: wx.Rect
      :param `x_extent`: 
      :type `x_extent`: int




      :rtype: `None`     








   .. method:: GetIndentSize(self)

      Returns the indent size. 
                 

      :rtype: `int`








   .. method:: GetTabSize(self, dc, wnd, caption, bitmap, active, close_button_state, x_extent)

      Returns the tab size for the given caption, bitmap and state. 
                 

      This function used to be pure virtual and so had to be overridden in the derived classes in the previous versions of wxWidgets, however since version 3.3.0 it doesn't have to be overridden if :meth:`~wx.aui.AuiTabArt.GetPageTabSize`   is overridden and it is recommended to override :meth:`~wx.aui.AuiTabArt.GetPageTabSize`   instead of this function in the new code. 
                 


      :param `dc`: 
      :type `dc`: wx.ReadOnlyDC
      :param `wnd`: 
      :type `wnd`: wx.Window
      :param `caption`: 
      :type `caption`: string
      :param `bitmap`: 
      :type `bitmap`: wx.BitmapBundle
      :param `active`: 
      :type `active`: bool
      :param `close_button_state`: 
      :type `close_button_state`: int
      :param `x_extent`: 
      :type `x_extent`: int




      :rtype: `Size`     








   .. 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=nullptr)

      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.AuiGenericTabArt.GetIndentSize`