.. include:: headings.inc

.. module:: lib.docview

.. currentmodule:: lib.docview

.. highlight:: python



.. _lib.docview:

==========================================================================================================================================
|phoenix_title|  **docview**
==========================================================================================================================================





|

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

Inheritance diagram for module **docview**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.docview_inheritance.png" alt="Inheritance diagram of docview" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.docview.DocChildFrame.html" title="The wxDocChildFrame class provides a default frame for displaying" alt="" coords="1076,85,1273,115"/> <area shape="rect" id="node2" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="949,165,1021,195"/> <area shape="rect" id="node11" href="lib.docview.DocParentFrame.html" title="The wxDocParentFrame class provides a default top-level frame for" alt="" coords="1069,138,1280,169"/> <area shape="rect" id="node24" href="MDIParentFrame.html" title="An MDI (Multiple Document Interface) parent frame is a window which can contain MDI child frames in its client area which emulates the full desktop." alt="" coords="1101,191,1248,222"/> <area shape="rect" id="node33" 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="1107,245,1243,275"/> <area shape="rect" id="node9" href="lib.docview.DocPrintout.html" title="DocPrintout is a default Printout that prints the first page of a document" alt="" coords="532,5,703,35"/> <area shape="rect" id="node5" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,165,197,195"/> <area shape="rect" id="node7" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="313,111,412,142"/> <area shape="rect" id="node13" href="lib.docview.CommandProcessor.html" title="wxCommandProcessor is a class that maintains a history of wxCommands, with" alt="" coords="245,165,480,195"/> <area shape="rect" id="node21" href="lib.docview.Command.html" title="wxCommand is a base class for modelling an application command, which is" alt="" coords="284,218,441,249"/> <area shape="rect" id="node26" href="lib.docview.DocTemplate.html" title="The wxDocTemplate class is used to model the relationship between a" alt="" coords="273,271,452,302"/> <area shape="rect" id="node15" href="lib.docview.Document.html" title="The document class can be used to model an application's file-based data. It" alt="" coords="539,58,696,89"/> <area shape="rect" id="node17" href="lib.docview.DocManager.html" title="The wxDocManager class is part of the document/view framework supported by" alt="" coords="528,111,707,142"/> <area shape="rect" id="node19" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="577,165,657,195"/> <area shape="rect" id="node30" href="lib.docview.View.html" title="The view class can be used to model the viewing and editing component of" alt="" coords="557,218,677,249"/> <area shape="rect" id="node35" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="756,165,900,195"/> <area shape="rect" id="node23" href="lib.docview.DocMDIParentFrame.html" title="The wxDocMDIParentFrame class provides a default top-level frame for" alt="" coords="1328,191,1568,222"/> <area shape="rect" id="node32" href="lib.docview.DocMDIChildFrame.html" title="The wxDocMDIChildFrame class provides a default frame for displaying" alt="" coords="1333,245,1563,275"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.docview.FileExists`                                                  Returns ``True`` if the path exists.
:func:`~lib.docview.FileNameFromPath`                                            Returns the filename for a full path.
:func:`~lib.docview.FindExtension`                                               Returns the extension of a filename for a full path.
:func:`~lib.docview.PathOnly`                                                    Returns the path of a full path without the filename.
================================================================================ ================================================================================


|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.docview.Command`                                                       wxCommand is a base class for modelling an application command, which is
:ref:`lib.docview.CommandProcessor`                                              wxCommandProcessor is a class that maintains a history of wxCommands, with
:ref:`lib.docview.DocChildFrame`                                                 The wxDocChildFrame class provides a default frame for displaying
:ref:`lib.docview.DocManager`                                                    The wxDocManager class is part of the document/view framework supported by
:ref:`lib.docview.DocMDIChildFrame`                                              The wxDocMDIChildFrame class provides a default frame for displaying
:ref:`lib.docview.DocMDIParentFrame`                                             The wxDocMDIParentFrame class provides a default top-level frame for
:ref:`lib.docview.DocParentFrame`                                                The wxDocParentFrame class provides a default top-level frame for
:ref:`lib.docview.DocPrintout`                                                   DocPrintout is a default Printout that prints the first page of a document
:ref:`lib.docview.DocTemplate`                                                   The wxDocTemplate class is used to model the relationship between a
:ref:`lib.docview.Document`                                                      The document class can be used to model an application's file-based data. It
:ref:`lib.docview.View`                                                          The view class can be used to model the viewing and editing component of
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.docview.Command
   lib.docview.CommandProcessor
   lib.docview.DocChildFrame
   lib.docview.DocManager
   lib.docview.DocMDIChildFrame
   lib.docview.DocMDIParentFrame
   lib.docview.DocParentFrame
   lib.docview.DocPrintout
   lib.docview.DocTemplate
   lib.docview.Document
   lib.docview.View





Functions
------------

.. function:: FileExists(path)

   Returns ``True`` if the path exists.


.. function:: FileNameFromPath(path)

   Returns the filename for a full path.


.. function:: FindExtension(path)

   Returns the extension of a filename for a full path.


.. function:: PathOnly(path)

   Returns the path of a full path without the filename.