.. include:: headings.inc

.. currentmodule:: py.sliceshell

.. highlight:: python



.. _py.sliceshell.SlicesShellFrame:

==========================================================================================================================================
|phoenix_title|  **SlicesShellFrame**
==========================================================================================================================================

Frame containing the sliceshell component.



|

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

Inheritance diagram for class **SlicesShellFrame**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.sliceshell.SlicesShellFrame_inheritance.png" alt="Inheritance diagram of SlicesShellFrame" 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.frame.Frame.html" title="Frame with standard menu items." alt="" coords="877,58,992,89"/> <area shape="rect" id="node12" href="py.sliceshell.SlicesShellFrame.html" title="Frame containing the sliceshell component." alt="" coords="1077,31,1296,62"/> <area shape="rect" id="node7" 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"/> <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"/> </map> 
   </p>

|


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

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

|


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

================================================================================ ================================================================================
:meth:`~py.sliceshell.SlicesShellFrame.__init__`                                 Create SlicesShellFrame instance.
:meth:`~py.sliceshell.SlicesShellFrame.bufferClose`                              Close buffer.
:meth:`~py.sliceshell.SlicesShellFrame.bufferCreate`                             Create new buffer.
:meth:`~py.sliceshell.SlicesShellFrame.bufferDestroy`                            Destroy the current buffer.
:meth:`~py.sliceshell.SlicesShellFrame.bufferHasChanged`                         Return ``True`` if buffer has changed since last save.
:meth:`~py.sliceshell.SlicesShellFrame.bufferNew`                                Create new buffer.
:meth:`~py.sliceshell.SlicesShellFrame.bufferOpen`                               Open file in buffer.
:meth:`~py.sliceshell.SlicesShellFrame.bufferSave`                               Save buffer to its file.
:meth:`~py.sliceshell.SlicesShellFrame.bufferSaveACopy`                          Save buffer to a new filename.
:meth:`~py.sliceshell.SlicesShellFrame.bufferSaveAs`                             Save buffer to a new filename.
:meth:`~py.sliceshell.SlicesShellFrame.bufferSuggestSave`                        Suggest saving changes.  Return ``True`` if user selected Cancel.
:meth:`~py.sliceshell.SlicesShellFrame.DoSaveSettings`                           
:meth:`~py.sliceshell.SlicesShellFrame.hasBuffer`                                Return ``True`` if there is a current buffer.
:meth:`~py.sliceshell.SlicesShellFrame.LoadSettings`                             
:meth:`~py.sliceshell.SlicesShellFrame.OnAbout`                                  Display an About window.
:meth:`~py.sliceshell.SlicesShellFrame.OnClose`                                  Event handler for closing.
:meth:`~py.sliceshell.SlicesShellFrame.OnEnableShellMode`                        Change between Slices Mode and Shell Mode
:meth:`~py.sliceshell.SlicesShellFrame.OnHelp`                                   Show a help dialog.
:meth:`~py.sliceshell.SlicesShellFrame.OnHideFoldingMargin`                      Change between Slices Mode and Shell Mode
:meth:`~py.sliceshell.SlicesShellFrame.OnIdle`                                   Event handler for idle time.
:meth:`~py.sliceshell.SlicesShellFrame.SaveSettings`                             
:meth:`~py.sliceshell.SlicesShellFrame.simpleSave`                               
:meth:`~py.sliceshell.SlicesShellFrame.updateNamespace`                          Update the buffer namespace for autocompletion and calltips.
================================================================================ ================================================================================


|


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

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

   Frame containing the sliceshell component.

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

      Create SlicesShellFrame instance.


   .. method:: bufferClose(self)

      Close buffer.


   .. method:: bufferCreate(self, filename=None)

      Create new buffer.


   .. method:: bufferDestroy(self)

      Destroy the current buffer.


   .. method:: bufferHasChanged(self)

      Return ``True`` if buffer has changed since last save.


   .. method:: bufferNew(self)

      Create new buffer.


   .. method:: bufferOpen(self,file=None)

      Open file in buffer.


   .. method:: bufferSave(self)

      Save buffer to its file.


   .. method:: bufferSaveACopy(self)

      Save buffer to a new filename.


   .. method:: bufferSaveAs(self)

      Save buffer to a new filename.


   .. method:: bufferSuggestSave(self)

      Suggest saving changes.  Return ``True`` if user selected Cancel.


   .. method:: DoSaveSettings(self)


   .. method:: hasBuffer(self)

      Return ``True`` if there is a current buffer.


   .. method:: LoadSettings(self)


   .. method:: OnAbout(self, event)

      Display an About window.


   .. method:: OnClose(self, event)

      Event handler for closing.


   .. method:: OnEnableShellMode(self,event)

      Change between Slices Mode and Shell Mode


   .. method:: OnHelp(self, event)

      Show a help dialog.


   .. method:: OnHideFoldingMargin(self,event)

      Change between Slices Mode and Shell Mode


   .. method:: OnIdle(self, event)

      Event handler for idle time.


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


   .. method:: simpleSave(self,confirmed=False)


   .. method:: updateNamespace(self)

      Update the buffer namespace for autocompletion and calltips.