]> git.saurik.com Git - wxWidgets.git/blame - user/wxLayout/README
NL insert bug
[wxWidgets.git] / user / wxLayout / README
CommitLineData
a5f81d8c
KB
1
2README for wxLayout classes
3---------------------------
4
5All the source in this directory is copyrighted under the
a5e13868
KB
6GPL (GNU GENERAL PUBLIC LICENSE), version 2,
7by Karsten Ballueder <ballueder@usa.net>.
a5f81d8c
KB
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
23b75a2d 13There are three building blocks for rich text editing:
e471e2d0
KB
14
15wxllist :
16
17The wxLayoutList layout engine. It is a linked list of wxLayoutObjects
18which can arrange and display them on any wxDC. I am trying to keep
19this class as simple as possible, to be just the core layout
20engine. All "convenience" functions should be defined in classes built
21on top of this.
22The wxLayoutList is derived from kbList, a double-linked list with an
23interface modelled after the STL list. As wxLayoutList depends on the
24way kbList treats iterators (i.e. the iterator value after an insert()
25or erase() operation), I don't feel like rewriting it for wxList.
26
27wxlwindow :
28
29Contains a class wxLayoutWindow, derived from wxScrolledWindow which
30can directly be used as a rich-text display or editing window. The
31function responsible for keyboard handling is virtual and can be
32overloaded for different keybindings. wxLayoutWindow can sent fake
33menu-events to the application to react to the user clicking on
34objects.
35
36wxlparser:
37
38Contains several high level functions operating on
39wxLayoutList. Currently implemented is inserting of text (including
40linebreaks) and export of objects, text or html.
41Planned for the future is an html parser for importing html.
42
43
44wxLayout.cpp is a simple test program. It will export Text and HTML to
45stdout and demonstrate some of the features and bugs of wxLayoutList.
46
47There are still things to do and I'm working on them. :-)
48
49Karsten Ballueder <Ballueder@usa.ne> 29 June 1998
50