gui/gui-doc/mrlib/scribblings/bitmap-label.scrbl
2014-12-02 02:33:07 -05:00

25 lines
859 B
Racket

#lang scribble/doc
@(require "common.rkt" (for-label mrlib/bitmap-label))
@title{Bitmap Label}
@defmodule[mrlib/bitmap-label]
@defproc[(make-bitmap-label [str string?]
[img (or/c (is-a?/c bitmap%) path-string?)]
[font (is-a?/c font%) normal-control-font])
(is-a?/c bitmap%)]{
Constructs a bitmap label suitable for use a button that contains the
image specified by @racket[img] followed by the text in @racket[str].}
@defproc[((bitmap-label-maker [str string?]
[img (or/c (is-a?/c bitmap%) path-string?)])
[future-parent any/c])
(is-a?/c bitmap%)]{
An older variant of @racket[make-bitmap-label] that was designed to
obtain a font to use from a container @racket[future-parent]. The
@racket[future-parent] argument is currently ignored.}