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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
|
.. 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.editor
.. highlight:: python
.. _wx.py.editor.EditorFrame:
==========================================================================================================================================
|phoenix_title| **wx.py.editor.EditorFrame**
==========================================================================================================================================
Frame containing one editor.
|
|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>EditorFrame</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.editor.EditorFrame_inheritance.png" alt="Inheritance diagram of EditorFrame" 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.editor.EditorFrame.html" title="wx.py.editor.EditorFrame" alt="" coords="17,624,200,653"/> <area shape="rect" id="node2" href="wx.py.frame.Frame.html" title="wx.py.frame.Frame" alt="" coords="35,547,182,576"/> <area shape="rect" id="node3" href="wx.Frame.html" title="wx.Frame" alt="" coords="66,469,151,499"/> <area shape="rect" id="node4" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="31,392,186,421"/> <area shape="rect" id="node5" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,315,193,344"/> <area shape="rect" id="node6" href="wx.Window.html" title="wx.Window" alt="" coords="60,237,157,267"/> <area shape="rect" id="node7" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="44,160,173,189"/> <area shape="rect" id="node8" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="50,83,167,112"/> <area shape="rect" id="node9" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,92,35"/> <area shape="rect" id="node10" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="117,5,223,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.py.editor.EditorNotebookFrame`
|
|super_classes| Known Superclasses
==================================
:class:`wx.py.frame.Frame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.py.editor.EditorFrame.__init__` Create EditorFrame instance.
:meth:`~wx.py.editor.EditorFrame.bufferClose` Close buffer.
:meth:`~wx.py.editor.EditorFrame.bufferCreate` Create new buffer.
:meth:`~wx.py.editor.EditorFrame.bufferDestroy` Destroy the current buffer.
:meth:`~wx.py.editor.EditorFrame.bufferHasChanged` Return ``True`` if buffer has changed since last save.
:meth:`~wx.py.editor.EditorFrame.bufferNew` Create new buffer.
:meth:`~wx.py.editor.EditorFrame.bufferOpen` Open file in buffer.
:meth:`~wx.py.editor.EditorFrame.bufferSave` Save buffer to its file.
:meth:`~wx.py.editor.EditorFrame.bufferSaveAs` Save buffer to a new filename.
:meth:`~wx.py.editor.EditorFrame.bufferSuggestSave` Suggest saving changes. Return ``True`` if user selected Cancel.
:meth:`~wx.py.editor.EditorFrame.hasBuffer` Return ``True`` if there is a current buffer.
:meth:`~wx.py.editor.EditorFrame.OnAbout` Display an About window.
:meth:`~wx.py.editor.EditorFrame.OnClose` Event handler for closing.
:meth:`~wx.py.editor.EditorFrame.OnIdle` Event handler for idle time.
:meth:`~wx.py.editor.EditorFrame.setEditor`
:meth:`~wx.py.editor.EditorFrame.updateNamespace` Update the buffer namespace for autocompletion and calltips.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: EditorFrame(frame.Frame)
Frame containing one editor.
.. method:: __init__(self, parent=None, id=-1, title='PyAlaCarte', pos=wx.DefaultPosition, size=(800, 600), style=wx.DEFAULT_FRAME_STYLE | wx.NO_FULL_REPAINT_ON_RESIZE, filename=None)
Create EditorFrame 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)
Open file in buffer.
.. method:: bufferSave(self)
Save buffer to its file.
.. 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:: OnIdle(self, event)
Event handler for idle time.
.. method:: setEditor(self, editor)
.. method:: updateNamespace(self)
Update the buffer namespace for autocompletion and calltips.
|