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

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>TabNavigatorWindow</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.agw.flatnotebook.TabNavigatorWindow_inheritance.svg" alt="Inheritance diagram of TabNavigatorWindow" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.flatnotebook.TabNavigatorWindow.html" title="This class is used to create a modal dialog that enables `Smart Tabbing`," alt="" coords="5,543,356,572"/> <area shape="rect" id="node2" href="wx.Dialog.html" title="A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen." alt="" coords="131,466,231,495"/> <area shape="rect" id="node3" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow  is a common base class for wx.Dialog  and wx.Frame." alt="" coords="93,389,269,418"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="85,313,277,341"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="125,236,236,265"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="107,159,255,188"/> <area shape="rect" id="node7" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="114,82,247,111"/> <area shape="rect" id="node8" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="65,5,163,34"/> <area shape="rect" id="node9" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="187,5,310,34"/> </map> 
   </p>
   </div>

|


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