From 8101c03d308b2a0ff747e01cbdfcef0e37f34d88 Mon Sep 17 00:00:00 2001 From: Robby Findler Date: Sun, 12 Dec 2010 08:16:53 -0600 Subject: [PATCH] added a note about how label-string? is used. --- collects/scribblings/gui/miscwin-funcs.scrbl | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/collects/scribblings/gui/miscwin-funcs.scrbl b/collects/scribblings/gui/miscwin-funcs.scrbl index dcc9cdb021..99c4335e10 100644 --- a/collects/scribblings/gui/miscwin-funcs.scrbl +++ b/collects/scribblings/gui/miscwin-funcs.scrbl @@ -372,7 +372,15 @@ See @racket[clipboard<%>]. } @defproc[(label-string? [v any/c]) boolean?]{ - Returns @racket[#t] if @racket[v] is a string whose length is less than or equal to @racket[200]. + Returns @racket[#t] if @racket[v] is a string whose length is less than or equal to @racket[200]. + + This predicate is typically used as the contract for strings that + appear in GUI objects. In some cases, such as the label in a @racket[button%] + or @racket[menu-item%] object, the character @litchar{&} is treated specially + to indicate that the following character is used in keyboard navigation. See + @xmethod[labelled-menu-item<%> set-label] for one such example. + In other cases, such as the label on a @racket[frame%], @litchar{&} is not + treated specially. } @defproc[(key-code-symbol? [v any/c]) boolean?]{