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¶

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()

AuiTabContainer is a class which contains information about each tab.

Methods¶

__init__(self)¶: Default constructor.

AddButton(self, id, location, normalBitmap=NullBitmap, disabledBitmap=NullBitmap)¶

Parameters:	id (int) – location (int) – normalBitmap (wx.Bitmap) – disabledBitmap (wx.Bitmap) –

AddPage(self, page, info)¶

Parameters:	page (wx.Window) – info (wx.aui.AuiNotebookPage) –
Return type:	bool

ButtonHitTest(self, x, y, hit)¶

Parameters:	x (int) – y (int) – hit (AuiTabContainerButton) –
Return type:	bool

DoShowHide(self)¶

GetActivePage(self)¶

Return type:	int

GetArtProvider(self)¶

Return type:	wx.aui.AuiTabArt

GetFlags(self)¶

Return type:	int

GetIdxFromWindow(self, page)¶

Parameters:	page (wx.Window) –
Return type:	int

GetPage(self, idx)¶

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)¶

Parameters:	idx (int) –
Return type:	Window

InsertPage(self, page, info, idx)¶

Parameters:	page (wx.Window) – info (wx.aui.AuiNotebookPage) – idx (int) –
Return type:	bool

IsTabVisible(self, tabPage, tabOffset, dc, wnd)¶

Parameters:	tabPage (int) – tabOffset (int) – dc (wx.DC) – wnd (wx.Window) –
Return type:	bool

MakeTabVisible(self, tabPage, win)¶

Parameters:	tabPage (int) – win (wx.Window) –

MovePage(self, page, newIdx)¶

Parameters:	page (wx.Window) – newIdx (int) –
Return type:	bool

RemoveButton(self, id)¶

Parameters:	id (int) –

RemovePage(self, page)¶

Parameters:	page (wx.Window) –
Return type:	bool

SetActiveColour(self, colour)¶

Parameters:	colour (wx.Colour) –

SetActivePage(self, *args, **kw)¶

Overloaded Implementations:

SetActivePage (self, page)

Parameters:	page (wx.Window) –
Return type:	bool

SetActivePage (self, page)

Parameters:	page (int) –
Return type:	bool

SetArtProvider(self, art)¶

Parameters:	art (wx.aui.AuiTabArt) –

SetColour(self, colour)¶

Parameters:	colour (wx.Colour) –

SetFlags(self, flags)¶

Parameters:	flags (int) –

SetMeasuringFont(self, measuringFont)¶

Parameters:	measuringFont (wx.Font) –

SetNoneActive(self)¶

SetNormalFont(self, normalFont)¶

Parameters:	normalFont (wx.Font) –

SetRect(self, rect)¶

Parameters:	rect (wx.Rect) –

SetSelectedFont(self, selectedFont)¶

Parameters:	selectedFont (wx.Font) –

SetTabOffset(self, offset)¶

Parameters:	offset (int) –

TabHitTest(self, x, y, hit)¶

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

`__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`

Navigation