Hopefully fixed library names generated by wx-config for OS/2's PM port.
[wxWidgets.git] / samples / richedit / README
CommitLineData
6c11b526
KB
1
2README for wxLayout classes
3---------------------------
4
5All the source in this directory is copyrighted under the
6GPL (GNU GENERAL PUBLIC LICENSE), version 2,
7by Karsten Ballueder <ballueder@usa.net>.
8
9
10This is still work in progress, so if you want to make any significant
11changes, please get in touch with me before.
12
f6bcfd97
BP
13
14*** THIS SOURCE IS USUALLY OUTDATED AND FOR DEMONSTRATION ONLY ***
15*** GET THE VERY LATEST VERSION OF THE WXLAYOUT CLASSES FROM ***
16*** THE SOURCE OF THE MAHOGANY MAIL/NEWS CLIENT, AVAILABLE FROM ***
17*** http://www.wxwindows.org/Mahogany/ ***
18
19
20
6c11b526
KB
21There are three building blocks for rich text editing:
22
23wxllist :
24
25The wxLayoutList layout engine. It is a linked list of wxLayoutObjects
26which can arrange and display them on any wxDC. I am trying to keep
27this class as simple as possible, to be just the core layout
28engine. All "convenience" functions should be defined in classes built
29on top of this.
30The wxLayoutList is derived from kbList, a double-linked list with an
31interface modelled after the STL list. As wxLayoutList depends on the
32way kbList treats iterators (i.e. the iterator value after an insert()
33or erase() operation), I don't feel like rewriting it for wxList.
34
35wxlwindow :
36
37Contains a class wxLayoutWindow, derived from wxScrolledWindow which
38can directly be used as a rich-text display or editing window. The
39function responsible for keyboard handling is virtual and can be
40overloaded for different keybindings. wxLayoutWindow can sent fake
41menu-events to the application to react to the user clicking on
42objects.
43
44wxlparser:
45
46Contains several high level functions operating on
47wxLayoutList. Currently implemented is inserting of text (including
48linebreaks) and export of objects, text or html.
49Planned for the future is an html parser for importing html.
50
51
52wxLayout.cpp is a simple test program. It will export Text and HTML to
53stdout and demonstrate some of the features and bugs of wxLayoutList.
54
55There are still things to do and I'm working on them. :-)
56
57Karsten Ballueder <Ballueder@usa.ne> 29 June 1998
58