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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.py.editor
.. highlight:: python
.. _wx.py.editor.Editor:
==========================================================================================================================================
|phoenix_title| **wx.py.editor.Editor**
==========================================================================================================================================
Editor having an EditWindow.
|
|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>Editor</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.Editor_inheritance.png" alt="Inheritance diagram of Editor" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.py.editor.Editor.html" title="wx.py.editor.Editor" alt="" coords="4,5,139,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.py.editor.Editor.__init__` Create Editor instance.
:meth:`~wx.py.editor.Editor.autoCallTipShow` Display argument spec and docstring in a popup window.
:meth:`~wx.py.editor.Editor.autoCompleteShow` Display auto-completion popup list.
:meth:`~wx.py.editor.Editor.clearAll`
:meth:`~wx.py.editor.Editor.destroy` Destroy all editor objects.
:meth:`~wx.py.editor.Editor.emptyUndoBuffer`
:meth:`~wx.py.editor.Editor.getStatus` Return (filepath, line, column) status tuple.
:meth:`~wx.py.editor.Editor.getText` Return contents of editor.
:meth:`~wx.py.editor.Editor.hasChanged` Return ``True`` if contents have changed.
:meth:`~wx.py.editor.Editor.OnChar` Keypress event handler.
:meth:`~wx.py.editor.Editor.OnKeyDown` Key down event handler.
:meth:`~wx.py.editor.Editor.setFocus` Set the input focus to the editor window.
:meth:`~wx.py.editor.Editor.setSavePoint`
:meth:`~wx.py.editor.Editor.setText` Set contents of editor.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Editor
Editor having an EditWindow.
.. method:: __init__(self, parent, id=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN | wx.SUNKEN_BORDER)
Create Editor instance.
.. method:: autoCallTipShow(self, command)
Display argument spec and docstring in a popup window.
.. method:: autoCompleteShow(self, command)
Display auto-completion popup list.
.. method:: clearAll(self)
.. method:: destroy(self)
Destroy all editor objects.
.. method:: emptyUndoBuffer(self)
.. method:: getStatus(self)
Return (filepath, line, column) status tuple.
.. method:: getText(self)
Return contents of editor.
.. method:: hasChanged(self)
Return ``True`` if contents have changed.
.. method:: OnChar(self, event)
Keypress event handler.
Only receives an event if OnKeyDown calls event.Skip() for the
corresponding event.
.. method:: OnKeyDown(self, event)
Key down event handler.
.. method:: setFocus(self)
Set the input focus to the editor window.
.. method:: setSavePoint(self)
.. method:: setText(self, text)
Set contents of editor.
|