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