.. include:: headings.inc

.. currentmodule:: py.editwindow

.. highlight:: python



.. _py.editwindow.EditWindow:

==========================================================================================================================================
|phoenix_title|  **EditWindow**
==========================================================================================================================================

EditWindow based on StyledTextCtrl.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **EditWindow**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.editwindow.EditWindow_inheritance.png" alt="Inheritance diagram of EditWindow" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="595,111,669,142"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="465,111,545,142"/> <area shape="rect" id="node4" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="309,111,408,142"/> <area shape="rect" id="node11" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="153,111,225,142"/> <area shape="rect" id="node13" href="py.editwindow.EditWindow.html" title="EditWindow based on StyledTextCtrl." alt="" coords="913,86,1105,117"/> </map> 
   </p>

|


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

:class:`py.crust.Display`, :class:`py.editor.EditWindow`, :class:`py.filling.FillingText`, :class:`py.shell.Shell`, :class:`py.sliceshell.SlicesShell`

|


|super_classes| Known Superclasses
==================================

:class:`stc.StyledTextCtrl`

|


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

================================================================================ ================================================================================
:meth:`~py.editwindow.EditWindow.__init__`                                       Create EditWindow instance.
:meth:`~py.editwindow.EditWindow.CanCopy`                                        Return ``True`` if text is selected and can be copied.
:meth:`~py.editwindow.EditWindow.CanCut`                                         Return ``True`` if text is selected and can be cut.
:meth:`~py.editwindow.EditWindow.CanEdit`                                        Return ``True`` if editing should succeed.
:meth:`~py.editwindow.EditWindow.CanPaste`                                       Return ``True`` if pasting should succeed.
:meth:`~py.editwindow.EditWindow.DoFindNext`                                     
:meth:`~py.editwindow.EditWindow.GetLastPosition`                                
:meth:`~py.editwindow.EditWindow.GetRange`                                       
:meth:`~py.editwindow.EditWindow.GetSelection`                                   
:meth:`~py.editwindow.EditWindow.OnUpdateUI`                                     Check for matching braces.
:meth:`~py.editwindow.EditWindow.setDisplayLineNumbers`                          
:meth:`~py.editwindow.EditWindow.setStyles`                                      Configure font size, typeface and color for lexer.
:meth:`~py.editwindow.EditWindow.ShowPosition`                                   
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: EditWindow(stc.StyledTextCtrl)

   EditWindow based on StyledTextCtrl.

   .. method:: __init__(self, parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=CLIP_CHILDREN | 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)


   .. method:: GetRange(self, start, end)


   .. method:: GetSelection(self)


   .. method:: OnUpdateUI(self, event)

      Check for matching braces.


   .. method:: setDisplayLineNumbers(self, state)


   .. method:: setStyles(self, faces)

      Configure font size, typeface and color for lexer.


   .. method:: ShowPosition(self, pos)