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

Inheritance diagram for class
FNBRendererRibbonTabs:
|
|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`.