.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.py.crust
.. highlight:: python
.. _wx.py.crust.CrustFrame:
==========================================================================================================================================
|phoenix_title| **wx.py.crust.CrustFrame**
==========================================================================================================================================
Frame containing all the PyCrust components.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
CrustFrame:
|
|sub_classes| Known Subclasses
==============================
:class:`wx.py.crustslices.CrustSlicesFrame`
|
|super_classes| Known Superclasses
==================================
:class:`wx.py.frame.Frame`, :class:`wx.py.frame.ShellFrameMixin`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.py.crust.CrustFrame.__init__` Create CrustFrame instance.
:meth:`~wx.py.crust.CrustFrame.DoSaveSettings`
:meth:`~wx.py.crust.CrustFrame.LoadSettings` Called by derived classes to load settings specific to the Frame
:meth:`~wx.py.crust.CrustFrame.OnAbout` Display an About window.
:meth:`~wx.py.crust.CrustFrame.OnClose` Event handler for closing.
:meth:`~wx.py.crust.CrustFrame.OnHelp` Show a help dialog.
:meth:`~wx.py.crust.CrustFrame.SaveSettings` Called by derived classes to save Frame settings to a wx.Config object
:meth:`~wx.py.crust.CrustFrame.ToggleTools` Toggle the display of the filling and other tools
:meth:`~wx.py.crust.CrustFrame.ToolsShown`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: CrustFrame(frame.Frame, frame.ShellFrameMixin)
Frame containing all the PyCrust components.
.. method:: __init__(self, parent=None, id=-1, title='PyCrust', pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_FRAME_STYLE, rootObject=None, rootLabel=None, rootIsNamespace=True, locals=None, InterpClass=None, config=None, dataDir=None, \*args, \*\*kwds)
Create CrustFrame instance.
.. method:: DoSaveSettings(self)
.. method:: LoadSettings(self)
Called by derived classes to load settings specific to the Frame
.. 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)
Called by derived classes to save Frame settings to a wx.Config object
.. method:: ToggleTools(self)
Toggle the display of the filling and other tools
.. method:: ToolsShown(self)