blob: f2db0b03888bd4737bfbca9cde0e73ff4ae3fa7c [file] [log] [blame]
Fred Drake295da241998-08-10 19:42:37 +00001\section{\module{panel} ---
2 None}
Fred Drakeb91e9341998-07-23 17:59:49 +00003\declaremodule{standard}{panel}
4
5\modulesynopsis{None}
6
Guido van Rossum5fdeeea1994-01-02 01:22:07 +00007
Fred Drakebac354c1998-01-20 04:32:09 +00008\strong{Please note:} The FORMS library, to which the
9\code{fl}\refbimodindex{fl} module described above interfaces, is a
10simpler and more accessible user interface library for use with GL
11than the \code{panel} module (besides also being by a Dutch author).
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000012
13This module should be used instead of the built-in module
Fred Drakebac354c1998-01-20 04:32:09 +000014\code{pnl}\refbimodindex{pnl}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000015to interface with the
Fred Drakeaf8a0151998-01-14 14:51:31 +000016\emph{Panel Library}.
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000017
18The module is too large to document here in its entirety.
19One interesting function:
20
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000021\begin{funcdesc}{defpanellist}{filename}
22Parses a panel description file containing S-expressions written by the
Fred Drakeaf8a0151998-01-14 14:51:31 +000023\emph{Panel Editor}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000024that accompanies the Panel Library and creates the described panels.
25It returns a list of panel objects.
26\end{funcdesc}
27
Fred Drake0aa811c2001-10-20 04:24:09 +000028\warning{The Python interpreter will dump core if you don't create a
29GL window before calling
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000030\code{panel.mkpanel()}
31or
Fred Drake0aa811c2001-10-20 04:24:09 +000032\code{panel.defpanellist()}.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000033
Fred Drake295da241998-08-10 19:42:37 +000034\section{\module{panelparser} ---
35 None}
Fred Drakeb91e9341998-07-23 17:59:49 +000036\declaremodule{standard}{panelparser}
37
38\modulesynopsis{None}
39
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000040
41This module defines a self-contained parser for S-expressions as output
42by the Panel Editor (which is written in Scheme so it can't help writing
43S-expressions).
44The relevant function is
45\code{panelparser.parse_file(\var{file})}
46which has a file object (not a filename!) as argument and returns a list
47of parsed S-expressions.
48Each S-expression is converted into a Python list, with atoms converted
49to Python strings and sub-expressions (recursively) to Python lists.
50For more details, read the module file.
51% XXXXJH should be funcdesc, I think
52
Fred Drake295da241998-08-10 19:42:37 +000053\section{\module{pnl} ---
54 None}
Fred Drakeb91e9341998-07-23 17:59:49 +000055\declaremodule{builtin}{pnl}
56
57\modulesynopsis{None}
58
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000059
60This module provides access to the
Fred Drakeaf8a0151998-01-14 14:51:31 +000061\emph{Panel Library}
Fred Drake8ee679f2001-07-14 02:50:55 +000062built by NASA Ames\index{NASA} (to get it, send email to
Fred Drakebac354c1998-01-20 04:32:09 +000063\code{panel-request@nas.nasa.gov}).
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000064All access to it should be done through the standard module
Fred Drakebac354c1998-01-20 04:32:09 +000065\code{panel}\refstmodindex{panel},
Thomas Woutersf8316632000-07-16 19:01:10 +000066which transparently exports most functions from
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000067\code{pnl}
68but redefines
69\code{pnl.dopanel()}.
70
Fred Drake0aa811c2001-10-20 04:24:09 +000071\warning{The Python interpreter will dump core if you don't create a
72GL window before calling \code{pnl.mkpanel()}.}
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000073
74The module is too large to document here in its entirety.