AuiTabCtrl

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

Inheritance Diagram

Inheritance diagram for class AuiTabCtrl

Known Superclasses

PyControl, 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.
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 EVT_MOUSE_CAPTURE_LOST event for AuiTabCtrl.
OnEraseBackground	Handles the EVT_ERASE_BACKGROUND event for AuiTabCtrl.
OnKeyDown	Handles the EVT_KEY_DOWN event for AuiTabCtrl.
OnKeyDown2	Handles the EVT_KEY_DOWN event for AuiTabCtrl.
OnKillFocus	Handles the EVT_KILL_FOCUS event for AuiTabCtrl.
OnLeaveWindow	Handles the EVT_LEAVE_WINDOW event for AuiTabCtrl.
OnLeftDClick	Handles the EVT_LEFT_DCLICK event for AuiTabCtrl.
OnLeftDown	Handles the EVT_LEFT_DOWN event for AuiTabCtrl.
OnLeftUp	Handles the EVT_LEFT_UP event for AuiTabCtrl.
OnMiddleDown	Handles the EVT_MIDDLE_DOWN event for AuiTabCtrl.
OnMiddleUp	Handles the EVT_MIDDLE_UP event for AuiTabCtrl.
OnMotion	Handles the EVT_MOTION event for AuiTabCtrl.
OnPaint	Handles the EVT_PAINT event for AuiTabCtrl.
OnRightDown	Handles the EVT_RIGHT_DOWN event for AuiTabCtrl.
OnRightUp	Handles the EVT_RIGHT_UP event for AuiTabCtrl.
OnSetFocus	Handles the EVT_SET_FOCUS event for AuiTabCtrl.
OnSize	Handles the EVT_SIZE event for AuiTabCtrl.

Class API

---

class AuiTabCtrl(PyControl, AuiTabContainer)

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

Methods

---

__init__(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=NO_BORDER|WANTS_CHARS|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 (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 (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 PyControl.

---

GetDefaultBorder(self)

Returns the default border style for AuiTabCtrl.

---

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 EVT_MOUSE_CAPTURE_LOST event for AuiTabCtrl.

Parameters:event – a MouseCaptureLostEvent event to be processed.

---

OnEraseBackground(self, event)

Handles the 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 EVT_KEY_DOWN event for AuiTabCtrl.

Parameters:event – a KeyEvent event to be processed.

---

OnKeyDown2(self, event)

Handles the 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 EVT_KILL_FOCUS event for AuiTabCtrl.

Parameters:event – a FocusEvent event to be processed.

---

OnLeaveWindow(self, event)

Handles the EVT_LEAVE_WINDOW event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnLeftDClick(self, event)

Handles the EVT_LEFT_DCLICK event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnLeftDown(self, event)

Handles the EVT_LEFT_DOWN event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnLeftUp(self, event)

Handles the EVT_LEFT_UP event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnMiddleDown(self, event)

Handles the EVT_MIDDLE_DOWN event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnMiddleUp(self, event)

Handles the EVT_MIDDLE_UP event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnMotion(self, event)

Handles the EVT_MOTION event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnPaint(self, event)

Handles the EVT_PAINT event for AuiTabCtrl.

Parameters:event – a PaintEvent event to be processed.

---

OnRightDown(self, event)

Handles the EVT_RIGHT_DOWN event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnRightUp(self, event)

Handles the EVT_RIGHT_UP event for AuiTabCtrl.

Parameters:event – a MouseEvent event to be processed.

---

OnSetFocus(self, event)

Handles the EVT_SET_FOCUS event for AuiTabCtrl.

Parameters:event – a FocusEvent event to be processed.

---

OnSize(self, event)

Handles the EVT_SIZE event for AuiTabCtrl.

Parameters:event – a SizeEvent event to be processed.