.. wxPython Phoenix documentation This file was generated by Phoenix's sphinx generator and associated tools, do not edit by hand. Copyright: (c) 2011-2020 by Total Control Software License: wxWindows License .. include:: headings.inc .. currentmodule:: wx.lib.agw.flatnotebook .. highlight:: python .. _wx.lib.agw.flatnotebook.TabNavigatorWindow: ========================================================================================================================================== |phoenix_title| **wx.lib.agw.flatnotebook.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| Class Hierarchy ================================= .. raw:: html
Inheritance diagram for class TabNavigatorWindow:
| |super_classes| Known Superclasses ================================== :class:`wx.Dialog` | |method_summary| Methods Summary ================================ ================================================================================ ================================================================================ :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.__init__` Default class constructor. :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.CloseDialog` Closes the :class:`TabNavigatorWindow` dialog, setting the new selection in :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.OnItemSelected` Handles the ``wx.EVT_LISTBOX_DCLICK`` for the :class:`TabNavigatorWindow`. :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.OnKeyUp` Handles the ``wx.EVT_KEY_UP`` for the :class:`TabNavigatorWindow`. :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.OnNavigationKey` Handles the ``wx.EVT_NAVIGATION_KEY`` for the :class:`TabNavigatorWindow`. :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.OnPanelEraseBg` Handles the ``wx.EVT_ERASE_BACKGROUND`` for the :class:`TabNavigatorWindow` top panel. :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.OnPanelPaint` Handles the ``wx.EVT_PAINT`` for the :class:`TabNavigatorWindow` top panel. :meth:`~wx.lib.agw.flatnotebook.TabNavigatorWindow.PopulateListControl` Populates the :class:`TabNavigatorWindow` listbox with a list of tabs. ================================================================================ ================================================================================ | |api| 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. .. method:: __init__(self, parent=None, icon=None) Default class constructor. Used internally. :param `parent`: the :class:`TabNavigatorWindow` parent window; :param `icon`: a valid :class:`wx.Bitmap` object representing the icon to be displayed in the :class:`TabNavigatorWindow`. .. method:: CloseDialog(self) Closes the :class:`TabNavigatorWindow` dialog, setting the new selection in :class:`FlatNotebook`. .. method:: OnItemSelected(self, event) Handles the ``wx.EVT_LISTBOX_DCLICK`` for the :class:`TabNavigatorWindow`. :param `event`: a :class:`ListEvent` event to be processed. .. method:: OnKeyUp(self, event) Handles the ``wx.EVT_KEY_UP`` for the :class:`TabNavigatorWindow`. :param `event`: a :class:`KeyEvent` event to be processed. .. method:: OnNavigationKey(self, event) Handles the ``wx.EVT_NAVIGATION_KEY`` for the :class:`TabNavigatorWindow`. :param `event`: a :class:`NavigationKeyEvent` event to be processed. .. method:: OnPanelEraseBg(self, event) Handles the ``wx.EVT_ERASE_BACKGROUND`` for the :class:`TabNavigatorWindow` top panel. :param `event`: a :class:`EraseEvent` event to be processed. .. note:: This method is intentionally empty to reduce flicker. .. method:: OnPanelPaint(self, event) Handles the ``wx.EVT_PAINT`` for the :class:`TabNavigatorWindow` top panel. :param `event`: a :class:`PaintEvent` event to be processed. .. method:: PopulateListControl(self, book) Populates the :class:`TabNavigatorWindow` listbox with a list of tabs. :param `book`: an instance of :class:`FlatNotebook` containing the tabs to be displayed in the listbox.