Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5f874d6

Browse files
freddrakefreddrake
committed
Markup nits.
Some additional index entries.
1 parent ebce370 commit 5f874d6

2 files changed

Lines changed: 74 additions & 74 deletions

File tree

‎Doc/lib/libfl.tex‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@ \section{Built-in Module \sectcode{fl}}
22
\label{module-fl}
33
\bimodindex{fl}
44

5-
This module provides an interface to the FORMS Library by Mark
6-
Overmars. The source for the library can be retrieved by anonymous
7-
ftp from host \samp{ftp.cs.ruu.nl}, directory \file{SGI/FORMS}. It
8-
was last tested with version 2.0b.
5+
This module provides an interface to the FORMS Library\index{FORMS
6+
Library} by Mark Overmars\index{Overmars, Mark}. The source for the
7+
library can be retrieved by anonymous ftp from host
8+
\samp{ftp.cs.ruu.nl}, directory \file{SGI/FORMS}. It was last tested
9+
with version 2.0b.
910

1011
Most functions are literal translations of their \C{} equivalents,
1112
dropping the initial \samp{fl_} from their name. Constants used by
@@ -43,8 +44,7 @@ \subsection{Functions Defined in Module \sectcode{fl}}
4344
information about what they do, see the description of the equivalent
4445
\C{} function in the FORMS documentation:
4546

46-
\setindexsubitem{(in module fl)}
47-
\begin{funcdesc}{make_form}{type\, width\, height}
47+
\begin{funcdesc}{make_form}{type, width, height}
4848
Create a form with given type, width and height. This returns a
4949
\dfn{form} object, whose methods are described below.
5050
\end{funcdesc}
@@ -65,20 +65,20 @@ \subsection{Functions Defined in Module \sectcode{fl}}
6565
Set the event callback function.
6666
\end{funcdesc}
6767

68-
\begin{funcdesc}{set_graphics_mode}{rgbmode\, doublebuffering}
68+
\begin{funcdesc}{set_graphics_mode}{rgbmode, doublebuffering}
6969
Set the graphics modes.
7070
\end{funcdesc}
7171

7272
\begin{funcdesc}{get_rgbmode}{}
73-
Return the current rgb mode. This is the value of the C global
73+
Return the current rgb mode. This is the value of the \C{} global
7474
variable \cdata{fl_rgbmode}.
7575
\end{funcdesc}
7676

77-
\begin{funcdesc}{show_message}{str1\, str2\, str3}
77+
\begin{funcdesc}{show_message}{str1, str2, str3}
7878
Show a dialog box with a three-line message and an OK button.
7979
\end{funcdesc}
8080

81-
\begin{funcdesc}{show_question}{str1\, str2\, str3}
81+
\begin{funcdesc}{show_question}{str1, str2, str3}
8282
Show a dialog box with a three-line message and YES and NO buttons.
8383
It returns \code{1} if the user pressed YES, \code{0} if NO.
8484
\end{funcdesc}
@@ -89,13 +89,13 @@ \subsection{Functions Defined in Module \sectcode{fl}}
8989
(\code{1}, \code{2} or \code{3}).
9090
\end{funcdesc}
9191

92-
\begin{funcdesc}{show_input}{prompt\, default}
92+
\begin{funcdesc}{show_input}{prompt, default}
9393
Show a dialog box with a one-line prompt message and text field in
9494
which the user can enter a string. The second argument is the default
9595
input string. It returns the string value as edited by the user.
9696
\end{funcdesc}
9797

98-
\begin{funcdesc}{show_file_selector}{message\, directory\, pattern\, default}
98+
\begin{funcdesc}{show_file_selector}{message, directory, pattern, default}
9999
Show a dialog box in which the user can select a file. It returns
100100
the absolute filename selected by the user, or \code{None} if the user
101101
presses Cancel.
@@ -116,9 +116,9 @@ \subsection{Functions Defined in Module \sectcode{fl}}
116116
\funcline{qread}{}
117117
%\funcline{blkqread}{?}
118118
\funcline{qreset}{}
119-
\funcline{qenter}{dev\, val}
119+
\funcline{qenter}{dev, val}
120120
\funcline{get_mouse}{}
121-
\funcline{tie}{button\, valuator1\, valuator2}
121+
\funcline{tie}{button, valuator1, valuator2}
122122
These functions are the FORMS interfaces to the corresponding GL
123123
functions. Use these if you want to handle some GL events yourself
124124
when using \function{fl.do_events()}. When a GL event is detected that
@@ -143,14 +143,14 @@ \subsection{Form Objects}
143143
pointer; please refer to the official FORMS documentation for
144144
descriptions.
145145

146-
All the \samp{add_{\rm \ldots}} functions return a Python object
146+
All the \code{add_*()} functions return a Python object
147147
representing the FORMS object. Methods of FORMS objects are described
148148
below. Most kinds of FORMS object also have some methods specific to
149149
that kind; these methods are listed here.
150150

151151
\begin{flushleft}
152-
\setindexsubitem{(form object method)}
153-
\begin{funcdesc}{show_form}{placement\, bordertype\, name}
152+
\setindexsubitem{(form method)}
153+
\begin{funcdesc}{show_form}{placement, bordertype, name}
154154
Show the form.
155155
\end{funcdesc}
156156

@@ -162,7 +162,7 @@ \subsection{Form Objects}
162162
Redraw the form.
163163
\end{funcdesc}
164164

165-
\begin{funcdesc}{set_form_position}{x\, y}
165+
\begin{funcdesc}{set_form_position}{x, y}
166166
Set the form's position.
167167
\end{funcdesc}
168168

@@ -200,43 +200,43 @@ \subsection{Form Objects}
200200

201201
%---
202202

203-
\begin{funcdesc}{add_box}{type\, x\, y\, w\, h\, name}
203+
\begin{funcdesc}{add_box}{type, x, y, w, h, name}
204204
Add a box object to the form.
205205
No extra methods.
206206
\end{funcdesc}
207207

208-
\begin{funcdesc}{add_text}{type\, x\, y\, w\, h\, name}
208+
\begin{funcdesc}{add_text}{type, x, y, w, h, name}
209209
Add a text object to the form.
210210
No extra methods.
211211
\end{funcdesc}
212212

213-
%\begin{funcdesc}{add_bitmap}{type\, x\, y\, w\, h\, name}
213+
%\begin{funcdesc}{add_bitmap}{type, x, y, w, h, name}
214214
%Add a bitmap object to the form.
215215
%\end{funcdesc}
216216

217-
\begin{funcdesc}{add_clock}{type\, x\, y\, w\, h\, name}
217+
\begin{funcdesc}{add_clock}{type, x, y, w, h, name}
218218
Add a clock object to the form. \\
219219
Method:
220220
\method{get_clock()}.
221221
\end{funcdesc}
222222

223223
%---
224224

225-
\begin{funcdesc}{add_button}{type\, x\, y\, w\, h\, name}
225+
\begin{funcdesc}{add_button}{type, x, y, w, h, name}
226226
Add a button object to the form. \\
227227
Methods:
228228
\method{get_button()},
229229
\method{set_button()}.
230230
\end{funcdesc}
231231

232-
\begin{funcdesc}{add_lightbutton}{type\, x\, y\, w\, h\, name}
232+
\begin{funcdesc}{add_lightbutton}{type, x, y, w, h, name}
233233
Add a lightbutton object to the form. \\
234234
Methods:
235235
\method{get_button()},
236236
\method{set_button()}.
237237
\end{funcdesc}
238238

239-
\begin{funcdesc}{add_roundbutton}{type\, x\, y\, w\, h\, name}
239+
\begin{funcdesc}{add_roundbutton}{type, x, y, w, h, name}
240240
Add a roundbutton object to the form. \\
241241
Methods:
242242
\method{get_button()},
@@ -245,7 +245,7 @@ \subsection{Form Objects}
245245

246246
%---
247247

248-
\begin{funcdesc}{add_slider}{type\, x\, y\, w\, h\, name}
248+
\begin{funcdesc}{add_slider}{type, x, y, w, h, name}
249249
Add a slider object to the form. \\
250250
Methods:
251251
\method{set_slider_value()},
@@ -258,7 +258,7 @@ \subsection{Form Objects}
258258
\method{set_slider_step()}.
259259
\end{funcdesc}
260260

261-
\begin{funcdesc}{add_valslider}{type\, x\, y\, w\, h\, name}
261+
\begin{funcdesc}{add_valslider}{type, x, y, w, h, name}
262262
Add a valslider object to the form. \\
263263
Methods:
264264
\method{set_slider_value()},
@@ -271,7 +271,7 @@ \subsection{Form Objects}
271271
\method{set_slider_step()}.
272272
\end{funcdesc}
273273

274-
\begin{funcdesc}{add_dial}{type\, x\, y\, w\, h\, name}
274+
\begin{funcdesc}{add_dial}{type, x, y, w, h, name}
275275
Add a dial object to the form. \\
276276
Methods:
277277
\method{set_dial_value()},
@@ -280,7 +280,7 @@ \subsection{Form Objects}
280280
\method{get_dial_bounds()}.
281281
\end{funcdesc}
282282

283-
\begin{funcdesc}{add_positioner}{type\, x\, y\, w\, h\, name}
283+
\begin{funcdesc}{add_positioner}{type, x, y, w, h, name}
284284
Add a positioner object to the form. \\
285285
Methods:
286286
\method{set_positioner_xvalue()},
@@ -293,7 +293,7 @@ \subsection{Form Objects}
293293
\method{get_positioner_ybounds()}.
294294
\end{funcdesc}
295295

296-
\begin{funcdesc}{add_counter}{type\, x\, y\, w\, h\, name}
296+
\begin{funcdesc}{add_counter}{type, x, y, w, h, name}
297297
Add a counter object to the form. \\
298298
Methods:
299299
\method{set_counter_value()},
@@ -306,7 +306,7 @@ \subsection{Form Objects}
306306

307307
%---
308308

309-
\begin{funcdesc}{add_input}{type\, x\, y\, w\, h\, name}
309+
\begin{funcdesc}{add_input}{type, x, y, w, h, name}
310310
Add a input object to the form. \\
311311
Methods:
312312
\method{set_input()},
@@ -317,15 +317,15 @@ \subsection{Form Objects}
317317

318318
%---
319319

320-
\begin{funcdesc}{add_menu}{type\, x\, y\, w\, h\, name}
320+
\begin{funcdesc}{add_menu}{type, x, y, w, h, name}
321321
Add a menu object to the form. \\
322322
Methods:
323323
\method{set_menu()},
324324
\method{get_menu()},
325325
\method{addto_menu()}.
326326
\end{funcdesc}
327327

328-
\begin{funcdesc}{add_choice}{type\, x\, y\, w\, h\, name}
328+
\begin{funcdesc}{add_choice}{type, x, y, w, h, name}
329329
Add a choice object to the form. \\
330330
Methods:
331331
\method{set_choice()},
@@ -339,7 +339,7 @@ \subsection{Form Objects}
339339
\method{set_choice_fontstyle()}.
340340
\end{funcdesc}
341341

342-
\begin{funcdesc}{add_browser}{type\, x\, y\, w\, h\, name}
342+
\begin{funcdesc}{add_browser}{type, x, y, w, h, name}
343343
Add a browser object to the form. \\
344344
Methods:
345345
\method{set_browser_topline()},
@@ -364,7 +364,7 @@ \subsection{Form Objects}
364364

365365
%---
366366

367-
\begin{funcdesc}{add_timer}{type\, x\, y\, w\, h\, name}
367+
\begin{funcdesc}{add_timer}{type, x, y, w, h, name}
368368
Add a timer object to the form. \\
369369
Methods:
370370
\method{set_timer()},
@@ -392,8 +392,8 @@ \subsection{FORMS Objects}
392392
Besides methods specific to particular kinds of FORMS objects, all
393393
FORMS objects also have the following methods:
394394

395-
\setindexsubitem{(FORMS object method)}
396-
\begin{funcdesc}{set_call_back}{function\, argument}
395+
\setindexsubitem{(FORMS method)}
396+
\begin{funcdesc}{set_call_back}{function, argument}
397397
Set the object's callback function and argument. When the object
398398
needs interaction, the callback function will be called with two
399399
arguments: the object, and the callback argument. (FORMS objects

0 commit comments

Comments
 (0)