File: wx.py.frame.ShellFrameMixin.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (119 lines) | stat: -rw-r--r-- 3,854 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
.. 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.frame

.. highlight:: python



.. _wx.py.frame.ShellFrameMixin:

==========================================================================================================================================
|phoenix_title|  **wx.py.frame.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| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>ShellFrameMixin</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.py.frame.ShellFrameMixin_inheritance.png" alt="Inheritance diagram of ShellFrameMixin" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.py.frame.ShellFrameMixin.html" title="wx.py.frame.ShellFrameMixin" alt="" coords="5,5,219,35"/> </map> 
   </p>
   </div>

|


|sub_classes| Known Subclasses
==============================

:class:`wx.py.crust.CrustFrame`, :class:`wx.py.shell.ShellFrame`, :class:`wx.py.sliceshell.SlicesShellFrame`

|


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

================================================================================ ================================================================================
:meth:`~wx.py.frame.ShellFrameMixin.__init__`                                    Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.py.frame.ShellFrameMixin.bufferHasChanged`                            
:meth:`~wx.py.frame.ShellFrameMixin.bufferSave`                                  
:meth:`~wx.py.frame.ShellFrameMixin.EditStartupScript`                           
:meth:`~wx.py.frame.ShellFrameMixin.LoadHistory`                                 
:meth:`~wx.py.frame.ShellFrameMixin.LoadSettings`                                
:meth:`~wx.py.frame.ShellFrameMixin.OnHelp`                                      Display a Help window.
:meth:`~wx.py.frame.ShellFrameMixin.SaveHistory`                                 
:meth:`~wx.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)

      Initialize self.  See help(type(self)) for accurate signature.


   .. 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)