wxPython/wx/lib/editor/README.txt

   1 wxEditor component
   2 ------------------
   3
   4 The wxEditor class implements a simple text editor using wxPython.  You
   5 can create a custom editor by subclassing wxEditor.  Even though much of
   6 the editor is implemented in Python, it runs surprisingly smoothly on
   7 normal hardware with small files.
   8
   9
  10 Keys
  11 ----
  12 Keys are similar to Windows-based editors:
  13
  14 Tab:                 1 to 4 spaces (to next tab stop)
  15 Cursor movement:     Arrow keys
  16 Beginning of line:   Home
  17 End of line:         End
  18 Beginning of buffer: Control-Home
  19 End of the buffer:   Control-End
  20 Select text:         Hold down Shift while moving the cursor
  21 Copy:                Shift-Insert,   Control-C
  22 Cut:                 Shift-Delete,   Control-X
  23 Paste:               Control-Insert, Control-V
  24
  25 How to use it
  26 -------------
  27 The demo code (demo/wxEditor.py) shows how to use it as a simple text
  28 box. Use the SetText() and GetText() methods to set or get text from
  29 the component; these both return a list of strings.
  30
  31 The samples/FrogEdit directory has an example of a simple text editor
  32 application that uses the wxEditor component.
  33
  34 Subclassing
  35 -----------
  36 To add or change functionality, you can subclass this
  37 component. One example of this might be to change the key
  38 Alt key commands. In that case you would (for example) override the
  39 SetAltFuncs() method.
  40
  41 History
  42 -------
  43 The original author of this component was Dirk Holtwic. It originally
  44 had limited support for syntax highlighting, but was not a usable text
  45 editor, as it didn't implement select (with keys or mouse), or any of
  46 the usual key sequences you'd expect in an editor. Robin Dunn did some
  47 refactoring work to make it more usable. Steve Howell and Adam Feuer
  48 did a lot of refactoring, and added some functionality, including
  49 keyboard and mouse select, properly working scrollbars, and
  50 overridable keys. Adam and Steve also removed support for
  51 syntax-highlighting while refactoring the code.
  52
  53 To do
  54 -----
  55 Alt/Ctrl Arrow keys move by word
  56 Descriptive help text for keys
  57 Speed improvements
  58 Different fonts/colors
  59
  60
  61 Authors
  62 -------
  63 Steve Howell, Adam Feuer, Dirk Holtwic, Robin Dunn
  64
  65
  66 Contact
  67 -------
  68 You can find the latest code for wxEditor here:
  69 http://www.pobox.com/~adamf/software/
  70
  71 We're not actively maintaining this code, but we can answer
  72 questions about it. You can email us at:
  73
  74 Adam Feuer <adamf at pobox dot com>
  75 Steve Howell <showell at zipcon dot net>
  76
  77 29 November 2001