.. include:: headings.inc

.. module:: lib.pydocview

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview:

==========================================================================================================================================
|phoenix_title|  **pydocview**
==========================================================================================================================================




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

================================================================================ ================================================================================
:func:`~lib.pydocview.getBlankIcon`                                              
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:ref:`lib.pydocview._DocFrameFileDropTarget`                                     Class used to handle drops into the document frame.
:ref:`lib.pydocview.AboutDialog`                                                 Opens an AboutDialog.  Shared by DocMDIParentFrame and DocSDIFrame.
:ref:`lib.pydocview.AboutService`                                                About Dialog Service that installs under the Help menu to show the properties of the current application.
:ref:`lib.pydocview.ChildDocTemplate`                                            A ChildDocTemplate is a DocTemplate subclass that enables the creation of ChildDocuments
:ref:`lib.pydocview.ChildDocument`                                               A ChildDocument is a document that represents a portion of a Document.  The child
:ref:`lib.pydocview.DocApp`                                                      The DocApp class serves as the base class for pydocview applications and offers
:ref:`lib.pydocview.DocFrameMixIn`                                               Class with common code used by DocMDIParentFrame, DocTabbedParentFrame, and
:ref:`lib.pydocview.DocMDIChildFrame`                                            The wxDocMDIChildFrame class provides a default frame for displaying
:ref:`lib.pydocview.DocMDIParentFrame`                                           The DocMDIParentFrame is the primary frame which the DocApp uses to host MDI child windows.  It offers
:ref:`lib.pydocview.DocMDIParentFrameMixIn`                                      Class with common code used by DocMDIParentFrame and DocTabbedParentFrame.
:ref:`lib.pydocview.DocOptionsService`                                           A service that implements an options menu item and an options dialog with
:ref:`lib.pydocview.DocSDIFrame`                                                 The DocSDIFrame host DocManager Document windows.  It offers features such as a default menubar,
:ref:`lib.pydocview.DocService`                                                  An abstract class used to add reusable services to a docview application.
:ref:`lib.pydocview.DocTabbedChildFrame`                                         The wxDocMDIChildFrame class provides a default frame for displaying
:ref:`lib.pydocview.DocTabbedParentFrame`                                        The DocTabbedParentFrame class provides a default top-level frame for
:ref:`lib.pydocview.FilePropertiesDialog`                                        Dialog that shows the properties of a file.  Invoked by the PropertiesService.
:ref:`lib.pydocview.FilePropertiesService`                                       Service that installs under the File menu to show the properties of the file associated
:ref:`lib.pydocview.GeneralOptionsPanel`                                         A general options panel that is used in the OptionDialog to configure the
:ref:`lib.pydocview.OptionsDialog`                                               A default options dialog used by the OptionsService that hosts a notebook
:ref:`lib.pydocview.WindowMenuService`                                           The WindowMenuService is a service that implements a standard Window menu that is used
================================================================================ ================================================================================


|


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

   lib.pydocview._DocFrameFileDropTarget
   lib.pydocview.AboutDialog
   lib.pydocview.AboutService
   lib.pydocview.ChildDocTemplate
   lib.pydocview.ChildDocument
   lib.pydocview.DocApp
   lib.pydocview.DocFrameMixIn
   lib.pydocview.DocMDIChildFrame
   lib.pydocview.DocMDIParentFrame
   lib.pydocview.DocMDIParentFrameMixIn
   lib.pydocview.DocOptionsService
   lib.pydocview.DocSDIFrame
   lib.pydocview.DocService
   lib.pydocview.DocTabbedChildFrame
   lib.pydocview.DocTabbedParentFrame
   lib.pydocview.FilePropertiesDialog
   lib.pydocview.FilePropertiesService
   lib.pydocview.GeneralOptionsPanel
   lib.pydocview.OptionsDialog
   lib.pydocview.WindowMenuService





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

.. function:: getBlankIcon()