doc clarifications

This commit is contained in:
Matthew Flatt 2011-03-29 19:44:20 -06:00
parent 05b777d382
commit 68f7e9f33b
2 changed files with 11 additions and 11 deletions

View File

@ -626,7 +626,7 @@ When an editor or snip is drawn, an argument to the drawing method
The @scheme['show-inactive-caret] display mode is useful for showing The @scheme['show-inactive-caret] display mode is useful for showing
selection ranges in text editors that do not have the focus. This selection ranges in text editors that do not have the focus. This
@scheme['show-inactive-caret] mode is distinct from @scheme['no-caret] @scheme['show-inactive-caret] mode is distinct from @scheme['no-caret]
mode; when editors are embedded, only the locally-active editor shows mode; when editors are embedded, only the locally active editor shows
its selection. its selection.

View File

@ -170,7 +170,7 @@ Called when the snip's editor's method is called,
[bottom real?] [bottom real?]
[dx real?] [dx real?]
[dy real?] [dy real?]
[draw-caret (or/c (one-of/c 'no-caret 'show-inactive-caret 'show-caret) [draw-caret (or/c 'no-caret 'show-inactive-caret 'show-caret
(cons/c exact-nonnegative-integer? (cons/c exact-nonnegative-integer?
exact-nonnegative-integer?))]) exact-nonnegative-integer?))])
void?]{ void?]{
@ -191,14 +191,14 @@ The @racket[dx] and @racket[dy] argument provide numbers that can be
See @|drawcaretdiscuss| for information about See @|drawcaretdiscuss| for information about
@racket[draw-caret]. When @racket[draw-caret] is a pair, refrain from @racket[draw-caret]. When @racket[draw-caret] is a pair, refrain from
drawing a background for the selected region, and use drawing a background for the selected region, and if
@racket[get-highlight-text-color] when it is not @racket[#f] for @racket[(get-highlight-text-color)] returns a color (instead of @racket[#f]),
drawing text and other ``foreground'' elements. use that color for drawing selected text and other selected foreground elements.
Before this method is called, the correct font, text color, and pen Before this method is called, the font, text color, and pen color for
color for the snip's style will have been set in the drawing context the snip's style will have been set in the drawing context. (The
already. (This is @italic{not} true for @method[snip% get-extent] or drawing context is @italic{not} so configured for @method[snip%
@method[snip% partial-offset].) The @method[snip% draw] method must get-extent] or @method[snip% partial-offset].) The @method[snip% draw] method must
not make any other assumptions about the state of the drawing not make any other assumptions about the state of the drawing
context, except that the clipping region is already set to something context, except that the clipping region is already set to something
appropriate. Before @method[snip% draw] returns, it must restore any appropriate. Before @method[snip% draw] returns, it must restore any
@ -229,7 +229,7 @@ more specific equivalence comparison.}}
@defmethod[(other-equal-to? [that (is-a?/c snip%)] @defmethod[(other-equal-to? [that (is-a?/c snip%)]
[equal? (-> any/c any/ boolean?)]) [equal? (-> any/c any/ boolean?)])
boolean?]{ boolean?]{
@methimpl{Returns @racket[(eq? this that)].} @methimpl{Returns @racket[(eq? @#,(this-obj) that)].}
} }
@defmethod[(equal-hash-code [hash-code (any/c . -> . exact-integer?)]) @defmethod[(equal-hash-code [hash-code (any/c . -> . exact-integer?)])
@ -237,7 +237,7 @@ more specific equivalence comparison.}}
@methspec{See @racket[equal<%>].} @methspec{See @racket[equal<%>].}
@methimpl{Returns @racket[(eq-hash-code this)].}} @methimpl{Returns @racket[(eq-hash-code @#,(this-obj))].}}
@defmethod[(equal-secondary-hash-code [hash-code (any/c . -> . exact-integer?)]) @defmethod[(equal-secondary-hash-code [hash-code (any/c . -> . exact-integer?)])
exact-integer?]{ exact-integer?]{