.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.DocMDIParentFrame:

==========================================================================================================================================
|phoenix_title|  **DocMDIParentFrame**
==========================================================================================================================================

The DocMDIParentFrame is the primary frame which the DocApp uses to host MDI child windows.  It offers
features such as a default menubar, toolbar, and status bar, and a mechanism to manage embedded windows
on the edges of the DocMDIParentFrame.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **DocMDIParentFrame**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.DocMDIParentFrame_inheritance.png" alt="Inheritance diagram of DocMDIParentFrame" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="396,111,476,142"/> <area shape="rect" id="node18" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="527,111,671,142"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,111,345,142"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,111,197,142"/> <area shape="rect" id="node6" href="lib.pydocview.DocMDIParentFrameMixIn.html" title="Class with common code used by DocMDIParentFrame and DocTabbedParentFrame." alt="" coords="1035,5,1331,35"/> <area shape="rect" id="node11" href="lib.pydocview.DocMDIParentFrame.html" title="The DocMDIParentFrame is the primary frame which the DocApp uses to host MDI child windows.  It offers" alt="" coords="1379,58,1637,89"/> <area shape="rect" id="node7" href="lib.docview.DocMDIParentFrame.html" title="The wxDocMDIParentFrame class provides a default top-level frame for" alt="" coords="1063,111,1303,142"/> <area shape="rect" id="node8" href="MDIParentFrame.html" title="An MDI (Multiple Document Interface) parent frame is a window which can contain MDI child frames in its client area which emulates the full desktop." alt="" coords="840,111,987,142"/> <area shape="rect" id="node10" href="lib.pydocview.DocFrameMixIn.html" title="Class with common code used by DocMDIParentFrame, DocTabbedParentFrame, and" alt="" coords="1073,58,1292,89"/> <area shape="rect" id="node17" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="720,111,792,142"/> </map> 
   </p>

|


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

:class:`lib.docview.DocMDIParentFrame`, :class:`lib.pydocview.DocFrameMixIn`, :class:`lib.pydocview.DocMDIParentFrameMixIn`

|


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

================================================================================ ================================================================================
:meth:`~lib.pydocview.DocMDIParentFrame.__init__`                                Initializes the DocMDIParentFrame with the default menubar, toolbar, and status bar.  Use the
:meth:`~lib.pydocview.DocMDIParentFrame.OnCloseWindow`                           Called when the DocMDIParentFrame is closed.  Remembers the frame size.
:meth:`~lib.pydocview.DocMDIParentFrame.OnSize`                                  Called when the DocMDIParentFrame is resized and lays out the MDI client window.
:meth:`~lib.pydocview.DocMDIParentFrame.ProcessEvent`                            Processes an event, searching event tables and calling zero or more
:meth:`~lib.pydocview.DocMDIParentFrame.ProcessUpdateUIEvent`                    Processes a UI event, searching event tables and calling zero or more
:meth:`~lib.pydocview.DocMDIParentFrame.UpdateWindowMenu`                        Updates the WindowMenu on Windows platforms.
================================================================================ ================================================================================


|


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

.. class:: DocMDIParentFrame(lib.docview.DocMDIParentFrame, DocFrameMixIn, DocMDIParentFrameMixIn)

   The DocMDIParentFrame is the primary frame which the DocApp uses to host MDI child windows.  It offers
   features such as a default menubar, toolbar, and status bar, and a mechanism to manage embedded windows
   on the edges of the DocMDIParentFrame.

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

      Initializes the DocMDIParentFrame with the default menubar, toolbar, and status bar.  Use the
      optional embeddedWindows parameter with the embedded window constants to create embedded
      windows around the edges of the DocMDIParentFrame.


   .. method:: OnCloseWindow(self, event)

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


   .. method:: OnSize(self, event)

      Called when the DocMDIParentFrame is resized and lays out the MDI 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:: UpdateWindowMenu(self)

      Updates the WindowMenu on Windows platforms.