blob: d91ec8f0468cda067a7d2e7fddb0cb1708b5521a [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
28\strong{Warning:}
29the Python interpreter will dump core if you don't create a GL window
30before calling
31\code{panel.mkpanel()}
32or
33\code{panel.defpanellist()}.
34
Fred Drake295da241998-08-10 19:42:37 +000035\section{\module{panelparser} ---
36 None}
Fred Drakeb91e9341998-07-23 17:59:49 +000037\declaremodule{standard}{panelparser}
38
39\modulesynopsis{None}
40
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000041
42This module defines a self-contained parser for S-expressions as output
43by the Panel Editor (which is written in Scheme so it can't help writing
44S-expressions).
45The relevant function is
46\code{panelparser.parse_file(\var{file})}
47which has a file object (not a filename!) as argument and returns a list
48of parsed S-expressions.
49Each S-expression is converted into a Python list, with atoms converted
50to Python strings and sub-expressions (recursively) to Python lists.
51For more details, read the module file.
52% XXXXJH should be funcdesc, I think
53
Fred Drake295da241998-08-10 19:42:37 +000054\section{\module{pnl} ---
55 None}
Fred Drakeb91e9341998-07-23 17:59:49 +000056\declaremodule{builtin}{pnl}
57
58\modulesynopsis{None}
59
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000060
61This module provides access to the
Fred Drakeaf8a0151998-01-14 14:51:31 +000062\emph{Panel Library}
Fred Drake8ee679f2001-07-14 02:50:55 +000063built by NASA Ames\index{NASA} (to get it, send email to
Fred Drakebac354c1998-01-20 04:32:09 +000064\code{panel-request@nas.nasa.gov}).
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000065All access to it should be done through the standard module
Fred Drakebac354c1998-01-20 04:32:09 +000066\code{panel}\refstmodindex{panel},
Thomas Woutersf8316632000-07-16 19:01:10 +000067which transparently exports most functions from
Guido van Rossum5fdeeea1994-01-02 01:22:07 +000068\code{pnl}
69but redefines
70\code{pnl.dopanel()}.
71
72\strong{Warning:}
73the Python interpreter will dump core if you don't create a GL window
74before calling
75\code{pnl.mkpanel()}.
76
77The module is too large to document here in its entirety.