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 \warning{The Python interpreter will dump core if you don't create a
  29 GL window before calling
  30 \code{panel.mkpanel()}
  31 or
  32 \code{panel.defpanellist()}.}
  33
  34 \section{\module{panelparser} ---
  35          None}
  36 \declaremodule{standard}{panelparser}
  37
  38 \modulesynopsis{None}
  39
  40
  41 This module defines a self-contained parser for S-expressions as output
  42 by the Panel Editor (which is written in Scheme so it can't help writing
  43 S-expressions).
  44 The relevant function is
  45 \code{panelparser.parse_file(\var{file})}
  46 which has a file object (not a filename!) as argument and returns a list
  47 of parsed S-expressions.
  48 Each S-expression is converted into a Python list, with atoms converted
  49 to Python strings and sub-expressions (recursively) to Python lists.
  50 For more details, read the module file.
  51 % XXXXJH should be funcdesc, I think
  52
  53 \section{\module{pnl} ---
  54          None}
  55 \declaremodule{builtin}{pnl}
  56
  57 \modulesynopsis{None}
  58
  59
  60 This module provides access to the
  61 \emph{Panel Library}
  62 built by NASA Ames\index{NASA} (to get it, send email to
  63 \code{panel-request@nas.nasa.gov}).
  64 All access to it should be done through the standard module
  65 \code{panel}\refstmodindex{panel},
  66 which transparently exports most functions from
  67 \code{pnl}
  68 but redefines
  69 \code{pnl.dopanel()}.
  70
  71 \warning{The Python interpreter will dump core if you don't create a
  72 GL window before calling \code{pnl.mkpanel()}.}
  73
  74 The module is too large to document here in its entirety.