.. include:: headings.inc

.. currentmodule:: py.crustslices

.. highlight:: python



.. _py.crustslices.CrustSlicesFrame:

==========================================================================================================================================
|phoenix_title|  **CrustSlicesFrame**
==========================================================================================================================================

Frame containing all the PySlices components.



|

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

Inheritance diagram for class **CrustSlicesFrame**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.crustslices.CrustSlicesFrame_inheritance.png" alt="Inheritance diagram of CrustSlicesFrame" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="py.crust.CrustFrame.html" title="Frame containing all the PyCrust components." alt="" coords="1077,31,1227,62"/> <area shape="rect" id="node13" href="py.crustslices.CrustSlicesFrame.html" title="Frame containing all the PySlices components." alt="" coords="1275,31,1509,62"/> <area shape="rect" id="node2" href="py.frame.Frame.html" title="Frame with standard menu items." alt="" coords="877,5,992,35"/> <area shape="rect" id="node4" href="py.frame.ShellFrameMixin.html" title="A mix-in class for frames that will have a Shell or a Crust window" alt="" coords="841,58,1028,89"/> <area shape="rect" id="node6" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node9" 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="node7" 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="node17" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="527,5,671,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,5,792,35"/> </map> 
   </p>

|


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

:class:`py.crust.CrustFrame`

|


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

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


|


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

.. class:: CrustSlicesFrame(crust.CrustFrame)

   Frame containing all the PySlices components.

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

      Create CrustFrame 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:: hasBuffer(self)

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


   .. 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:: OnHideFoldingMargin(self,event)

      Change between Slices Mode and Shell Mode


   .. method:: OnIdle(self, event)

      Event handler for idle time.


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


   .. method:: updateNamespace(self)

      Update the buffer namespace for autocompletion and calltips.