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

.. currentmodule:: wx.lib.agw.flatnotebook

.. highlight:: python



.. _wx.lib.agw.flatnotebook.FNBRendererRibbonTabs:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.flatnotebook.FNBRendererRibbonTabs**
==========================================================================================================================================

This class handles the drawing of tabs using the `Ribbon Tabs` renderer.



|

|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>FNBRendererRibbonTabs</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.lib.agw.flatnotebook.FNBRendererRibbonTabs_inheritance.svg" alt="Inheritance diagram of FNBRendererRibbonTabs" 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.lib.agw.flatnotebook.FNBRendererRibbonTabs.html" title="This class handles the drawing of tabs using the `Ribbon Tabs` renderer." alt="" coords="5,82,389,111"/> <area shape="rect" id="node2" href="wx.lib.agw.flatnotebook.FNBRenderer.html" title="Parent class for the 6 renderers defined: `Standard`, `VC71`, `Fancy`, `Firefox 2`," alt="" coords="48,5,346,34"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.lib.agw.flatnotebook.FNBRenderer`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatnotebook.FNBRendererRibbonTabs.__init__`                  Default class constructor.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererRibbonTabs.CalcTabWidth`              Calculates the width of the input tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererRibbonTabs.DrawTab`                   Draws a tab using the `Ribbon Tabs` style.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererRibbonTabs.DrawTabs`                  Actually draws the tabs in :class:`FlatNotebook`.
================================================================================ ================================================================================


|


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


.. class:: FNBRendererRibbonTabs(FNBRenderer)

   This class handles the drawing of tabs using the `Ribbon Tabs` renderer.

   .. method:: __init__(self)

      Default class constructor. 


   .. method:: CalcTabWidth(self, pageContainer, tabIdx, tabHeight)

      Calculates the width of the input tab.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `tabIdx`: the index of the input tab;
      :param `tabHeight`: the height of the tab.


   .. method:: DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus)

      Draws a tab using the `Ribbon Tabs` style.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `dc`: an instance of :class:`wx.DC`;
      :param `posx`: the x position of the tab;
      :param `tabIdx`: the index of the tab;
      :param `tabWidth`: the tab's width;
      :param `tabHeight`: the tab's height;
      :param `btnStatus`: the status of the 'X' button inside this tab.


   .. method:: DrawTabs(self, pageContainer, dc)

      Actually draws the tabs in :class:`FlatNotebook`.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `dc`: an instance of :class:`wx.DC`.