.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.OptionsDialog:

==========================================================================================================================================
|phoenix_title|  **OptionsDialog**
==========================================================================================================================================

A default options dialog used by the OptionsService that hosts a notebook
tab of options panels.



|

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

Inheritance diagram for class **OptionsDialog**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.OptionsDialog_inheritance.png" alt="Inheritance diagram of OptionsDialog" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="396,5,476,35"/> <area shape="rect" id="node11" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="527,5,671,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"/> <area shape="rect" id="node6" href="lib.pydocview.OptionsDialog.html" title="A default options dialog used by the OptionsService that hosts a notebook" alt="" coords="841,5,1044,35"/> <area shape="rect" id="node7" href="Dialog.html" title="A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen." alt="" coords="720,5,792,35"/> </map> 
   </p>

|


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

:class:`Dialog`

|


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

================================================================================ ================================================================================
:meth:`~lib.pydocview.OptionsDialog.__init__`                                    Initializes the options dialog with a notebook page that contains new
:meth:`~lib.pydocview.OptionsDialog.DoRefresh`                                   wxBug: On Windows XP when using a multiline notebook the default page doesn't get
:meth:`~lib.pydocview.OptionsDialog.GetDocManager`                               Returns the document manager passed to the OptionsDialog constructor.
:meth:`~lib.pydocview.OptionsDialog.OnOK`                                        Calls the OnOK method of all of the OptionDialog's embedded panels
================================================================================ ================================================================================


|


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

.. class:: OptionsDialog(Dialog)

   A default options dialog used by the OptionsService that hosts a notebook
   tab of options panels.

   .. method:: __init__(self, parent, optionsPanelClasses, docManager)

      Initializes the options dialog with a notebook page that contains new
      instances of the passed optionsPanelClasses.


   .. method:: DoRefresh(self)

      wxBug: On Windows XP when using a multiline notebook the default page doesn't get
      drawn, but it works when using a single line notebook.


   .. method:: GetDocManager(self)

      Returns the document manager passed to the OptionsDialog constructor.


   .. method:: OnOK(self, event)

      Calls the OnOK method of all of the OptionDialog's embedded panels