.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.DocMDIChildFrame:

==========================================================================================================================================
|phoenix_title|  **DocMDIChildFrame**
==========================================================================================================================================

The wxDocMDIChildFrame class provides a default frame for displaying
documents on separate windows. This class can only be used for MDI child
frames.

The class is part of the document/view framework supported by wxWindows,
and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
classes.



|

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

Inheritance diagram for class **DocMDIChildFrame**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.DocMDIChildFrame_inheritance.png" alt="Inheritance diagram of DocMDIChildFrame" 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,5,476,35"/> <area shape="rect" id="node13" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="527,5,671,35"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> <area shape="rect" id="node8" href="lib.pydocview.DocMDIChildFrame.html" title="The wxDocMDIChildFrame class provides a default frame for displaying" alt="" coords="1025,5,1271,35"/> <area shape="rect" id="node9" href="MDIChildFrame.html" title="An MDI child frame is a frame that can only exist inside a MDIClientWindow, which is itself a child of MDIParentFrame." alt="" coords="840,5,976,35"/> <area shape="rect" id="node11" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="720,5,792,35"/> </map> 
   </p>

|


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

:class:`MDIChildFrame`

|


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

================================================================================ ================================================================================
:meth:`~lib.pydocview.DocMDIChildFrame.__init__`                                 Constructor.  Note that the event table must be rebuilt for the
:meth:`~lib.pydocview.DocMDIChildFrame.Activate`                                 Activates the current view.
:meth:`~lib.pydocview.DocMDIChildFrame.GetDocument`                              Returns the document associated with this frame.
:meth:`~lib.pydocview.DocMDIChildFrame.GetView`                                  Returns the view associated with this frame.
:meth:`~lib.pydocview.DocMDIChildFrame.OnActivate`                               Sets the currently active view to be the frame's view. You may need to
:meth:`~lib.pydocview.DocMDIChildFrame.OnCloseWindow`                            Closes and deletes the current view and document.
:meth:`~lib.pydocview.DocMDIChildFrame.OnTitleIsModified`                        Add/remove to the frame's title an indication that the document is dirty.
:meth:`~lib.pydocview.DocMDIChildFrame.ProcessEvent`                             Processes an event, searching event tables and calling zero or more
:meth:`~lib.pydocview.DocMDIChildFrame.SetDocument`                              Sets the document for this frame.
:meth:`~lib.pydocview.DocMDIChildFrame.SetView`                                  Sets the view for this frame.
================================================================================ ================================================================================


|


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

.. class:: DocMDIChildFrame(MDIChildFrame)

   The wxDocMDIChildFrame class provides a default frame for displaying
   documents on separate windows. This class can only be used for MDI child
   frames.
   
   The class is part of the document/view framework supported by wxWindows,
   and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
   classes.

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

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


   .. method:: Activate(self)

      Activates the current view.


   .. method:: GetDocument(self)

      Returns the document associated with this frame.


   .. method:: GetView(self)

      Returns the view associated with this frame.


   .. method:: OnActivate(self, event)

      Sets the currently active view to be the frame's view. You may need to
      override (but still call) this function in order to set the keyboard
      focus for your subwindow.


   .. method:: OnCloseWindow(self, event)

      Closes and deletes the current view and document.


   .. method:: OnTitleIsModified(self)

      Add/remove to the frame's title an indication that the document is dirty.
      If the document is dirty, an '*' is appended to the title


   .. method:: ProcessEvent(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:: SetDocument(self, document)

      Sets the document for this frame.


   .. method:: SetView(self, view)

      Sets the view for this frame.