phoenix_title wx.lib.agw.aui.tabart.VC8TabArt

A class to draw tabs using the Visual Studio 2005 (VC8) style.


class_hierarchy Class Hierarchy

Inheritance diagram for class VC8TabArt:

super_classes Known Superclasses

wx.lib.agw.aui.tabart.AuiDefaultTabArt


method_summary Methods Summary

__init__

Default class constructor.

Clone

Clones the art object.

DrawTab

Draws a single tab.

FillVC8GradientColour

Fills the tab with the Visual Studio 2005 gradient background.

GetTabSize

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

SetSizingInfo

Sets the tab sizing information.


api Class API

class VC8TabArt(AuiDefaultTabArt)

A class to draw tabs using the Visual Studio 2005 (VC8) style.


Methods

__init__(self)

Default class constructor.



Clone(self)

Clones the art object.



DrawTab(self, dc, wnd, page, in_rect, close_button_state, paint_control=False)

Draws a single tab.

Parameters:
  • dc – a wx.DC device context;

  • wnd – a wx.Window instance object;

  • page – the tab control page associated with the tab;

  • in_rect (wx.Rect) – rectangle the tab should be confined to;

  • close_button_state (integer) – the state of the close button on the tab;

  • paint_control (bool) – whether to draw the control inside a tab (if any) on a MemoryDC.



FillVC8GradientColour(self, dc, tabPoints, active)

Fills the tab with the Visual Studio 2005 gradient background.

Parameters:
  • dc – a wx.DC device context;

  • tabPoints (list) – a list of wx.Point objects describing the tab shape;

  • active (bool) – whether the tab is selected or not.



GetTabSize(self, dc, wnd, caption, bitmap, active, close_button_state, control=None)

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

Parameters:
  • dc – a wx.DC device context;

  • wnd – a wx.Window instance object;

  • caption (string) – the tab text caption;

  • bitmap (wx.Bitmap) – the bitmap displayed on the tab;

  • active (bool) – whether the tab is selected or not;

  • close_button_state (integer) – the state of the close button on the tab;

  • control (wx.Window) – a wx.Window instance inside a tab (or None).



SetSizingInfo(self, tab_ctrl_size, tab_count, minMaxTabWidth)

Sets the tab sizing information.

Parameters:
  • tab_ctrl_size (wx.Size) – the size of the tab control area;

  • tab_count (integer) – the number of tabs;

  • minMaxTabWidth (tuple) – a tuple containing the minimum and maximum tab widths to be used when the AUI_NB_TAB_FIXED_WIDTH style is active.