user/wxLayout/README

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