.. wxPython Phoenix documentation

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

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

.. include:: headings.inc

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

.. highlight:: python



.. _wx.lib.agw.flatnotebook.FNBRendererVC8:

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

This class handles the drawing of tabs using the `VC8` 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>FNBRendererVC8</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.FNBRendererVC8_inheritance.png" alt="Inheritance diagram of FNBRendererVC8" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.flatnotebook.FNBRenderer.html" title="wx.lib.agw.flatnotebook.FNBRenderer" alt="" coords="18,5,272,35"/> <area shape="rect" id="node2" href="wx.lib.agw.flatnotebook.FNBRendererVC8.html" title="wx.lib.agw.flatnotebook.FNBRendererVC8" alt="" coords="5,83,285,112"/> </map> 
   </p>

|


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

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

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.__init__`                         Default class constructor.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.DrawTab`                          Draws a tab using the `VC8` style.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.DrawTabs`                         Draws all the tabs using `VC8` style.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.FillVC8GradientColour`            Fills a tab with a gradient shading.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.GetEndX`                          Returns the `x` end position of a tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.GetStartX`                        Returns the `x` start position of a tab.
:meth:`~wx.lib.agw.flatnotebook.FNBRendererVC8.NumberTabsCanFit`                 Calculates the number of tabs that can fit on the available space on screen.
================================================================================ ================================================================================


|


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


.. class:: FNBRendererVC8(FNBRenderer)

   This class handles the drawing of tabs using the `VC8` renderer.

   .. method:: __init__(self)

      Default class constructor. 


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

      Draws a tab using the `VC8` 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)

      Draws all the tabs using `VC8` style.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `dc`: an instance of :class:`wx.DC`.


   .. method:: FillVC8GradientColour(self, pageContainer, dc, tabPoints, bSelectedTab, tabIdx)

      Fills a tab with a gradient shading.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `dc`: an instance of :class:`wx.DC`;
      :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline;
      :param `bSelectedTab`: ``True`` if the tab is selected, ``False`` otherwise;
      :param `tabIdx`: the index of the tab;


   .. method:: GetEndX(self, tabPoints, y, style)

      Returns the `x` end position of a tab.
      
      :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline;
      :param `y`: the y end position of the tab;
      :param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top).


   .. method:: GetStartX(self, tabPoints, y, style)

      Returns the `x` start position of a tab.
      
      :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline;
      :param `y`: the y start position of the tab;
      :param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top).


   .. method:: NumberTabsCanFit(self, pageContainer, fr=-1)

      Calculates the number of tabs that can fit on the available space on screen.
      
      :param `pageContainer`: an instance of :class:`FlatNotebook`;
      :param `fr`: the current first visible tab.


