wx.lib.agw.aui.auibook.TabNavigatorWindow

This class is used to create a modal dialog that enables “Smart Tabbing”, similar to what you would get by hitting Alt + Tab on Windows.

Class Hierarchy

Inheritance diagram for class TabNavigatorWindow:

Known Superclasses

wx.Dialog

Methods Summary

__init__	Default class constructor. Used internally.
CloseDialog	Closes the TabNavigatorWindow dialog, setting selection in AuiNotebook.
GetSelectedPage	Gets the page index that was selected when the dialog was closed.
OnItemSelected	Handles the wx.EVT_LISTBOX_DCLICK event for the ListBox inside TabNavigatorWindow.
OnKeyUp	Handles the wx.EVT_KEY_UP for the TabNavigatorWindow.
OnLeftDown	Handles the wx.EVT_LEFT_DOWN event for self._panel.
OnLeftUp	Handles the wx.EVT_LEFT_UP event for self._panel.
OnMotion	Handles the wx.EVT_MOTION event for self._panel.
OnNavigationKey	Handles the wx.EVT_NAVIGATION_KEY for the TabNavigatorWindow.
OnPanelEraseBg	Handles the wx.EVT_ERASE_BACKGROUND event for TabNavigatorWindow top panel.
OnPanelPaint	Handles the wx.EVT_PAINT event for TabNavigatorWindow top panel.
PopulateListControl	Populates the TabNavigatorWindow listbox with a list of tabs.

Class API

---

class TabNavigatorWindow(wx.Dialog)

This class is used to create a modal dialog that enables “Smart Tabbing”, similar to what you would get by hitting Alt + Tab on Windows.

Methods

---

__init__(self, parent, props, centreOnMouse=False)

Default class constructor. Used internally.

Parameters:

• parent – the TabNavigatorWindow parent;
• props – the TabNavigatorProps object.
• centreOnMouse – popup position of the dialog at mouse cursor. Defaults to Centre.

---

CloseDialog(self, returnId=wx.ID_OK)

Closes the TabNavigatorWindow dialog, setting selection in AuiNotebook.

---

GetSelectedPage(self)

Gets the page index that was selected when the dialog was closed.

---

OnItemSelected(self, event)

Handles the wx.EVT_LISTBOX_DCLICK event for the ListBox inside TabNavigatorWindow.

Parameters:event – a ListEvent event to be processed.

---

OnKeyUp(self, event)

Handles the wx.EVT_KEY_UP for the TabNavigatorWindow.

Parameters:event – a KeyEvent event to be processed.

---

OnLeftDown(self, event)

Handles the wx.EVT_LEFT_DOWN event for self._panel.

Parameters:event – a MouseEvent event to be processed.

---

OnLeftUp(self, event)

Handles the wx.EVT_LEFT_UP event for self._panel.

Parameters:event – a MouseEvent event to be processed.

---

OnMotion(self, event)

Handles the wx.EVT_MOTION event for self._panel.

Parameters:event – a MouseEvent event to be processed.

---

OnNavigationKey(self, event)

Handles the wx.EVT_NAVIGATION_KEY for the TabNavigatorWindow.

Parameters:event – a NavigationKeyEvent event to be processed.

---

OnPanelEraseBg(self, event)

Handles the wx.EVT_ERASE_BACKGROUND event for TabNavigatorWindow top panel.

Parameters:event – a EraseEvent event to be processed.

Note

This is intentionally empty, to reduce flicker.

---

OnPanelPaint(self, event)

Handles the wx.EVT_PAINT event for TabNavigatorWindow top panel.

Parameters:event – a PaintEvent event to be processed.

---

PopulateListControl(self, book)

Populates the TabNavigatorWindow listbox with a list of tabs.

Parameters:book – the actual AuiNotebook.