.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.ChildDocTemplate:

==========================================================================================================================================
|phoenix_title|  **ChildDocTemplate**
==========================================================================================================================================

A ChildDocTemplate is a DocTemplate subclass that enables the creation of ChildDocuments
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 **ChildDocTemplate**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.ChildDocTemplate_inheritance.png" alt="Inheritance diagram of ChildDocTemplate" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" 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="node4" href="lib.docview.DocTemplate.html" title="The wxDocTemplate class is used to model the relationship between a" alt="" coords="247,5,425,35"/> <area shape="rect" id="node6" href="lib.pydocview.ChildDocTemplate.html" title="A ChildDocTemplate is a DocTemplate subclass that enables the creation of ChildDocuments" alt="" coords="475,5,709,35"/> </map> 
   </p>

|


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

:class:`lib.docview.DocTemplate`

|


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

================================================================================ ================================================================================
:meth:`~lib.pydocview.ChildDocTemplate.__init__`                                 Initializes the ChildDocTemplate.
:meth:`~lib.pydocview.ChildDocTemplate.CreateDocument`                           Called when a ChildDocument is to be created and does the minimum such that the
================================================================================ ================================================================================


|


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

.. class:: ChildDocTemplate(lib.docview.DocTemplate)

   A ChildDocTemplate is a DocTemplate subclass that enables the creation of ChildDocuments
   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:: __init__(self, manager, description, filter, dir, ext, docTypeName, viewTypeName, docType, viewType, flags=lib.docview.TEMPLATE_INVISIBLE, icon=None)

      Initializes the ChildDocTemplate.


   .. method:: CreateDocument(self, path, flags, data=None, parentDocument=None)

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