.. 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.AuiDefaultTabArt: ========================================================================================================================================== |phoenix_title| **wx.aui.AuiDefaultTabArt** ========================================================================================================================================== Default art provider for :ref:`wx.aui.AuiNotebook`. .. seealso:: :ref:`wx.aui.AuiTabArt` | |class_hierarchy| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class AuiDefaultTabArt:
| |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.aui.AuiDefaultTabArt.__init__` :meth:`~wx.aui.AuiDefaultTabArt.Clone` Clones the art object. :meth:`~wx.aui.AuiDefaultTabArt.DrawBackground` Draws a background on the given area. :meth:`~wx.aui.AuiDefaultTabArt.DrawButton` Draws a button. :meth:`~wx.aui.AuiDefaultTabArt.DrawTab` Draws a tab. :meth:`~wx.aui.AuiDefaultTabArt.GetBestTabCtrlSize` Returns the tab control size. :meth:`~wx.aui.AuiDefaultTabArt.GetIndentSize` Returns the indent size. :meth:`~wx.aui.AuiDefaultTabArt.GetTabSize` Returns the tab size for the given caption, bitmap and state. :meth:`~wx.aui.AuiDefaultTabArt.SetActiveColour` Sets the colour of the selected tab. :meth:`~wx.aui.AuiDefaultTabArt.SetColour` Sets the colour of the inactive tabs. :meth:`~wx.aui.AuiDefaultTabArt.SetFlags` Sets flags. :meth:`~wx.aui.AuiDefaultTabArt.SetMeasuringFont` Sets the font used for calculating measurements. :meth:`~wx.aui.AuiDefaultTabArt.SetNormalFont` Sets the normal font for drawing labels. :meth:`~wx.aui.AuiDefaultTabArt.SetSelectedFont` Sets the font for drawing text for selected UI elements. :meth:`~wx.aui.AuiDefaultTabArt.SetSizingInfo` Sets sizing information. :meth:`~wx.aui.AuiDefaultTabArt.ShowDropDown` ================================================================================ ================================================================================ | |property_summary| Properties Summary ===================================== ================================================================================ ================================================================================ :attr:`~wx.aui.AuiDefaultTabArt.IndentSize` See :meth:`~wx.aui.AuiDefaultTabArt.GetIndentSize` ================================================================================ ================================================================================ | |api| Class API =============== .. class:: wx.aui.AuiDefaultTabArt(AuiTabArt) **Possible constructors**:: AuiDefaultTabArt() -> None Default art provider for AuiNotebook. .. method:: __init__(self) :rtype: `None` .. method:: Clone(self) Clones the art object. :rtype: :ref:`wx.aui.AuiTabArt` .. method:: DrawBackground(self, dc : DC, wnd : Window, rect : 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 : DC, wnd : Window, in_rect : Rect, bitmap_id : int, button_state : int, orientation : int, out_rect : 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 : DC, wnd : Window, page : AuiNotebookPage, rect : Rect, close_button_state : int, out_tab_rect : Rect, out_button_rect : Rect, x_extent : int) Draws a tab. :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:: GetBestTabCtrlSize(self, : Window, : AuiNotebookPageArray, : Size) Returns the tab control size. :param ``: :type ``: wx.Size :rtype: `int` .. method:: GetIndentSize(self) Returns the indent size. :rtype: `int` .. method:: GetTabSize(self, dc : DC, wnd : Window, caption : str, bitmap : BitmapBundle, active : bool, close_button_state : int, x_extent : int) Returns the tab size for the given caption, bitmap and state. :param `dc`: :type `dc`: wx.DC :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 : Colour) Sets the colour of the selected tab. :param `colour`: :type `colour`: wx.Colour :rtype: `None` .. versionadded:: 2.9.2 .. method:: SetColour(self, colour : Colour) Sets the colour of the inactive tabs. :param `colour`: :type `colour`: wx.Colour :rtype: `None` .. versionadded:: 2.9.2 .. method:: SetFlags(self, flags : int) Sets flags. :param `flags`: :type `flags`: int :rtype: `None` .. method:: SetMeasuringFont(self, font : Font) Sets the font used for calculating measurements. :param `font`: :type `font`: wx.Font :rtype: `None` .. method:: SetNormalFont(self, font : Font) Sets the normal font for drawing labels. :param `font`: :type `font`: wx.Font :rtype: `None` .. method:: SetSelectedFont(self, font : Font) Sets the font for drawing text for selected UI elements. :param `font`: :type `font`: wx.Font :rtype: `None` .. method:: SetSizingInfo(self, tab_ctrl_size : Size, tab_count : int, wnd: Optional[Window]=None) Sets sizing information. The `wnd` argument is only present in wxWidgets 3.1.6 and newer and is required, it only has ``None`` 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` .. method:: ShowDropDown(self, wnd : Window, items : AuiNotebookPageArray, activeIdx : int) :param `wnd`: :type `wnd`: wx.Window :param `items`: :type `items`: AuiNotebookPageArray :param `activeIdx`: :type `activeIdx`: int :rtype: `int` .. attribute:: IndentSize See :meth:`~wx.aui.AuiDefaultTabArt.GetIndentSize`