racket/collects/scribblings/gui/readable-snip-intf.scrbl
Matthew Flatt cac6aa498d checkpoint GUI docs
svn: r7110
2007-08-17 21:13:50 +00:00

26 lines
928 B
Racket

#reader(lib "defreader.ss" "scribble")
@require["common.ss"]
@definterface[readable-snip<%> ()]{
A @scheme[readable-snip<%>] object is treated specially by the port
generated by @scheme[open-input-text-editor]. When a
@scheme[readable-snip<%>] object is encountered for the input stream,
its @method[readable-snip<%> read-special] method is called to
generate the read result for the snip.
@defmethod[(read-special [source any/c]
[line (or/c nonnegative-exact-integer? false/c)]
[column (or/c nonnegative-exact-integer? false/c)]
[position (or/c nonnegative-exact-integer? false/c)])
any/c]{
The arguments are the same as the arguments to a procedure returned by
a custom input port's @scheme[read]; see @secref["mz:customport"] for
details. The result is also the same as the result from a
@scheme[read]-produced procedure.
}}