utils/wxtree/docs/wxtree.tex

   1 \documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}%
   2 \newcommand{\indexit}[1]{#1\index{#1}}%
   3 \newcommand{\pipe}[0]{$\|$\ }%
   4 \definecolour{black}{0}{0}{0}%
   5 \definecolour{cyan}{0}{255}{255}%
   6 \definecolour{green}{0}{255}{0}%
   7 \definecolour{magenta}{255}{0}{255}%
   8 \definecolour{red}{255}{0}{0}%
   9 \definecolour{blue}{0}{0}{200}%
  10 \definecolour{yellow}{255}{255}{0}%
  11 \definecolour{white}{255}{255}{255}%
  12 \input psbox.tex
  13 \parskip=10pt%
  14 \title{Manual for wxTreeLayout 2.0: a tree layout library for wxWindows}
  15 \author{Julian Smart\\Anthemion Software}
  16 \date{July 1998}%
  17 \makeindex%
  18 \begin{document}%
  19 \maketitle
  20
  21 \pagestyle{fancyplain}
  22 \bibliographystyle{plain}
  23 \pagenumbering{roman}
  24 \setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}
  25 \setfooter{\thepage}{}{}{}{}{\thepage}
  26 \tableofcontents%
  27
  28 \chapter{Introduction}
  29 \pagenumbering{arabic}%
  30 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
  31 \setfooter{\thepage}{}{}{}{}{\thepage}
  32
  33 This manual describes a tree-drawing class library for wxWindows. It
  34 provides layout of simple trees with one root node, drawn left-to-right,
  35 with user-defined spacing between nodes.
  36
  37 wxTreeLayout is an abstract class that must be subclassed. The programmer
  38 defines various member functions which will access whatever data structures
  39 are appropriate for the application, and wxTreeLayout uses these when laying
  40 out the tree.
  41
  42 wxStoredTree is a class derived from wxTreeLayout that may be used directly to
  43 draw trees on a canvas. It supplies storage for the nodes, and draws
  44 to a device context.
  45
  46 \helponly{Below is the example tree generated by the program test.cc.
  47
  48 \begin{figure}
  49 $$\image{11cm;0cm}{treetst.ps}$$
  50 \caption{Example tree}\label{exampletree}
  51 \end{figure}
  52 }
  53
  54 \chapter{Implementation}
  55 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
  56 \setfooter{\thepage}{}{}{}{}{\thepage}
  57
  58 The algorithm is due to Gabriel Robins \cite{robins87}, a linear-time
  59 algorithm originally implemented in LISP for AI applications.
  60
  61 The original algorithm has been modified so that both X and Y planes
  62 are calculated simultaneously, increasing efficiency slightly. The basic
  63 code is only a page or so long.
  64
  65 \input classes.tex
  66 %
  67 \bibliography{tree}
  68
  69 \addcontentsline{toc}{chapter}{Index}
  70 \setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}%
  71 \setfooter{\thepage}{}{}{}{}{\thepage}
  72 \printindex
  73 \end{document}