wx.lib.agw.aui.auibook.AuiTabCtrl

This 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 AuiTabCtrl:

Known Superclasses

wx.Control, wx.lib.agw.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.
GetPointedToTab	Returns the page at which the mouse is pointing (if any).
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.
OnEnterWindow	Handles the wx.EVT_ENTER_WINDOW event fof AuiTabCtrl.
OnEraseBackground	Handles the wx.EVT_ERASE_BACKGROUND event for AuiTabCtrl.
OnKeyDown	Handles the wx.EVT_KEY_DOWN event for AuiTabCtrl.
OnKeyDown2	Handles the wx.EVT_KEY_DOWN event for AuiTabCtrl.
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.
RestartTooltipTimer	Starts a timer: when it fires, a tooltip will be shown on the notebook tab
ShowTooltip	Shows the tooltip on the tab.
StopTooltipTimer	Stops the timer keeping track of tooltips and mouse movements on the tab area.

Class API

---

class AuiTabCtrl(wx.Control, AuiTabContainer)

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

Methods

---

__init__(self, 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 AuiNotebook parent;
• id (integer) – an identifier for the control: a value of -1 is taken to mean a default;
• pos (wx.Point) – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;
• size (wx.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 (integer) – the window style.

---

DoGetBestSize(self)

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.Control.

---

GetDefaultBorder(self)

Returns the default border style for AuiTabCtrl.

---

GetPointedToTab(self)

Returns the page at which the mouse is pointing (if any).

Return type:wx.Window.

---

IsDragging(self)

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

---

OnButton(self, event)

Handles the EVT_AUINOTEBOOK_BUTTON event for AuiTabCtrl.

Parameters:event – a AuiNotebookEvent event to be processed.

---

OnCaptureLost(self, event)

Handles the wx.EVT_MOUSE_CAPTURE_LOST event for AuiTabCtrl.

Parameters:event – a MouseCaptureLostEvent event to be processed.

---

OnEnterWindow(self, event)

Handles the wx.EVT_ENTER_WINDOW event fof AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnEraseBackground(self, event)

Handles the wx.EVT_ERASE_BACKGROUND event for AuiTabCtrl.

Parameters:event – a EraseEvent event to be processed.

Note

This is intentionally empty, to reduce flicker.

---

OnKeyDown(self, event)

Handles the wx.EVT_KEY_DOWN event for AuiTabCtrl.

Parameters:event – a KeyEvent event to be processed.

---

OnKeyDown2(self, event)

Handles the wx.EVT_KEY_DOWN event for AuiTabCtrl.

Parameters:event – a KeyEvent event to be processed.

Deprecated since version 0.6: This implementation is now deprecated. Refer to OnKeyDown for the correct one.

---

OnKillFocus(self, event)

Handles the wx.EVT_KILL_FOCUS event for AuiTabCtrl.

Parameters:event – a FocusEvent event to be processed.

---

OnLeaveWindow(self, event)

Handles the wx.EVT_LEAVE_WINDOW event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnLeftDClick(self, event)

Handles the wx.EVT_LEFT_DCLICK event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnLeftDown(self, event)

Handles the wx.EVT_LEFT_DOWN event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnLeftUp(self, event)

Handles the wx.EVT_LEFT_UP event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnMiddleDown(self, event)

Handles the wx.EVT_MIDDLE_DOWN event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnMiddleUp(self, event)

Handles the wx.EVT_MIDDLE_UP event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnMotion(self, event)

Handles the wx.EVT_MOTION event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnPaint(self, event)

Handles the wx.EVT_PAINT event for AuiTabCtrl.

Parameters:event – a PaintEvent event to be processed.

---

OnRightDown(self, event)

Handles the wx.EVT_RIGHT_DOWN event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnRightUp(self, event)

Handles the wx.EVT_RIGHT_UP event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnSetFocus(self, event)

Handles the wx.EVT_SET_FOCUS event for AuiTabCtrl.

Parameters:event – a FocusEvent event to be processed.

---

OnSize(self, event)

Handles the wx.EVT_SIZE event for AuiTabCtrl.

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

---

RestartTooltipTimer(self, wnd)

Starts a timer: when it fires, a tooltip will be shown on the notebook tab the mouse is pointing at.

Parameters:wnd (wx.Window) – the window pointed by the mouse.

---

ShowTooltip(self)

Shows the tooltip on the tab.

---

StopTooltipTimer(self)

Stops the timer keeping track of tooltips and mouse movements on the tab area.