.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.DocSDIFrame:

==========================================================================================================================================
|phoenix_title|  **DocSDIFrame**
==========================================================================================================================================

The DocSDIFrame host DocManager Document windows.  It offers features such as a default menubar,
toolbar, and status bar.



|

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

Inheritance diagram for class **DocSDIFrame**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.DocSDIFrame_inheritance.png" alt="Inheritance diagram of DocSDIFrame" 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,58,476,89"/> <area shape="rect" id="node15" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="527,58,671,89"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,58,345,89"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,58,197,89"/> <area shape="rect" id="node6" href="lib.docview.DocChildFrame.html" title="The wxDocChildFrame class provides a default frame for displaying" alt="" coords="851,58,1048,89"/> <area shape="rect" id="node9" href="lib.pydocview.DocSDIFrame.html" title="The DocSDIFrame host DocManager Document windows.  It offers features such as a default menubar," alt="" coords="1107,31,1315,62"/> <area shape="rect" id="node7" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="720,58,792,89"/> <area shape="rect" id="node11" href="lib.pydocview.DocFrameMixIn.html" title="Class with common code used by DocMDIParentFrame, DocTabbedParentFrame, and" alt="" coords="840,5,1059,35"/> </map> 
   </p>

|


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

:class:`lib.docview.DocChildFrame`, :class:`lib.pydocview.DocFrameMixIn`

|


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

================================================================================ ================================================================================
:meth:`~lib.pydocview.DocSDIFrame.__init__`                                      Initializes the DocSDIFrame with the default menubar, toolbar, and status bar.
:meth:`~lib.pydocview.DocSDIFrame.OnCloseWindow`                                 Called when the window is saved.  Enables services to help close the frame.
:meth:`~lib.pydocview.DocSDIFrame.OnExit`                                        Called when the application is exitting.
:meth:`~lib.pydocview.DocSDIFrame.OnMRUFile`                                     Opens the appropriate file when it is selected from the file history
:meth:`~lib.pydocview.DocSDIFrame.ProcessEvent`                                  Processes an event, searching event tables and calling zero or more
:meth:`~lib.pydocview.DocSDIFrame.ProcessUpdateUIEvent`                          Processes a UI event, searching event tables and calling zero or more
================================================================================ ================================================================================


|


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

.. class:: DocSDIFrame(lib.docview.DocChildFrame, DocFrameMixIn)

   The DocSDIFrame host DocManager Document windows.  It offers features such as a default menubar,
   toolbar, and status bar.

   .. method:: __init__(self, doc, view, parent, id, title, pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, name="DocSDIFrame")

      Initializes the DocSDIFrame with the default menubar, toolbar, and status bar.


   .. method:: OnCloseWindow(self, event)

      Called when the window is saved.  Enables services to help close the frame.


   .. method:: OnExit(self, event)

      Called when the application is exitting.


   .. method:: OnMRUFile(self, event)

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


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