.. include:: headings.inc

.. currentmodule:: py.frame

.. highlight:: python



.. _py.frame.ShellFrameMixin:

==========================================================================================================================================
|phoenix_title|  **ShellFrameMixin**
==========================================================================================================================================

A mix-in class for frames that will have a Shell or a Crust window
and that want to add history, startupScript and other common
functionality.



|

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

Inheritance diagram for class **ShellFrameMixin**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.frame.ShellFrameMixin_inheritance.png" alt="Inheritance diagram of ShellFrameMixin" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="py.frame.ShellFrameMixin.html" title="A mix-in class for frames that will have a Shell or a Crust window" alt="" coords="7,5,193,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~py.frame.ShellFrameMixin.__init__`                                       
:meth:`~py.frame.ShellFrameMixin.bufferHasChanged`                               
:meth:`~py.frame.ShellFrameMixin.bufferSave`                                     
:meth:`~py.frame.ShellFrameMixin.EditStartupScript`                              
:meth:`~py.frame.ShellFrameMixin.LoadHistory`                                    
:meth:`~py.frame.ShellFrameMixin.LoadSettings`                                   
:meth:`~py.frame.ShellFrameMixin.OnHelp`                                         Display a Help window.
:meth:`~py.frame.ShellFrameMixin.SaveHistory`                                    
:meth:`~py.frame.ShellFrameMixin.SaveSettings`                                   
================================================================================ ================================================================================


|


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

.. class:: ShellFrameMixin

   A mix-in class for frames that will have a Shell or a Crust window
   and that want to add history, startupScript and other common
   functionality.

   .. method:: __init__(self, config, dataDir)


   .. method:: bufferHasChanged(self)


   .. method:: bufferSave(self)


   .. method:: EditStartupScript(self)


   .. method:: LoadHistory(self)


   .. method:: LoadSettings(self)


   .. method:: OnHelp(self, event)

      Display a Help window.


   .. method:: SaveHistory(self)


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