AuiTabCtrl

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

Inheritance Diagram

Inheritance diagram for: AuiTabCtrl

Known Superclasses

• aui.auibook.AuiTabContainer

Methods Summary

__init__	Default class constructor.
DoGetBestSize	Gets the size which best suits the window: for a control, it would be the
GetDefaultBorder	Returns the default border style for AuiTabCtrl.
IsDragging	Returns whether the user is dragging a tab with the mouse or not.
OnButton	Handles the EVT_AUINOTEBOOK_BUTTON event for AuiTabCtrl.
OnCaptureLost	Handles the wx.EVT_MOUSE_CAPTURE_LOST event for AuiTabCtrl.
OnEraseBackground	Handles the wx.EVT_ERASE_BACKGROUND event for AuiTabCtrl.
OnKeyDown	Handles the wx.EVT_KEY_DOWN event for AuiTabCtrl.
OnKeyDown2	Deprecated.
OnKillFocus	Handles the wx.EVT_KILL_FOCUS event for AuiTabCtrl.
OnLeaveWindow	Handles the wx.EVT_LEAVE_WINDOW event for AuiTabCtrl.
OnLeftDClick	Handles the wx.EVT_LEFT_DCLICK event for AuiTabCtrl.
OnLeftDown	Handles the wx.EVT_LEFT_DOWN event for AuiTabCtrl.
OnLeftUp	Handles the wx.EVT_LEFT_UP event for AuiTabCtrl.
OnMiddleDown	Handles the wx.EVT_MIDDLE_DOWN event for AuiTabCtrl.
OnMiddleUp	Handles the wx.EVT_MIDDLE_UP event for AuiTabCtrl.
OnMotion	Handles the wx.EVT_MOTION event for AuiTabCtrl.
OnPaint	Handles the wx.EVT_PAINT event for AuiTabCtrl.
OnRightDown	Handles the wx.EVT_RIGHT_DOWN event for AuiTabCtrl.
OnRightUp	Handles the wx.EVT_RIGHT_UP event for AuiTabCtrl.
OnSetFocus	Handles the wx.EVT_SET_FOCUS event for AuiTabCtrl.
OnSize	Handles the wx.EVT_SIZE event for AuiTabCtrl.

Class API

class AuiTabCtrl(wx.PyControl, AuiTabContainer)

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

---

__init__(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.NO_BORDER|wx.WANTS_CHARS|wx.TAB_TRAVERSAL)

Default class constructor. Used internally, do not call it in your code!

Parameters:

• parent – the AuiTabCtrl parent;
• id – an identifier for the control: a value of -1 is taken to mean a default;
• pos – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;
• size – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform;
• style – the window style.

---

DoGetBestSize()

Gets the size which best suits the window: for a control, it would be the minimal size which doesn’t truncate the control, for a panel - the same size as it would have after a call to Fit().

Note

Overridden from wx.PyControl.

---

GetDefaultBorder()

Returns the default border style for AuiTabCtrl.

---

IsDragging()

Returns whether the user is dragging a tab with the mouse or not.

---

OnButton(event)

Handles the EVT_AUINOTEBOOK_BUTTON event for AuiTabCtrl.

Parameters:event – a AuiNotebookEvent event to be processed.

---

OnCaptureLost(event)

Handles the wx.EVT_MOUSE_CAPTURE_LOST event for AuiTabCtrl.

Parameters:event – a wx.MouseCaptureLostEvent event to be processed.

---

OnEraseBackground(event)

Handles the wx.EVT_ERASE_BACKGROUND event for AuiTabCtrl.

Parameters:event – a wx.EraseEvent event to be processed.

Note

This is intentionally empty, to reduce flicker.

---

OnKeyDown(event)

Handles the wx.EVT_KEY_DOWN event for AuiTabCtrl.

Parameters:event – a wx.KeyEvent event to be processed.

---

OnKeyDown2(event)

Deprecated.

Handles the wx.EVT_KEY_DOWN event for AuiTabCtrl.

Parameters:event – a wx.KeyEvent event to be processed.

Warning

This method implementation is now deprecated. Refer to OnKeyDown for the correct one.

---

OnKillFocus(event)

Handles the wx.EVT_KILL_FOCUS event for AuiTabCtrl.

Parameters:event – a wx.FocusEvent event to be processed.

---

OnLeaveWindow(event)

Handles the wx.EVT_LEAVE_WINDOW event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnLeftDClick(event)

Handles the wx.EVT_LEFT_DCLICK event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnLeftDown(event)

Handles the wx.EVT_LEFT_DOWN event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnLeftUp(event)

Handles the wx.EVT_LEFT_UP event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnMiddleDown(event)

Handles the wx.EVT_MIDDLE_DOWN event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnMiddleUp(event)

Handles the wx.EVT_MIDDLE_UP event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnMotion(event)

Handles the wx.EVT_MOTION event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnPaint(event)

Handles the wx.EVT_PAINT event for AuiTabCtrl.

Parameters:event – a wx.PaintEvent event to be processed.

---

OnRightDown(event)

Handles the wx.EVT_RIGHT_DOWN event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnRightUp(event)

Handles the wx.EVT_RIGHT_UP event for AuiTabCtrl.

Parameters:event – a wx.MouseEvent event to be processed.

---

OnSetFocus(event)

Handles the wx.EVT_SET_FOCUS event for AuiTabCtrl.

Parameters:event – a wx.FocusEvent event to be processed.

---

OnSize(event)

Handles the wx.EVT_SIZE event for AuiTabCtrl.

Parameters:event – a wx.SizeEvent event to be processed.

AGW

• advancedsplash
• aquabutton
• artmanager
• aui
• balloontip
• buttonpanel
• cubecolourdialog
• customtreectrl
• flatmenu
• flatnotebook
• floatspin
• fmcustomizedlg
• foldpanelbar
• fourwaysplitter
• genericmessagedialog
• gradientbutton
• hyperlink
• hypertreelist
• infobar
• knobctrl
• labelbook
• multidirdialog
• peakmeter
• persist
• piectrl
• pybusyinfo
• pycollapsiblepane
• pygauge
• pyprogress
• ribbon
• rulerctrl
• shapedbutton
• shortcuteditor
• speedmeter
• supertooltip
• thumbnailctrl
• toasterbox
• ultimatelistctrl
• xlsgrid
• zoombar

Tree