Mercurial > cpython-lru_cache-weakref

annotate Doc/mac/libmacui.tex @ 27998:e27f58a50737 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
SF bug #690377: Dud footnote reference in distutils docs
author Raymond Hettinger <python@rcn.com>
date Fri, 21 Feb 2003 02:47:09 +0000
parents 523efd773261
children 78bab8fc8ed5 229bb9f2e96f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8915
552c6b3aba3d New style section headers.
Fred Drake <fdrake@acm.org>
parents: 8715
diff changeset
1 \section{\module{EasyDialogs} ---
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
2 Basic Macintosh dialogs}
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
3
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 7866
diff changeset
4 \declaremodule{standard}{EasyDialogs}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 8915
diff changeset
5 \platform{Mac}
8715
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 7866
diff changeset
6 \modulesynopsis{Basic Macintosh dialogs.}
c750c7a21e03 Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
Fred Drake <fdrake@acm.org>
parents: 7866
diff changeset
7
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
8 The \module{EasyDialogs} module contains some simple dialogs for the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
9 Macintosh. All routines take an optional resource ID parameter \var{id}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
10 with which one can override the \constant{DLOG} resource used for the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
11 dialog, provided that the dialog items correspond (both type and item
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
12 number) to those in the default \constant{DLOG} resource. See source
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
13 code for details.
14263
363851cccf2a Remove the reference to stdwin. The comment was still true, but no
Fred Drake <fdrake@acm.org>
parents: 10334
diff changeset
14
7866
b69fa9d142ca Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7712
diff changeset
15 The \module{EasyDialogs} module defines the following functions:
3194
05aeb91e3b90 Documented MACFS, macostools, EasyDialogs and FrameWork modules.
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
16
05aeb91e3b90 Documented MACFS, macostools, EasyDialogs and FrameWork modules.
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
17
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
18 \begin{funcdesc}{Message}{str\optional{, id\optional{, ok=None}}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
19 Displays a modal dialog with the message text \var{str}, which should be
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
20 at most 255 characters long. The button text defaults to ``OK'', but is
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
21 set to the string argument \var{ok} if the latter is supplied. Control
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
22 is returned when the user clicks the ``OK'' button.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
23 \end{funcdesc}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
24
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
25
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
26 \begin{funcdesc}{AskString}{prompt\optional{, default\optional{,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
27 id\optional{, ok\optional{, cancel}}}}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
28 Asks the user to input a string value via a modal dialog. \var{prompt}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
29 is the prompt message, and the optional \var{default} supplies the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
30 initial value for the string (otherwise \code{""} is used). The text of
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
31 the ``OK'' and ``Cancel'' buttons can be changed with the \var{ok} and
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
32 \var{cancel} arguments. All strings can be at most 255 bytes long.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
33 \function{AskString()} returns the string entered or \code{None} in case
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
34 the user cancelled.
3194
05aeb91e3b90 Documented MACFS, macostools, EasyDialogs and FrameWork modules.
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
35 \end{funcdesc}
05aeb91e3b90 Documented MACFS, macostools, EasyDialogs and FrameWork modules.
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
36
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
37
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
38 \begin{funcdesc}{AskPassword}{prompt\optional{, default\optional{,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
39 id\optional{, ok\optional{, cancel}}}}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
40 Asks the user to input a string value via a modal dialog. Like
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
41 \function{AskString()}, but with the text shown as bullets. The
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
42 arguments have the same meaning as for \function{AskString()}.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
43 \end{funcdesc}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
44
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
45
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
46 \begin{funcdesc}{AskYesNoCancel}{question\optional{, default\optional{,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
47 yes\optional{, no\optional{, cancel\optional{, id}}}}}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
48 Presents a dialog with prompt \var{question} and three buttons labelled
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
49 ``Yes'', ``No'', and ``Cancel''. Returns \code{1} for ``Yes'', \code{0}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
50 for ``No'' and \code{-1} for ``Cancel''. The value of \var{default} (or
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
51 \code{0} if \var{default} is not supplied) is returned when the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
52 \kbd{RETURN} key is pressed. The text of the buttons can be changed with
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
53 the \var{yes}, \var{no}, and \var{cancel} arguments; to prevent a button
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
54 from appearing, supply \code{""} for the corresponding argument.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
55 \end{funcdesc}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
56
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
57
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
58 \begin{funcdesc}{ProgressBar}{\optional{title\optional{, maxval\optional{,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
59 label\optional{, id}}}}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
60 Displays a modeless progress-bar dialog. This is the constructor for the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
61 \class{ProgressBar} class described below. \var{title} is the text
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
62 string displayed (default ``Working...''), \var{maxval} is the value at
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
63 which progress is complete (default \code{0}, indicating that an
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
64 indeterminate amount of work remains to be done), and \var{label} is
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
65 the text that is displayed above the progress bar itself.
15225
486a31d8a3b3 Chris Barker <cbarker@jps.net>:
Fred Drake <fdrake@acm.org>
parents: 14263
diff changeset
66 \end{funcdesc}
486a31d8a3b3 Chris Barker <cbarker@jps.net>:
Fred Drake <fdrake@acm.org>
parents: 14263
diff changeset
67
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
68
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
69 \begin{funcdesc}{GetArgv}{\optional{optionlist\optional{
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
70 commandlist\optional{, addoldfile\optional{, addnewfile\optional{,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
71 addfolder\optional{, id}}}}}}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
72 Displays a dialog which aids the user in constructing a command-line
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
73 argument list. Returns the list in \code{sys.argv} format, suitable for
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
74 passing as an argument to \function{getopt.getopt()}. \var{addoldfile},
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
75 \var{addnewfile}, and \var{addfolder} are boolean arguments. When
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
76 nonzero, they enable the user to insert into the command line paths to
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
77 an existing file, a (possibly) not-yet-existent file, and a folder,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
78 respectively. (Note: Option arguments must appear in the command line
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
79 before file and folder arguments in order to be recognized by
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
80 \function{getopt.getopt()}.) Arguments containing spaces can be
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
81 specified by enclosing them within single or double quotes. A
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
82 \exception{SystemExit} exception is raised if the user presses the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
83 ``Cancel'' button.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
84
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
85 \var{optionlist} is a list that determines a popup menu from which the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
86 allowed options are selected. Its items can take one of two forms:
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
87 \var{optstr} or \code{(\var{optstr}, \var{descr})}. When present,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
88 \var{descr} is a short descriptive string that is displayed in the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
89 dialog while this option is selected in the popup menu. The
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
90 correspondence between \var{optstr}s and command-line arguments is:
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
91
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
92 \begin{tableii}{l|l}{textrm}{\var{optstr} format}{Command-line format}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
93 \lineii{\code{x}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
94 {\programopt{-x} (short option)}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
95 \lineii{\code{x:} or \code{x=}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
96 {\programopt{-x} (short option with value)}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
97 \lineii{\code{xyz}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
98 {\longprogramopt{xyz} (long option)}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
99 \lineii{\code{xyz:} or \code{xyz=}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
100 {\longprogramopt{xyz} (long option with value)}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
101 \end{tableii}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
102
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
103 \var{commandlist} is a list of items of the form \var{cmdstr} or
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
104 \code{(\var{cmdstr}, \var{descr})}, where \var{descr} is as above. The
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
105 \var{cmdstr}s will appear in a popup menu. When chosen, the text of
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
106 \var{cmdstr} will be appended to the command line as is, except that a
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
107 trailing \character{:} or \character{=} (if present) will be trimmed
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
108 off.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
109
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
110 \versionadded{2.0}
3194
05aeb91e3b90 Documented MACFS, macostools, EasyDialogs and FrameWork modules.
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
111 \end{funcdesc}
05aeb91e3b90 Documented MACFS, macostools, EasyDialogs and FrameWork modules.
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
112
27833
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
113 \begin{funcdesc}{AskFileForOpen}{
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
114 \optional{message}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
115 \optional{, typeList}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
116 \optional{, defaultLocation}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
117 \optional{, defaultOptionFlags}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
118 \optional{, location}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
119 \optional{, clientName}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
120 \optional{, windowTitle}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
121 \optional{, actionButtonLabel}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
122 \optional{, cancelButtonLabel}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
123 \optional{, preferenceKey}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
124 \optional{, popupExtension}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
125 \optional{, eventProc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
126 \optional{, previewProc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
127 \optional{, filterProc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
128 \optional{, wanted}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
129 }
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
130 Post a dialog asking the user for a file to open, and return the file
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
131 selected or \var{None} if the user cancelled.
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
132 \var{message} is a text message to display,
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
133 \var{typeList} is a list of 4-char filetypes allowable,
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
134 \var{defaultLocation} is the pathname, FSSpec or FSRef of the folder
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
135 to show initially,
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
136 \var{location} is the \code{(x, y)} position on the screen where the
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
137 dialog is shown,
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
138 \var{actionButtonLabel} is a string to show in stead of ``Open'' in the
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
139 OK button,
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
140 \var{cancelButtonLabel} is a string to show in stead of ``Cancel'' in the
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
141 cancel button,
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
142 \var{wanted} is the type of value wanted as a return: \class{string},
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
143 \class{unicode}, \class{FSSpec}, \class{FSRef} and subtypes thereof are
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
144 acceptable.
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
145
27833
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
146 For a description of the other arguments please see the Apple Navigation
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
147 Services documentation and the EasyDialogs sourcecode.
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
148 \end{funcdesc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
149
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
150 \begin{funcdesc}{AskFileForSave}{
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
151 \optional{message}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
152 \optional{, savedFileName}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
153 \optional{, defaultLocation}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
154 \optional{, defaultOptionFlags}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
155 \optional{, location}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
156 \optional{, clientName}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
157 \optional{, windowTitle}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
158 \optional{, actionButtonLabel}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
159 \optional{, cancelButtonLabel}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
160 \optional{, preferenceKey}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
161 \optional{, popupExtension}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
162 \optional{, fileType}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
163 \optional{, fileCreator}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
164 \optional{, eventProc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
165 \optional{, wanted}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
166 }
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
167 Post a dialog asking the user for a file to save to, and return the file
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
168 selected or \var{None} if the user cancelled. \var{savedFileName} is the
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
169 default for the file name to save to (the return value). See AskFileForOpen
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
170 for a description of the other arguments.
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
171 \end{funcdesc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
172
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
173 \begin{funcdesc}{AskFolder}{
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
174 \optional{message}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
175 \optional{, defaultLocation}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
176 \optional{, defaultOptionFlags}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
177 \optional{, location}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
178 \optional{, clientName}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
179 \optional{, windowTitle}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
180 \optional{, actionButtonLabel}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
181 \optional{, cancelButtonLabel}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
182 \optional{, preferenceKey}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
183 \optional{, popupExtension}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
184 \optional{, eventProc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
185 \optional{, filterProc}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
186 \optional{, wanted}
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
187 }
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
188 Post a dialog asking the user to select a folder, and return the folder
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
189 selected or \var{None} if the user cancelled. See AskFileForOpen
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
190 for a description of the arguments.
523efd773261 Updated the Mac documentation to the current state of affairs.
Jack Jansen <jack.jansen@cwi.nl>
parents: 23059
diff changeset
191 \end{funcdesc}
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
192
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
193 \subsection{ProgressBar Objects \label{progressbar-objects}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
194
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
195 \class{ProgressBar} objects provide support for modeless progress-bar
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
196 dialogs. Both determinate (thermometer style) and indeterminate
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
197 (barber-pole style) progress bars are supported. The bar will be
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
198 determinate if its maximum value is greater than zero; otherwise it
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
199 will be indeterminate.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
200 \versionchanged[Support for indeterminate-style progress bars was
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
201 added]{2.2}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
202
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
203 The dialog is displayed immediately after creation. If the dialog's
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
204 ``Cancel'' button is pressed, or if \kbd{Cmd-.} or \kbd{ESC} is typed,
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
205 the dialog window is hidden and \exception{KeyboardInterrupt} is
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
206 raised (but note that this response does not occur until the progress
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
207 bar is next updated, typically via a call to \method{inc()} or
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
208 \method{set()}). Otherwise, the bar remains visible until the
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
209 \class{ProgressBar} object is discarded.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
210
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
211 \class{ProgressBar} objects possess the following attributes and
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
212 methods:
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
213
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
214 \begin{memberdesc}[ProgressBar]{curval}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
215 The current value (of type integer or long integer) of the progress
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
216 bar. The normal access methods coerce \member{curval} between
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
217 \code{0} and \member{maxval}. This attribute should not be altered
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
218 directly.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
219 \end{memberdesc}
3194
05aeb91e3b90 Documented MACFS, macostools, EasyDialogs and FrameWork modules.
Jack Jansen <jack.jansen@cwi.nl>
parents:
diff changeset
220
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
221 \begin{memberdesc}[ProgressBar]{maxval}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
222 The maximum value (of type integer or long integer) of the progress
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
223 bar; the progress bar (thermometer style) is full when \member{curval}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
224 equals \member{maxval}. If \member{maxval} is \code{0}, the bar will
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
225 be indeterminate (barber-pole). This attribute should not be altered
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
226 directly.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
227 \end{memberdesc}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
228
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
229 \begin{methoddesc}[ProgressBar]{title}{\optional{newstr}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
230 Sets the text in the title bar of the progress dialog to
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
231 \var{newstr}.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
232 \end{methoddesc}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
233
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
234 \begin{methoddesc}[ProgressBar]{label}{\optional{newstr}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
235 Sets the text in the progress box of the progress dialog to
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
236 \var{newstr}.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
237 \end{methoddesc}
3258
6e48fab6990f Documented ProgressBar and idle()
Jack Jansen <jack.jansen@cwi.nl>
parents: 3194
diff changeset
238
23059
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
239 \begin{methoddesc}[ProgressBar]{set}{value\optional{, max}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
240 Sets the progress bar's \member{curval} to \var{value}, and also
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
241 \member{maxval} to \var{max} if the latter is provided. \var{value}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
242 is first coerced between 0 and \member{maxval}. The thermometer bar
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
243 is updated to reflect the changes, including a change from
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
244 indeterminate to determinate or vice versa.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
245 \end{methoddesc}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
246
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
247 \begin{methoddesc}[ProgressBar]{inc}{\optional{n}}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
248 Increments the progress bar's \member{curval} by \var{n}, or by \code{1}
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
249 if \var{n} is not provided. (Note that \var{n} may be negative, in
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
250 which case the effect is a decrement.) The progress bar is updated to
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
251 reflect the change. If the bar is indeterminate, this causes one
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
252 ``spin'' of the barber pole. The resulting \member{curval} is coerced
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
253 between 0 and \member{maxval} if incrementing causes it to fall
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
254 outside this range.
4c0ab5d6a63c Better documentation for GetArgv() and the ProgressBar type.
Fred Drake <fdrake@acm.org>
parents: 15225
diff changeset
255 \end{methoddesc}