.. include:: headings.inc

.. module:: py.editor

.. currentmodule:: py.editor

.. highlight:: python



.. _py.editor:

==========================================================================================================================================
|phoenix_title|  **editor**
==========================================================================================================================================

PyAlaCarte and PyAlaMode editors.



|

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

Inheritance diagram for module **editor**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.editor_inheritance.png" alt="Inheritance diagram of editor" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node20" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="249,31,321,62"/> <area shape="rect" id="node29" href="WithImages.html" title="A mixin class to be used with other classes that use a ImageList." alt="" coords="560,190,669,221"/> <area shape="rect" id="node4" href="py.editor.EditorShellNotebook.html" title="A notebook containing an editor page and a shell page." alt="" coords="1351,230,1564,261"/> <area shape="rect" id="node5" href="Notebook.html" title="This class represents a notebook control, which manages multiple windows with associated tabs." alt="" coords="1159,183,1249,214"/> <area shape="rect" id="node9" href="py.editor.EditorNotebook.html" title="A notebook containing a page for each editor." alt="" coords="1368,177,1547,207"/> <area shape="rect" id="node11" href="py.editor.Editor.html" title="Editor having an EditWindow." alt="" coords="35,58,144,89"/> <area shape="rect" id="node12" href="py.editor.EditorFrame.html" title="Frame containing one editor." alt="" coords="1379,33,1536,63"/> <area shape="rect" id="node36" href="py.editor.EditorNotebookFrame.html" title="Frame containing one or more editors in a notebook." alt="" coords="1613,33,1840,63"/> <area shape="rect" id="node13" href="py.frame.Frame.html" title="Frame with standard menu items." alt="" coords="1147,33,1261,63"/> <area shape="rect" id="node15" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="949,33,1021,63"/> <area shape="rect" id="node16" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="719,33,863,63"/> <area shape="rect" id="node18" href="py.editor.DialogResults.html" title="DialogResults class." alt="" coords="7,5,172,35"/> <area shape="rect" id="node19" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="405,33,504,63"/> <area shape="rect" id="node42" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="575,33,655,63"/> <area shape="rect" id="node22" href="py.editwindow.EditWindow.html" title="EditWindow based on StyledTextCtrl." alt="" coords="1108,111,1300,142"/> <area shape="rect" id="node33" href="py.editor.EditWindow.html" title="EditWindow based on StyledTextCtrl." alt="" coords="1380,111,1535,142"/> <area shape="rect" id="node25" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="753,86,828,117"/> <area shape="rect" id="node40" href="BookCtrlBase.html" title="A book control is a convenient way of displaying multiple pages of information, displayed one page at a time." alt="" coords="925,183,1045,214"/> <area shape="rect" id="node35" href="py.editor.EditorShellNotebookFrame.html" title="Frame containing a notebook containing EditorShellNotebooks." alt="" coords="1888,33,2149,63"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~py.editor.directory`                                                     Dir dialog wrapper function.
:func:`~py.editor.fileDialog`                                                    File dialog wrapper function.
:func:`~py.editor.messageDialog`                                                 Message dialog wrapper function.
:func:`~py.editor.openMultiple`                                                  File dialog wrapper function.
:func:`~py.editor.openSingle`                                                    File dialog wrapper function.
:func:`~py.editor.saveSingle`                                                    File dialog wrapper function.
================================================================================ ================================================================================


|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`py.editor.DialogResults`                                                   DialogResults class.
:ref:`py.editor.Editor`                                                          Editor having an EditWindow.
:ref:`py.editor.EditorFrame`                                                     Frame containing one editor.
:ref:`py.editor.EditorNotebook`                                                  A notebook containing a page for each editor.
:ref:`py.editor.EditorNotebookFrame`                                             Frame containing one or more editors in a notebook.
:ref:`py.editor.EditorShellNotebook`                                             A notebook containing an editor page and a shell page.
:ref:`py.editor.EditorShellNotebookFrame`                                        Frame containing a notebook containing EditorShellNotebooks.
:ref:`py.editor.EditWindow`                                                      EditWindow based on StyledTextCtrl.
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   py.editor.DialogResults
   py.editor.Editor
   py.editor.EditorFrame
   py.editor.EditorNotebook
   py.editor.EditorNotebookFrame
   py.editor.EditorShellNotebook
   py.editor.EditorShellNotebookFrame
   py.editor.EditWindow





Functions
------------

.. function:: directory(parent=None, message='Choose a directory', path='', style=0, pos=DefaultPosition, size=DefaultSize)

   Dir dialog wrapper function.


.. function:: fileDialog(parent=None, title='Open', directory='', filename='', wildcard='All Files (\*.\*)|\*.\*', style=OPEN | MULTIPLE)

   File dialog wrapper function.


.. function:: messageDialog(parent=None, message='', title='Message box', style=YES_NO | CANCEL | CENTRE | ICON_QUESTION, pos=DefaultPosition)

   Message dialog wrapper function.


.. function:: openMultiple(parent=None, title='Open', directory='', filename='', wildcard='All Files (\*.\*)|\*.\*', style=OPEN | MULTIPLE)

   File dialog wrapper function.


.. function:: openSingle(parent=None, title='Open', directory='', filename='', wildcard='All Files (\*.\*)|\*.\*', style=OPEN)

   File dialog wrapper function.


.. function:: saveSingle(parent=None, title='Save', directory='', filename='', wildcard='All Files (\*.\*)|\*.\*', style=SAVE | OVERWRITE_PROMPT)

   File dialog wrapper function.