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

.. highlight:: python



.. _wx.lib.docview.DocChildFrame:

==========================================================================================================================================
|phoenix_title|  **wx.lib.docview.DocChildFrame**
==========================================================================================================================================

The :class:`DocChildFrame` class provides a default frame for displaying
documents on separate windows. This class can only be used for SDI (not
MDI) child frames.

The class is part of the document/view framework and cooperates with
the :class:`View`, :class:`Document`, :class:`DocManager` and
:class:`DocTemplate` 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>DocChildFrame</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.docview.DocChildFrame_inheritance.svg" alt="Inheritance diagram of DocChildFrame" 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.docview.DocChildFrame.html" title="The DocChildFrame class provides a default frame for displaying" alt="" coords="5,543,254,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="80,466,179,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="42,389,218,418"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="34,313,226,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="74,236,185,265"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="56,159,204,188"/> <area shape="rect" id="node7" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="63,82,196,111"/> <area shape="rect" id="node8" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="14,5,112,34"/> <area shape="rect" id="node9" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="136,5,259,34"/> </map> 
   </p>
   </div>

|


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

:class:`wx.Frame`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.docview.DocChildFrame.__init__`                                   Constructor.
:meth:`~wx.lib.docview.DocChildFrame.GetDocument`                                Returns the document associated with this frame.
:meth:`~wx.lib.docview.DocChildFrame.GetView`                                    Returns the view associated with this frame.
:meth:`~wx.lib.docview.DocChildFrame.OnActivate`                                 Activates the current view.
:meth:`~wx.lib.docview.DocChildFrame.OnCloseWindow`                              Closes and deletes the current view and document.
:meth:`~wx.lib.docview.DocChildFrame.ProcessEvent`                               Processes an event, searching event tables and calling zero or more
:meth:`~wx.lib.docview.DocChildFrame.ProcessUpdateUIEvent`                       Processes a UI event, searching event tables and calling zero or more
:meth:`~wx.lib.docview.DocChildFrame.SetDocument`                                Sets the document for this frame.
:meth:`~wx.lib.docview.DocChildFrame.SetView`                                    Sets the view for this frame.
================================================================================ ================================================================================


|


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


.. class:: DocChildFrame(wx.Frame)

   The :class:`DocChildFrame` class provides a default frame for displaying
   documents on separate windows. This class can only be used for SDI (not
   MDI) child frames.
   
   The class is part of the document/view framework and cooperates with
   the :class:`View`, :class:`Document`, :class:`DocManager` and
   :class:`DocTemplate` classes.

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

      Constructor.


   .. method:: GetDocument(self)

      Returns the document associated with this frame.


   .. method:: GetView(self)

      Returns the view associated with this frame.


   .. method:: OnActivate(self, event)

      Activates the current view.


   .. method:: OnCloseWindow(self, event)

      Closes and deletes the current view and document.


   .. method:: ProcessEvent(self, event)

      Processes an event, searching event tables and calling zero or more
      suitable event handler function(s).


   .. method:: ProcessUpdateUIEvent(self, event)

      Processes a UI event, searching event tables and calling zero or more
      suitable event handler function(s).


   .. method:: SetDocument(self, document)

      Sets the document for this frame.


   .. method:: SetView(self, view)

      Sets the view for this frame.