wx.aui.AuiTabContainer

wx.aui.AuiTabContainer is a class which contains information about each tab.

It also can render an entire tab control to a specified DC. It’s not a window class itself, because this code will be used by the wx.aui.AuiNotebook, where it is disadvantageous to have separate windows for each tab control in the case of “docked tabs”.

A derived class, AuiTabCtrl, is an actual wx.Window - derived window which can be used as a tab control in the normal sense.

Class Hierarchy

Inheritance diagram for class AuiTabContainer:

Methods Summary

__init__	Default constructor.
AddButton
AddPage
ButtonHitTest
DoShowHide
GetActivePage
GetArtProvider
GetFlags
GetIdxFromWindow
GetPage
GetPageCount
GetPages
GetTabOffset
GetWindowFromIdx
InsertPage
IsTabVisible
MakeTabVisible
MovePage
RemoveButton
RemovePage
SetActiveColour
SetActivePage
SetArtProvider
SetColour
SetFlags
SetMeasuringFont
SetNoneActive
SetNormalFont
SetRect
SetSelectedFont
SetTabOffset
TabHitTest

Properties Summary

ActivePage	See GetActivePage and SetActivePage
ArtProvider	See GetArtProvider and SetArtProvider
Flags	See GetFlags and SetFlags
PageCount	See GetPageCount
Pages	See GetPages
TabOffset	See GetTabOffset and SetTabOffset

Class API

class wx.aui.AuiTabContainer(object)

Possible constructors:

AuiTabContainer() -> None

AuiTabContainer is a class which contains information about each tab.

Methods

__init__(self)

Default constructor.

Return type:

None

---

AddButton(self, id: int, location: int, normalBitmap: BitmapBundle = BitmapBundle(), disabledBitmap: BitmapBundle = BitmapBundle())

Parameters:

• id (int)

• location (int)

• normalBitmap (wx.BitmapBundle)

• disabledBitmap (wx.BitmapBundle)

Return type:

None

---

AddPage(self, page: Window, info: AuiNotebookPage)

Parameters:

• page (wx.Window)

• info (wx.aui.AuiNotebookPage)

Return type:

bool

---

ButtonHitTest(self, x: int, y: int, hit: AuiTabContainerButton)

Parameters:

• x (int)

• y (int)

• hit (AuiTabContainerButton)

Return type:

bool

---

DoShowHide(self)

Return type:

None

---

GetActivePage(self)

Return type:

int

---

GetArtProvider(self)

Return type:

wx.aui.AuiTabArt

---

GetFlags(self)

Return type:

int

---

GetIdxFromWindow(self, page: Window)

Parameters:

page (wx.Window)

Return type:

int

---

GetPage(self, idx: int)

Parameters:

idx (int)

Return type:

wx.aui.AuiNotebookPage

---

GetPageCount(self)

Return type:

int

---

GetPages(self)

Return type:

AuiNotebookPageArray

---

GetTabOffset(self)

Return type:

int

---

GetWindowFromIdx(self, idx: int)

Parameters:

idx (int)

Return type:

Window

---

InsertPage(self, page: Window, info: AuiNotebookPage, idx: int)

Parameters:

• page (wx.Window)

• info (wx.aui.AuiNotebookPage)

• idx (int)

Return type:

bool

---

IsTabVisible(self, tabPage: int, tabOffset: int, dc: DC, wnd: Window)

Parameters:

• tabPage (int)

• tabOffset (int)

• dc (wx.DC)

• wnd (wx.Window)

Return type:

bool

---

MakeTabVisible(self, tabPage: int, win: Window)

Parameters:

• tabPage (int)

• win (wx.Window)

Return type:

None

---

MovePage(self, page: Window, newIdx: int)

Parameters:

• page (wx.Window)

• newIdx (int)

Return type:

bool

---

RemoveButton(self, id: int)

Parameters:

id (int)

Return type:

None

---

RemovePage(self, page: Window)

Parameters:

page (wx.Window)

Return type:

bool

---

SetActiveColour(self, colour: Colour)

Parameters:

colour (wx.Colour)

Return type:

None

---

SetActivePage(self, *args, **kw)

Overloaded Implementations:

---

SetActivePage (self, page : Window)

Parameters:

page (wx.Window)

Return type:

bool

---

SetActivePage (self, page : int)

Parameters:

page (int)

Return type:

bool

---

---

SetArtProvider(self, art: AuiTabArt)

Parameters:

art (wx.aui.AuiTabArt)

Return type:

None

---

SetColour(self, colour: Colour)

Parameters:

colour (wx.Colour)

Return type:

None

---

SetFlags(self, flags: int)

Parameters:

flags (int)

Return type:

None

---

SetMeasuringFont(self, measuringFont: Font)

Parameters:

measuringFont (wx.Font)

Return type:

None

---

SetNoneActive(self)

Return type:

None

---

SetNormalFont(self, normalFont: Font)

Parameters:

normalFont (wx.Font)

Return type:

None

---

SetRect(self, rect: Rect, wnd: Window | None = None)

Parameters:

• rect (wx.Rect)

• wnd (wx.Window)

Return type:

None

---

SetSelectedFont(self, selectedFont: Font)

Parameters:

selectedFont (wx.Font)

Return type:

None

---

SetTabOffset(self, offset: int)

Parameters:

offset (int)

Return type:

None

---

TabHitTest(self, x: int, y: int, hit: Window)

Parameters:

• x (int)

• y (int)

• hit (Window)

Return type:

bool

Properties

ActivePage

See GetActivePage and SetActivePage

---

ArtProvider

See GetArtProvider and SetArtProvider

---

Flags

See GetFlags and SetFlags

---

PageCount

See GetPageCount

---

Pages

See GetPages

---

TabOffset

See GetTabOffset and SetTabOffset