.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.ChildDocument:

==========================================================================================================================================
|phoenix_title|  **ChildDocument**
==========================================================================================================================================

A ChildDocument is a document that represents a portion of a Document.  The child
document is managed by the parent document, so it will be prompted to close if its
parent is closed, etc.  Child Documents are useful when there are complicated
Views of a Document and users will need to tunnel into the View.



|

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

Inheritance diagram for class **ChildDocument**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.ChildDocument_inheritance.png" alt="Inheritance diagram of ChildDocument" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.docview.Document.html" title="The document class can be used to model an application's file-based data. It" alt="" coords="396,5,553,35"/> <area shape="rect" id="node8" href="lib.pydocview.ChildDocument.html" title="A ChildDocument is a document that represents a portion of a Document.  The child" alt="" coords="604,5,817,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"/> </map> 
   </p>

|


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

:class:`lib.docview.Document`

|


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

================================================================================ ================================================================================
:meth:`~lib.pydocview.ChildDocument.GetData`                                     Returns the data that the ChildDocument contains.
:meth:`~lib.pydocview.ChildDocument.GetParentDocument`                           Returns the parent Document of the ChildDocument.
:meth:`~lib.pydocview.ChildDocument.OnOpenDocument`                              Called when the ChildDocument is opened and does the minimum such that the
:meth:`~lib.pydocview.ChildDocument.OnSaveDocument`                              Called when the ChildDocument is saved and does the minimum such that the
:meth:`~lib.pydocview.ChildDocument.Save`                                        Called when the ChildDocument is saved and does the minimum such that the
:meth:`~lib.pydocview.ChildDocument.SaveAs`                                      Called when the ChildDocument is saved and does the minimum such that the
:meth:`~lib.pydocview.ChildDocument.SetData`                                     Sets the data that the ChildDocument contains.
:meth:`~lib.pydocview.ChildDocument.SetParentDocument`                           Sets the parent Document of the ChildDocument.
================================================================================ ================================================================================


|


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

.. class:: ChildDocument(lib.docview.Document)

   A ChildDocument is a document that represents a portion of a Document.  The child
   document is managed by the parent document, so it will be prompted to close if its
   parent is closed, etc.  Child Documents are useful when there are complicated
   Views of a Document and users will need to tunnel into the View.

   .. method:: GetData(self)

      Returns the data that the ChildDocument contains.


   .. method:: GetParentDocument(self)

      Returns the parent Document of the ChildDocument.


   .. method:: OnOpenDocument(self, filename)

      Called when the ChildDocument is opened and does the minimum such that the
      ChildDocument looks like a real Document to the framework.


   .. method:: OnSaveDocument(self, filename)

      Called when the ChildDocument is saved and does the minimum such that the
      ChildDocument looks like a real Document to the framework.


   .. method:: Save(self)

      Called when the ChildDocument is saved and does the minimum such that the
      ChildDocument looks like a real Document to the framework.


   .. method:: SaveAs(self)

      Called when the ChildDocument is saved and does the minimum such that the
      ChildDocument looks like a real Document to the framework.


   .. method:: SetData(self, data)

      Sets the data that the ChildDocument contains.


   .. method:: SetParentDocument(self, parentDocument)

      Sets the parent Document of the ChildDocument.