.. include:: headings.inc

.. currentmodule:: py.shell

.. highlight:: python



.. _py.shell.ShellFrame:

==========================================================================================================================================
|phoenix_title|  **ShellFrame**
==========================================================================================================================================

Frame containing the shell component.



|

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

Inheritance diagram for class **ShellFrame**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.shell.ShellFrame_inheritance.png" alt="Inheritance diagram of ShellFrame" 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,58,476,89"/> <area shape="rect" id="node15" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="527,58,671,89"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,58,345,89"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,58,197,89"/> <area shape="rect" id="node6" href="py.shell.ShellFrame.html" title="Frame containing the shell component." alt="" coords="1077,31,1219,62"/> <area shape="rect" id="node7" href="py.frame.Frame.html" title="Frame with standard menu items." alt="" coords="877,58,992,89"/> <area shape="rect" id="node9" href="py.frame.ShellFrameMixin.html" title="A mix-in class for frames that will have a Shell or a Crust window" alt="" coords="841,5,1028,35"/> <area shape="rect" id="node11" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="720,58,792,89"/> </map> 
   </p>

|


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

:class:`py.frame.Frame`, :class:`py.frame.ShellFrameMixin`

|


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

================================================================================ ================================================================================
:meth:`~py.shell.ShellFrame.__init__`                                            Create ShellFrame instance.
:meth:`~py.shell.ShellFrame.DoSaveSettings`                                      
:meth:`~py.shell.ShellFrame.LoadSettings`                                        
:meth:`~py.shell.ShellFrame.OnAbout`                                             Display an About window.
:meth:`~py.shell.ShellFrame.OnClose`                                             Event handler for closing.
:meth:`~py.shell.ShellFrame.OnHelp`                                              Show a help dialog.
:meth:`~py.shell.ShellFrame.SaveSettings`                                        
================================================================================ ================================================================================


|


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

.. class:: ShellFrame(frame.Frame, frame.ShellFrameMixin)

   Frame containing the shell component.

   .. method:: __init__(self, parent=None, id=-1, title='PyShell', pos=DefaultPosition, size=DefaultSize, style=DEFAULT_FRAME_STYLE, locals=None, InterpClass=None, config=None, dataDir=None, \*args, \*\*kwds)

      Create ShellFrame instance.


   .. method:: DoSaveSettings(self)


   .. method:: LoadSettings(self)


   .. method:: OnAbout(self, event)

      Display an About window.


   .. method:: OnClose(self, event)

      Event handler for closing.


   .. method:: OnHelp(self, event)

      Show a help dialog.


   .. method:: SaveSettings(self, force=False)