Fix GUI and Reference doc typos
This commit is contained in:
Asumu Takikawa
parent
01a987bf5e
commit
ed590b8ec5
|
|
@ -183,7 +183,7 @@ See also @scheme[path-dialog%].
|
|||
}
|
||||
|
||||
@defproc[(message-box [title label-string?]
|
||||
[message string]
|
||||
[message string?]
|
||||
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]
|
||||
[style (listof (or/c 'ok 'ok-cancel 'yes-no 'caution 'stop)) '(ok)])
|
||||
(or/c 'ok 'cancel 'yes 'no)]{
|
||||
|
|
@ -319,7 +319,7 @@ The @racket[message-box/custom] function can be called int a thread
|
|||
current thread blocks while the dialog runs on the handler thread.}
|
||||
|
||||
@defproc[(message+check-box [title label-string?]
|
||||
[message string]
|
||||
[message string?]
|
||||
[check-label label-string?]
|
||||
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]
|
||||
[style (listof (or/c 'ok 'ok-cancel 'yes-no
|
||||
|
|
@ -367,7 +367,7 @@ Like @scheme[message-box/custom], except that
|
|||
|
||||
}
|
||||
|
||||
@defproc[(get-text-from-user [title string]
|
||||
@defproc[(get-text-from-user [title string?]
|
||||
[message (or/c string? #f)]
|
||||
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]
|
||||
[init-val string? ""]
|
||||
|
|
@ -391,7 +391,7 @@ If @scheme[style] includes @scheme['password], the dialog's text field
|
|||
|
||||
}
|
||||
|
||||
@defproc[(get-choices-from-user [title string]
|
||||
@defproc[(get-choices-from-user [title string?]
|
||||
[message (or/c string? #f)]
|
||||
[choices (listof string?)]
|
||||
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]
|
||||
|
|
|
|||
|
|
@ -196,7 +196,7 @@ Returns @racket[#t] if @litchar{m:} corresponds to Command,
|
|||
}
|
||||
|
||||
@defproc[(open-input-graphical-file [filename string?])
|
||||
input-port]{
|
||||
input-port?]{
|
||||
|
||||
Opens @racket[filename] (in @racket['binary] mode) and checks whether it looks
|
||||
like a ``graphical'' file in editor format. If the file does not
|
||||
|
|
@ -210,7 +210,7 @@ Opens @racket[filename] (in @racket['binary] mode) and checks whether it looks
|
|||
|
||||
@defproc[(open-input-text-editor [text-editor (is-a?/c text%)]
|
||||
[start-position exact-nonnegative-integer? 0]
|
||||
[end-position (or/c exact-nonnegative-integer? (one/of 'end)) 'end]
|
||||
[end-position (or/c exact-nonnegative-integer? 'end) 'end]
|
||||
[snip-filter ((is-a?/c snip%) . -> . any/c) (lambda (s) s)]
|
||||
[port-name any/c text-editor]
|
||||
[expect-to-read-all? any/c #f]
|
||||
|
|
@ -354,7 +354,7 @@ If @racket[raise-errors?] is true, then an error in reading triggers an
|
|||
}
|
||||
|
||||
@defproc[(text-editor-load-handler [filename path string]
|
||||
[expected-module-name (or/c symbol false/c)])
|
||||
[expected-module-name (or/c symbol? #f)])
|
||||
any/c]{
|
||||
|
||||
This procedure is a load handler for use with @racket[current-load].
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
@title[#:tag "eventspace-funcs"]{Eventspaces}
|
||||
|
||||
@defproc[(make-eventspace)
|
||||
eventspace]{
|
||||
eventspace?]{
|
||||
Creates and returns a new eventspace value. The new eventspace is
|
||||
created as a child of the current eventspace. The eventspace is used
|
||||
by making it the current eventspace with the
|
||||
|
|
@ -215,7 +215,7 @@ Blocks for at least the specified number of seconds, handling events
|
|||
|
||||
}
|
||||
|
||||
@defproc[(eventspace-shutdown? [e eventspace])
|
||||
@defproc[(eventspace-shutdown? [e eventspace?])
|
||||
boolean?]{
|
||||
Returns @scheme[#t] if the given eventspace has been shut down by its
|
||||
custodian, @scheme[#f] otherwise. Attempting to create a new window,
|
||||
|
|
@ -229,8 +229,8 @@ Attempting to use certain methods of windows and timers in a shut-down
|
|||
|
||||
}
|
||||
|
||||
@defproc[(eventspace-handler-thread [e eventspace])
|
||||
(or/c thread false/c)]{
|
||||
@defproc[(eventspace-handler-thread [e eventspace?])
|
||||
(or/c thread #f)]{
|
||||
Returns the handler thread of the given eventspace. If the handler
|
||||
thread has terminated (e.g., because the eventspace was shut down), the
|
||||
result is @scheme[#f].
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Returns the depth of the main display (a value of 1 denotes a monochrome display
|
|||
|
||||
}
|
||||
|
||||
@defproc[(get-display-left-top-inset [avoid-bars? bool #f])
|
||||
@defproc[(get-display-left-top-inset [avoid-bars? any/c #f])
|
||||
(values exact-nonnegative-integer? exact-nonnegative-integer?)]{
|
||||
|
||||
When the optional argument is @scheme[#f] (the default), this function
|
||||
|
|
@ -37,7 +37,7 @@ When the optional argument is true, this function returns the amount
|
|||
|
||||
}
|
||||
|
||||
@defproc[(get-display-size [full-screen? bool #f])
|
||||
@defproc[(get-display-size [full-screen? any/c #f])
|
||||
(values exact-nonnegative-integer? exact-nonnegative-integer?)]{
|
||||
|
||||
@index["screen resolution"]{Gets} the physical size of the display in
|
||||
|
|
|
|||
|
|
@ -37,13 +37,13 @@ Rings the system bell.
|
|||
See @racket[begin-busy-cursor].
|
||||
}
|
||||
|
||||
@defproc*[([(file-creator-and-type [filename path]
|
||||
@defproc*[([(file-creator-and-type [filename path?]
|
||||
[creator-string (lambda (s) (and (bytes? s)
|
||||
(= 4 (bytes-length s))))]
|
||||
[type-bytes (lambda (s) (and (bytes? s)
|
||||
(= 4 (bytes-length s))))])
|
||||
void?]
|
||||
[(file-creator-and-type [filename path])
|
||||
[(file-creator-and-type [filename path?])
|
||||
(values (lambda (s) (and (bytes? s)
|
||||
(= 4 (bytes-length s))))
|
||||
(lambda (s) (and (bytes? s)
|
||||
|
|
@ -128,7 +128,7 @@ Returns the color that is used to draw selected text or @racket[#f] if
|
|||
selected text is drawn with its usual color.}
|
||||
|
||||
|
||||
@defproc[(get-window-text-extent [string string]
|
||||
@defproc[(get-window-text-extent [string string?]
|
||||
[font (is-a?/c font%)]
|
||||
[combine? any/c #f])
|
||||
(values exact-nonnegative-integer?
|
||||
|
|
@ -141,7 +141,7 @@ argument is as for @xmethod[dc<%> get-text-extent].
|
|||
See also @xmethod[dc<%> get-text-extent].
|
||||
}
|
||||
|
||||
@defproc[(graphical-read-eval-print-loop [eval-eventspace eventspace #f]
|
||||
@defproc[(graphical-read-eval-print-loop [eval-eventspace (or/c eventspace? #f) #f]
|
||||
[redirect-ports? any/c (not eval-eventspace)])
|
||||
void?]{
|
||||
|
||||
|
|
@ -213,7 +213,7 @@ Returns @racket[#t] if a busy cursor has been installed with
|
|||
@racket[end-busy-cursor].
|
||||
}
|
||||
|
||||
@defproc[(label->plain-label [label string]) string?]{
|
||||
@defproc[(label->plain-label [label string?]) string?]{
|
||||
|
||||
Strips shortcut ampersands from @racket[label], removes parenthesized
|
||||
ampersand--character combinations along with any surrounding space,
|
||||
|
|
@ -226,7 +226,7 @@ Strips shortcut ampersands from @racket[label], removes parenthesized
|
|||
@defproc[(make-gl-bitmap [width exact-positive-integer?]
|
||||
[height exact-positive-integer?]
|
||||
[config (is-a?/c gl-config%)])
|
||||
(is-a/c? bitmap%)]{
|
||||
(is-a?/c bitmap%)]{
|
||||
|
||||
Creates a bitmap that supports both normal @racket[dc<%>] drawing an
|
||||
OpenGL drawing through a context returned by @xmethod[dc<%> get-gl-context].
|
||||
|
|
@ -252,7 +252,7 @@ environment of the result namespace.}
|
|||
|
||||
@defproc[(make-screen-bitmap [width exact-positive-integer?]
|
||||
[height exact-positive-integer?])
|
||||
(is-a/c? bitmap%)]{
|
||||
(is-a?/c bitmap%)]{
|
||||
|
||||
Creates a bitmap that draws in a way that is the same as drawing to a
|
||||
canvas in its default configuration.
|
||||
|
|
|
|||
|
|
@ -385,7 +385,7 @@ To report a run-time error, use @racket[raise] or procedures like
|
|||
@racket[error], instead of calling the error display handler
|
||||
directly.}
|
||||
|
||||
@defparam[error-print-width width (and exact-integer? (>=/c 3))]{
|
||||
@defparam[error-print-width width (and/c exact-integer? (>=/c 3))]{
|
||||
|
||||
A parameter whose value is used as the maximum number of characters
|
||||
used to print a Racket value that is embedded in a primitive error
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user