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

.. highlight:: python



.. _wx.lib.pydocview.DocTabbedParentFrame:

==========================================================================================================================================
|phoenix_title|  **wx.lib.pydocview.DocTabbedParentFrame**
==========================================================================================================================================

The DocTabbedParentFrame class provides a default top-level frame for
applications using the document/view framework. This class can only be
used for MDI parent frames that use a tabbed interface.

It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
classes.



|

|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>DocTabbedParentFrame</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.pydocview.DocTabbedParentFrame_inheritance.svg" alt="Inheritance diagram of DocTabbedParentFrame" 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.pydocview.DocTabbedParentFrame.html" title="The DocTabbedParentFrame class provides a default top-level frame for" alt="" coords="164,543,492,572"/> <area shape="rect" id="node2" href="wx.Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="72,466,171,495"/> <area shape="rect" id="node3" href="wx.lib.pydocview.DocFrameMixIn.html" title="Class with common code used by DocMDIParentFrame, DocTabbedParentFrame, and" alt="" coords="195,466,461,495"/> <area shape="rect" id="node4" href="wx.lib.pydocview.DocMDIParentFrameMixIn.html" title="Class with common code used by DocMDIParentFrame and DocTabbedParentFrame." alt="" coords="485,466,827,495"/> <area shape="rect" id="node5" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow  is a common base class for wx.Dialog  and wx.Frame." alt="" coords="34,389,209,418"/> <area shape="rect" id="node6" href="wx.NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="26,313,217,341"/> <area shape="rect" id="node7" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="66,236,177,265"/> <area shape="rect" id="node8" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="48,159,195,188"/> <area shape="rect" id="node9" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node10" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node11" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.Frame`, :class:`wx.lib.pydocview.DocFrameMixIn`, :class:`wx.lib.pydocview.DocMDIParentFrameMixIn`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.__init__`                          Constructor.  Note that the event table must be rebuilt for the
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.ActivateNotebookPage`              Sets the notebook to the specified panel.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.AddNotebookPage`                   Adds a document page to the notebook.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.CreateNotebook`                    Creates the notebook to use for the tabbed document interface.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.GetActiveChild`                    Returns the active notebook page, which to the framework is treated as
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.GetNotebook`                       Returns the notebook used by the tabbed document interface.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.GetNotebookPageIndex`              Returns the index of particular notebook panel.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.GetNotebookPageTitle`              
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnCloseWindow`                     Called when the frame is closed.  Remembers the frame size.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnExit`                            Called when File/Exit is chosen and closes the window.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnMRUFile`                         Opens the appropriate file when it is selected from the file history
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnNotebookMiddleClick`             Handles middle clicks for the notebook, closing the document whose tab was
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnNotebookMouseOver`               
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnNotebookPageChanged`             Activates a notebook page's view when it is selected.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnNotebookRightClick`              Handles right clicks for the notebook, enabling users to either close
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.OnSize`                            Called when the frame is resized and lays out the client window.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.ProcessEvent`                      Processes an event, searching event tables and calling zero or more
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.ProcessUpdateUIEvent`              Processes a UI event, searching event tables and calling zero or more
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.RemoveNotebookPage`                Removes a document page from the notebook.
:meth:`~wx.lib.pydocview.DocTabbedParentFrame.SetNotebookPageTitle`              
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: DocTabbedParentFrame(wx.Frame, DocFrameMixIn, DocMDIParentFrameMixIn)

   The DocTabbedParentFrame class provides a default top-level frame for
   applications using the document/view framework. This class can only be
   used for MDI parent frames that use a tabbed interface.
   
   It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
   classes.

   .. method:: __init__(self, docManager, frame, id, title, pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.DEFAULT_FRAME_STYLE, name = "DocTabbedParentFrame", embeddedWindows = 0, minSize=20)

      Constructor.  Note that the event table must be rebuilt for the
      frame since the EvtHandler is not virtual.


   .. method:: ActivateNotebookPage(self, panel)

      Sets the notebook to the specified panel.


   .. method:: AddNotebookPage(self, panel, title)

      Adds a document page to the notebook.


   .. method:: CreateNotebook(self)

      Creates the notebook to use for the tabbed document interface.


   .. method:: GetActiveChild(self)

      Returns the active notebook page, which to the framework is treated as
      a document frame.


   .. method:: GetNotebook(self)

      Returns the notebook used by the tabbed document interface.


   .. method:: GetNotebookPageIndex(self, panel)

      Returns the index of particular notebook panel.


   .. method:: GetNotebookPageTitle(self, panel)


   .. method:: OnCloseWindow(self, event)

      Called when the frame is closed.  Remembers the frame size.


   .. method:: OnExit(self, event)

      Called when File/Exit is chosen and closes the window.


   .. method:: OnMRUFile(self, event)

      Opens the appropriate file when it is selected from the file history
      menu.


   .. method:: OnNotebookMiddleClick(self, event)

      Handles middle clicks for the notebook, closing the document whose tab was
      clicked on.


   .. method:: OnNotebookMouseOver(self, event)


   .. method:: OnNotebookPageChanged(self, event)

      Activates a notebook page's view when it is selected.


   .. method:: OnNotebookRightClick(self, event)

      Handles right clicks for the notebook, enabling users to either close
      a tab or select from the available documents if the user clicks on the
      notebook's white space.


   .. method:: OnSize(self, event)

      Called when the frame is resized and lays out the client window.


   .. method:: ProcessEvent(self, event)

      Processes an event, searching event tables and calling zero or more
      suitable event handler function(s).  Note that the ProcessEvent
      method is called from the wxPython docview framework directly since
      wxPython does not have a virtual ProcessEvent function.


   .. method:: ProcessUpdateUIEvent(self, event)

      Processes a UI event, searching event tables and calling zero or more
      suitable event handler function(s).  Note that the ProcessEvent
      method is called from the wxPython docview framework directly since
      wxPython does not have a virtual ProcessEvent function.


   .. method:: RemoveNotebookPage(self, panel)

      Removes a document page from the notebook.


   .. method:: SetNotebookPageTitle(self, panel, title)