Doc/lib/libpanel.tex

   1 \section{\module{panel} ---
   2          None}
   3 \declaremodule{standard}{panel}
   4
   5 \modulesynopsis{None}
   6
   7
   8 \strong{Please note:} The FORMS library, to which the
   9 \code{fl}\refbimodindex{fl} module described above interfaces, is a
  10 simpler and more accessible user interface library for use with GL
  11 than the \code{panel} module (besides also being by a Dutch author).
  12
  13 This module should be used instead of the built-in module
  14 \code{pnl}\refbimodindex{pnl}
  15 to interface with the
  16 \emph{Panel Library}.
  17
  18 The module is too large to document here in its entirety.
  19 One interesting function:
  20
  21 \begin{funcdesc}{defpanellist}{filename}
  22 Parses a panel description file containing S-expressions written by the
  23 \emph{Panel Editor}
  24 that accompanies the Panel Library and creates the described panels.
  25 It returns a list of panel objects.
  26 \end{funcdesc}
  27
  28 \strong{Warning:}
  29 the Python interpreter will dump core if you don't create a GL window
  30 before calling
  31 \code{panel.mkpanel()}
  32 or
  33 \code{panel.defpanellist()}.
  34
  35 \section{\module{panelparser} ---
  36          None}
  37 \declaremodule{standard}{panelparser}
  38
  39 \modulesynopsis{None}
  40
  41
  42 This module defines a self-contained parser for S-expressions as output
  43 by the Panel Editor (which is written in Scheme so it can't help writing
  44 S-expressions).
  45 The relevant function is
  46 \code{panelparser.parse_file(\var{file})}
  47 which has a file object (not a filename!) as argument and returns a list
  48 of parsed S-expressions.
  49 Each S-expression is converted into a Python list, with atoms converted
  50 to Python strings and sub-expressions (recursively) to Python lists.
  51 For more details, read the module file.
  52 % XXXXJH should be funcdesc, I think
  53
  54 \section{\module{pnl} ---
  55          None}
  56 \declaremodule{builtin}{pnl}
  57
  58 \modulesynopsis{None}
  59
  60
  61 This module provides access to the
  62 \emph{Panel Library}
  63 built by NASA Ames\index{NASA} (to get it, send e-mail to
  64 \code{panel-request@nas.nasa.gov}).
  65 All access to it should be done through the standard module
  66 \code{panel}\refstmodindex{panel},
  67 which transparantly exports most functions from
  68 \code{pnl}
  69 but redefines
  70 \code{pnl.dopanel()}.
  71
  72 \strong{Warning:}
  73 the Python interpreter will dump core if you don't create a GL window
  74 before calling
  75 \code{pnl.mkpanel()}.
  76
  77 The module is too large to document here in its entirety.