.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.GeneralOptionsPanel:

==========================================================================================================================================
|phoenix_title|  **GeneralOptionsPanel**
==========================================================================================================================================

A general options panel that is used in the OptionDialog to configure the
generic properties of a pydocview application, such as "show tips at startup"
and whether to use SDI or MDI for the application.



|

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

Inheritance diagram for class **GeneralOptionsPanel**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.GeneralOptionsPanel_inheritance.png" alt="Inheritance diagram of GeneralOptionsPanel" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.pydocview.GeneralOptionsPanel.html" title="A general options panel that is used in the OptionDialog to configure the" alt="" coords="645,5,901,35"/> <area shape="rect" id="node2" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="525,5,597,35"/> <area shape="rect" id="node4" 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="node5" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node7" 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:`Panel`

|


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

================================================================================ ================================================================================
:meth:`~lib.pydocview.GeneralOptionsPanel.__init__`                              Initializes the panel by adding an "Options" folder tab to the parent notebook and
:meth:`~lib.pydocview.GeneralOptionsPanel.GetIcon`                               Return icon for options panel on the Mac.
:meth:`~lib.pydocview.GeneralOptionsPanel.OnOK`                                  Updates the config based on the selections in the options panel.
================================================================================ ================================================================================


|


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

.. class:: GeneralOptionsPanel(Panel)

   A general options panel that is used in the OptionDialog to configure the
   generic properties of a pydocview application, such as "show tips at startup"
   and whether to use SDI or MDI for the application.

   .. method:: __init__(self, parent, id)

      Initializes the panel by adding an "Options" folder tab to the parent notebook and
      populating the panel with the generic properties of a pydocview application.


   .. method:: GetIcon(self)

      Return icon for options panel on the Mac. 


   .. method:: OnOK(self, optionsDialog)

      Updates the config based on the selections in the options panel.