.. 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.editwindow
.. highlight:: python
.. _wx.py.editwindow.EditWindow:
==========================================================================================================================================
|phoenix_title| **wx.py.editwindow.EditWindow**
==========================================================================================================================================
EditWindow based on StyledTextCtrl.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
EditWindow:
|
|sub_classes| Known Subclasses
==============================
:class:`wx.py.crust.Display`, :class:`wx.py.editor.EditWindow`, :class:`wx.py.filling.FillingText`, :class:`wx.py.shell.Shell`, :class:`wx.py.sliceshell.SlicesShell`
|
|super_classes| Known Superclasses
==================================
:class:`wx.stc.StyledTextCtrl`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.py.editwindow.EditWindow.__init__` Create EditWindow instance.
:meth:`~wx.py.editwindow.EditWindow.CanCopy` Return ``True`` if text is selected and can be copied.
:meth:`~wx.py.editwindow.EditWindow.CanCut` Return ``True`` if text is selected and can be cut.
:meth:`~wx.py.editwindow.EditWindow.CanEdit` Return ``True`` if editing should succeed.
:meth:`~wx.py.editwindow.EditWindow.CanPaste` Return ``True`` if pasting should succeed.
:meth:`~wx.py.editwindow.EditWindow.DoFindNext`
:meth:`~wx.py.editwindow.EditWindow.GetLastPosition` GetLastPosition() -> int
:meth:`~wx.py.editwindow.EditWindow.GetRange` GetRange(from_ : int, to_ : int) -> str
:meth:`~wx.py.editwindow.EditWindow.GetSelection` GetSelection() -> Tuple[int, int]
:meth:`~wx.py.editwindow.EditWindow.OnUpdateUI` Check for matching braces.
:meth:`~wx.py.editwindow.EditWindow.setDisplayLineNumbers`
:meth:`~wx.py.editwindow.EditWindow.SetSelection` Selects the text starting at the first position up to
:meth:`~wx.py.editwindow.EditWindow.setStyles` Configure font size, typeface and color for lexer.
:meth:`~wx.py.editwindow.EditWindow.ShowPosition` ShowPosition(pos : int) -> None
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: EditWindow(stc.StyledTextCtrl)
EditWindow based on StyledTextCtrl.
.. method:: __init__(self, parent, id=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.CLIP_CHILDREN | wx.SUNKEN_BORDER)
Create EditWindow instance.
.. method:: CanCopy(self)
Return ``True`` if text is selected and can be copied.
.. method:: CanCut(self)
Return ``True`` if text is selected and can be cut.
.. method:: CanEdit(self)
Return ``True`` if editing should succeed.
.. method:: CanPaste(self)
Return ``True`` if pasting should succeed.
.. method:: DoFindNext(self, findData, findDlg=None)
.. method:: GetLastPosition(self)
GetLastPosition() -> int
Returns the zero based index of the last position in the text control,
which is equal to the number of characters in the control.
.. method:: GetRange(self, start, end)
GetRange(from_ : int, to_ : int) -> str
Returns the string containing the text starting in the positions from
and up to to in the control.
.. method:: GetSelection(self)
GetSelection() -> Tuple[int, int]
Gets the current selection span.
.. method:: OnUpdateUI(self, event)
Check for matching braces.
.. method:: setDisplayLineNumbers(self, state)
.. method:: SetSelection(self, from_, to_)
Selects the text starting at the first position up to
(but not including) the character at the last position.
.. method:: setStyles(self, faces)
Configure font size, typeface and color for lexer.
.. method:: ShowPosition(self, pos)
ShowPosition(pos : int) -> None
Makes the line containing the given position visible.