Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libfl.tex @ 21467:4e35fa5d5708 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 346dcafc878b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
1 \section{\module{fl} ---
18574
346dcafc878b Minor changes to match the style guide.
Fred Drake <fdrake@acm.org>
parents: 10799
diff changeset
2 FORMS library for graphical user interfaces}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
3
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
4 \declaremodule{builtin}{fl}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
5 \platform{IRIX}
18574
346dcafc878b Minor changes to match the style guide.
Fred Drake <fdrake@acm.org>
parents: 10799
diff changeset
6 \modulesynopsis{FORMS library for applications with graphical user
346dcafc878b Minor changes to match the style guide.
Fred Drake <fdrake@acm.org>
parents: 10799
diff changeset
7 interfaces.}
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
8
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
9
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
10 This module provides an interface to the FORMS Library\index{FORMS
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
11 Library} by Mark Overmars\index{Overmars, Mark}. The source for the
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
12 library can be retrieved by anonymous ftp from host
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
13 \samp{ftp.cs.ruu.nl}, directory \file{SGI/FORMS}. It was last tested
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
14 with version 2.0b.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
15
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
16 Most functions are literal translations of their C equivalents,
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
17 dropping the initial \samp{fl_} from their name. Constants used by
10799
312eb4801a1c Use the new module-key for the FL module when hyperlinking (the old
Fred Drake <fdrake@acm.org>
parents: 10385
diff changeset
18 the library are defined in module \refmodule[fl-constants]{FL}
312eb4801a1c Use the new module-key for the FL module when hyperlinking (the old
Fred Drake <fdrake@acm.org>
parents: 10385
diff changeset
19 described below.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
20
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 The creation of objects is a little different in Python than in C:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 instead of the `current form' maintained by the library to which new
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 FORMS objects are added, all functions that add a FORMS object to a
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
24 form are methods of the Python object representing the form.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 Consequently, there are no Python equivalents for the C functions
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
26 \cfunction{fl_addto_form()} and \cfunction{fl_end_form()}, and the
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
27 equivalent of \cfunction{fl_bgn_form()} is called
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
28 \function{fl.make_form()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 Watch out for the somewhat confusing terminology: FORMS uses the word
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 \dfn{object} for the buttons, sliders etc. that you can place in a form.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
32 In Python, `object' means any value. The Python interface to FORMS
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 introduces two new Python object types: form objects (representing an
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 entire form) and FORMS objects (representing one button, slider etc.).
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
35 Hopefully this isn't too confusing.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
36
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 There are no `free objects' in the Python interface to FORMS, nor is
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 there an easy way to add object classes written in Python. The FORMS
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
39 interface to GL event handling is available, though, so you can mix
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 FORMS with pure GL windows.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
41
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
42 \strong{Please note:} importing \module{fl} implies a call to the GL
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
43 function \cfunction{foreground()} and to the FORMS routine
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
44 \cfunction{fl_init()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
45
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
46 \subsection{Functions Defined in Module \module{fl}}
2581
4d28b655b728 added nodename macro calls for new very long section names
Guido van Rossum <guido@python.org>
parents: 2576
diff changeset
47 \nodename{FL Functions}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
48
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
49 Module \module{fl} defines the following functions. For more
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
50 information about what they do, see the description of the equivalent
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
51 C function in the FORMS documentation:
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
52
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
53 \begin{funcdesc}{make_form}{type, width, height}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 Create a form with given type, width and height. This returns a
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
55 \dfn{form} object, whose methods are described below.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
56 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
58 \begin{funcdesc}{do_forms}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
59 The standard FORMS main loop. Returns a Python object representing
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 the FORMS object needing interaction, or the special value
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
61 \constant{FL.EVENT}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
62 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
63
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
64 \begin{funcdesc}{check_forms}{}
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
65 Check for FORMS events. Returns what \function{do_forms()} above
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
66 returns, or \code{None} if there is no event that immediately needs
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
67 interaction.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
68 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
69
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
70 \begin{funcdesc}{set_event_call_back}{function}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 Set the event callback function.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
72 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
73
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
74 \begin{funcdesc}{set_graphics_mode}{rgbmode, doublebuffering}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
75 Set the graphics modes.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
76 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
77
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
78 \begin{funcdesc}{get_rgbmode}{}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
79 Return the current rgb mode. This is the value of the C global
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
80 variable \cdata{fl_rgbmode}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
81 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
82
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
83 \begin{funcdesc}{show_message}{str1, str2, str3}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 Show a dialog box with a three-line message and an OK button.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
85 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
86
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
87 \begin{funcdesc}{show_question}{str1, str2, str3}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
88 Show a dialog box with a three-line message and YES and NO buttons.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
89 It returns \code{1} if the user pressed YES, \code{0} if NO.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
91
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
92 \begin{funcdesc}{show_choice}{str1, str2, str3, but1\optional{,
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
93 but2\optional{, but3}}}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
94 Show a dialog box with a three-line message and up to three buttons.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
95 It returns the number of the button clicked by the user
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
96 (\code{1}, \code{2} or \code{3}).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
97 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
98
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
99 \begin{funcdesc}{show_input}{prompt, default}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
100 Show a dialog box with a one-line prompt message and text field in
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
101 which the user can enter a string. The second argument is the default
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
102 input string. It returns the string value as edited by the user.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
103 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
104
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
105 \begin{funcdesc}{show_file_selector}{message, directory, pattern, default}
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
106 Show a dialog box in which the user can select a file. It returns
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
107 the absolute filename selected by the user, or \code{None} if the user
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
108 presses Cancel.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
109 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
110
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
111 \begin{funcdesc}{get_directory}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
112 \funcline{get_pattern}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 \funcline{get_filename}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
114 These functions return the directory, pattern and filename (the tail
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
115 part only) selected by the user in the last
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
116 \function{show_file_selector()} call.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
117 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
118
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
119 \begin{funcdesc}{qdevice}{dev}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
120 \funcline{unqdevice}{dev}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
121 \funcline{isqueued}{dev}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
122 \funcline{qtest}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
123 \funcline{qread}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
124 %\funcline{blkqread}{?}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
125 \funcline{qreset}{}
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
126 \funcline{qenter}{dev, val}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
127 \funcline{get_mouse}{}
7690
f924727cd00b Markup nits.
Fred Drake <fdrake@acm.org>
parents: 7404
diff changeset
128 \funcline{tie}{button, valuator1, valuator2}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
129 These functions are the FORMS interfaces to the corresponding GL
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 functions. Use these if you want to handle some GL events yourself
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
131 when using \function{fl.do_events()}. When a GL event is detected that
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
132 FORMS cannot handle, \function{fl.do_forms()} returns the special value
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
133 \constant{FL.EVENT} and you should call \function{fl.qread()} to read
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
134 the event from the queue. Don't use the equivalent GL functions!
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
135 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
136
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
137 \begin{funcdesc}{color}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
138 \funcline{mapcolor}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
139 \funcline{getmcolor}{}
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
140 See the description in the FORMS documentation of
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
141 \cfunction{fl_color()}, \cfunction{fl_mapcolor()} and
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
142 \cfunction{fl_getmcolor()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
143 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
144
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
145 \subsection{Form Objects}
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
146 \label{form-objects}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
147
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
148 Form objects (returned by \function{make_form()} above) have the
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
149 following methods. Each method corresponds to a C function whose
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
150 name is prefixed with \samp{fl_}; and whose first argument is a form
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
151 pointer; please refer to the official FORMS documentation for
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
152 descriptions.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
153
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
154 All the \method{add_*()} methods return a Python object representing
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
155 the FORMS object. Methods of FORMS objects are described below. Most
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
156 kinds of FORMS object also have some methods specific to that kind;
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
157 these methods are listed here.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
158
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
159 \begin{flushleft}
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
160
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
161 \begin{methoddesc}[form]{show_form}{placement, bordertype, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
162 Show the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
163 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
164
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
165 \begin{methoddesc}[form]{hide_form}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
166 Hide the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
167 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
168
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
169 \begin{methoddesc}[form]{redraw_form}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
170 Redraw the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
171 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
172
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
173 \begin{methoddesc}[form]{set_form_position}{x, y}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
174 Set the form's position.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
175 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
176
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
177 \begin{methoddesc}[form]{freeze_form}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
178 Freeze the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
179 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
180
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
181 \begin{methoddesc}[form]{unfreeze_form}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
182 Unfreeze the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
183 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
184
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
185 \begin{methoddesc}[form]{activate_form}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
186 Activate the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
187 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
188
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
189 \begin{methoddesc}[form]{deactivate_form}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
190 Deactivate the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
191 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
192
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
193 \begin{methoddesc}[form]{bgn_group}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
194 Begin a new group of objects; return a group object.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
195 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
196
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
197 \begin{methoddesc}[form]{end_group}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
198 End the current group of objects.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
199 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
200
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
201 \begin{methoddesc}[form]{find_first}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
202 Find the first object in the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
203 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
204
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
205 \begin{methoddesc}[form]{find_last}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
206 Find the last object in the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
207 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
208
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
209 %---
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
210
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
211 \begin{methoddesc}[form]{add_box}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
212 Add a box object to the form.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
213 No extra methods.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
214 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
215
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
216 \begin{methoddesc}[form]{add_text}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
217 Add a text object to the form.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
218 No extra methods.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
219 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
220
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
221 %\begin{methoddesc}[form]{add_bitmap}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
222 %Add a bitmap object to the form.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
223 %\end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
224
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
225 \begin{methoddesc}[form]{add_clock}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
226 Add a clock object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
227 Method:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
228 \method{get_clock()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
229 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
230
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
231 %---
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
232
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
233 \begin{methoddesc}[form]{add_button}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
234 Add a button object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
235 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
236 \method{get_button()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
237 \method{set_button()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
238 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
239
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
240 \begin{methoddesc}[form]{add_lightbutton}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
241 Add a lightbutton object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
242 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
243 \method{get_button()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
244 \method{set_button()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
245 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
246
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
247 \begin{methoddesc}[form]{add_roundbutton}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
248 Add a roundbutton object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
249 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
250 \method{get_button()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
251 \method{set_button()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
252 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
253
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
254 %---
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
255
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
256 \begin{methoddesc}[form]{add_slider}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
257 Add a slider object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
258 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
259 \method{set_slider_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
260 \method{get_slider_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
261 \method{set_slider_bounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
262 \method{get_slider_bounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
263 \method{set_slider_return()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
264 \method{set_slider_size()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
265 \method{set_slider_precision()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
266 \method{set_slider_step()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
267 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
268
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
269 \begin{methoddesc}[form]{add_valslider}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
270 Add a valslider object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
271 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
272 \method{set_slider_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
273 \method{get_slider_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
274 \method{set_slider_bounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
275 \method{get_slider_bounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
276 \method{set_slider_return()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
277 \method{set_slider_size()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
278 \method{set_slider_precision()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
279 \method{set_slider_step()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
280 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
281
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
282 \begin{methoddesc}[form]{add_dial}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 Add a dial object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
284 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
285 \method{set_dial_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
286 \method{get_dial_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
287 \method{set_dial_bounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
288 \method{get_dial_bounds()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
289 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
290
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
291 \begin{methoddesc}[form]{add_positioner}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
292 Add a positioner object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
293 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
294 \method{set_positioner_xvalue()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
295 \method{set_positioner_yvalue()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
296 \method{set_positioner_xbounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
297 \method{set_positioner_ybounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
298 \method{get_positioner_xvalue()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
299 \method{get_positioner_yvalue()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
300 \method{get_positioner_xbounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
301 \method{get_positioner_ybounds()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
302 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
303
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
304 \begin{methoddesc}[form]{add_counter}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
305 Add a counter object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
306 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
307 \method{set_counter_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
308 \method{get_counter_value()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
309 \method{set_counter_bounds()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
310 \method{set_counter_step()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
311 \method{set_counter_precision()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
312 \method{set_counter_return()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
313 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
314
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
315 %---
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
316
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
317 \begin{methoddesc}[form]{add_input}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
318 Add a input object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
319 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
320 \method{set_input()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
321 \method{get_input()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
322 \method{set_input_color()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
323 \method{set_input_return()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
324 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
325
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
326 %---
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
327
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
328 \begin{methoddesc}[form]{add_menu}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
329 Add a menu object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
330 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
331 \method{set_menu()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
332 \method{get_menu()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
333 \method{addto_menu()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
334 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
335
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
336 \begin{methoddesc}[form]{add_choice}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
337 Add a choice object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
338 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
339 \method{set_choice()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
340 \method{get_choice()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
341 \method{clear_choice()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
342 \method{addto_choice()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
343 \method{replace_choice()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
344 \method{delete_choice()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
345 \method{get_choice_text()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
346 \method{set_choice_fontsize()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
347 \method{set_choice_fontstyle()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
348 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
349
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
350 \begin{methoddesc}[form]{add_browser}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
351 Add a browser object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
352 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
353 \method{set_browser_topline()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
354 \method{clear_browser()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
355 \method{add_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
356 \method{addto_browser()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
357 \method{insert_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
358 \method{delete_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
359 \method{replace_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
360 \method{get_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
361 \method{load_browser()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
362 \method{get_browser_maxline()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
363 \method{select_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
364 \method{deselect_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
365 \method{deselect_browser()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
366 \method{isselected_browser_line()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
367 \method{get_browser()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
368 \method{set_browser_fontsize()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
369 \method{set_browser_fontstyle()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
370 \method{set_browser_specialkey()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
371 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
372
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
373 %---
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
374
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
375 \begin{methoddesc}[form]{add_timer}{type, x, y, w, h, name}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
376 Add a timer object to the form. \\
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
377 Methods:
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
378 \method{set_timer()},
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
379 \method{get_timer()}.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
380 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
381 \end{flushleft}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
382
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
383 Form objects have the following data attributes; see the FORMS
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
384 documentation:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
385
8018
011ae71fea96 Lighten up tables.
Fred Drake <fdrake@acm.org>
parents: 7875
diff changeset
386 \begin{tableiii}{l|l|l}{member}{Name}{C Type}{Meaning}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
387 \lineiii{window}{int (read-only)}{GL window id}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
388 \lineiii{w}{float}{form width}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
389 \lineiii{h}{float}{form height}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
390 \lineiii{x}{float}{form x origin}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
391 \lineiii{y}{float}{form y origin}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
392 \lineiii{deactivated}{int}{nonzero if form is deactivated}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
393 \lineiii{visible}{int}{nonzero if form is visible}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
394 \lineiii{frozen}{int}{nonzero if form is frozen}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
395 \lineiii{doublebuf}{int}{nonzero if double buffering on}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
396 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
397
2576
f47bc5554418 mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents: 1767
diff changeset
398 \subsection{FORMS Objects}
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
399 \label{forms-objects}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
400
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
401 Besides methods specific to particular kinds of FORMS objects, all
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
402 FORMS objects also have the following methods:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
403
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
404 \begin{methoddesc}[FORMS object]{set_call_back}{function, argument}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
405 Set the object's callback function and argument. When the object
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
406 needs interaction, the callback function will be called with two
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
407 arguments: the object, and the callback argument. (FORMS objects
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
408 without a callback function are returned by \function{fl.do_forms()}
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
409 or \function{fl.check_forms()} when they need interaction.) Call this
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
410 method without arguments to remove the callback function.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
411 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
412
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
413 \begin{methoddesc}[FORMS object]{delete_object}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
414 Delete the object.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
415 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
416
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
417 \begin{methoddesc}[FORMS object]{show_object}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
418 Show the object.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
419 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
420
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
421 \begin{methoddesc}[FORMS object]{hide_object}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
422 Hide the object.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
423 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
424
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
425 \begin{methoddesc}[FORMS object]{redraw_object}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
426 Redraw the object.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
427 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
428
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
429 \begin{methoddesc}[FORMS object]{freeze_object}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
430 Freeze the object.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
431 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
432
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
433 \begin{methoddesc}[FORMS object]{unfreeze_object}{}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
434 Unfreeze the object.
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
435 \end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
436
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
437 %\begin{methoddesc}[FORMS object]{handle_object}{} XXX
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
438 %\end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
439
7875
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
440 %\begin{methoddesc}[FORMS object]{handle_object_direct}{} XXX
8f425f8f4be2 Remove obsolete \setindexsubitem macros.
Fred Drake <fdrake@acm.org>
parents: 7690
diff changeset
441 %\end{methoddesc}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
442
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
443 FORMS objects have these data attributes; see the FORMS documentation:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
444
8018
011ae71fea96 Lighten up tables.
Fred Drake <fdrake@acm.org>
parents: 7875
diff changeset
445 \begin{tableiii}{l|l|l}{member}{Name}{C Type}{Meaning}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
446 \lineiii{objclass}{int (read-only)}{object class}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
447 \lineiii{type}{int (read-only)}{object type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
448 \lineiii{boxtype}{int}{box type}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
449 \lineiii{x}{float}{x origin}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
450 \lineiii{y}{float}{y origin}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
451 \lineiii{w}{float}{width}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
452 \lineiii{h}{float}{height}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
453 \lineiii{col1}{int}{primary color}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
454 \lineiii{col2}{int}{secondary color}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
455 \lineiii{align}{int}{alignment}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
456 \lineiii{lcol}{int}{label color}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
457 \lineiii{lsize}{float}{label font size}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
458 \lineiii{label}{string}{label string}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
459 \lineiii{lstyle}{int}{label style}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
460 \lineiii{pushed}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
461 \lineiii{focus}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
462 \lineiii{belowmouse}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
463 \lineiii{frozen}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
464 \lineiii{active}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
465 \lineiii{input}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
466 \lineiii{visible}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
467 \lineiii{radio}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
468 \lineiii{automatic}{int (read-only)}{(see FORMS docs)}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
469 \end{tableiii}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
470
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
471
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
472 \section{\module{FL} ---
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
473 Constants used with the \module{fl} module}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
474
10385
e93352286aac Fixup the module keys. There were some problems with hosting / processing
Fred Drake <fdrake@acm.org>
parents: 10334
diff changeset
475 \declaremodule[fl-constants]{standard}{FL}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
476 \platform{IRIX}
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
477 \modulesynopsis{Constants used with the \module{fl} module.}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
478
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
479
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
480 This module defines symbolic constants needed to use the built-in
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
481 module \refmodule{fl} (see above); they are equivalent to those defined in
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
482 the C header file \code{<forms.h>} except that the name prefix
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
483 \samp{FL_} is omitted. Read the module source for a complete list of
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
484 the defined names. Suggested use:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
485
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 7095
diff changeset
486 \begin{verbatim}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
487 import fl
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
488 from FL import *
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 7095
diff changeset
489 \end{verbatim}
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
490
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
491
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
492 \section{\module{flp} ---
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
493 Functions for loading stored FORMS designs}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
494
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
495 \declaremodule{standard}{flp}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
496 \platform{IRIX}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
497 \modulesynopsis{Functions for loading stored FORMS designs.}
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 8018
diff changeset
498
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
499
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
500 This module defines functions that can read form definitions created
7404
3a77bca226b9 Adjusted \label{} for *consistent* logical addressing.
Fred Drake <fdrake@acm.org>
parents: 7328
diff changeset
501 by the `form designer' (\program{fdesign}) program that comes with the
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
502 FORMS library (see module \refmodule{fl} above).
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
503
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
504 For now, see the file \file{flp.doc} in the Python library source
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
505 directory for a description.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
506
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
507 XXX A complete description should be inserted here!