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

Inheritance diagram for class
EditorFrame:
|
|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.