File: toggle-button-snip.scrbl

package info (click to toggle)
racket 8.7%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 165,720 kB
  • sloc: ansic: 298,502; lisp: 224,176; pascal: 73,851; sh: 18,449; asm: 13,494; makefile: 1,785; cpp: 1,713; javascript: 1,281; exp: 756; csh: 412; perl: 275; python: 270; xml: 106
file content (28 lines) | stat: -rw-r--r-- 1,133 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#lang scribble/doc
@(require "common.rkt")

@defclass/title[toggle-button-snip% snip% ()]{

A @racket[check-box%]-like control that a user can toggle between
checked and unchecked states.

@defconstructor[([images-off (cons/c path-string? path-string?)]
                 [images-on (cons/c path-string? path-string?)]
                 [turn-on ((is-a?/c toggle-button-snip%) (is-a?/c event%) . -> . void?)]
                 [turn-off ((is-a?/c toggle-button-snip%) (is-a?/c event%) . -> . void?)]
                 [state (symbols 'on 'off) 'on])]{

The @racket[images-off] argument is a pair filenames to be load as the
button-label image, where the first is the image for when the button
is at rest, and the second is the image for the button while its
pressed---in both cases when the button is not checked by the
user.  The @racket[images-on] argument similarly determines the images
for then the button is checked.

The @racket[turn-on] and @racket[turn-off] callbacks are invoked when
the button changes to checked or unchecked, respectively.

The @racket[state] argument determines whether the button is initially
checked.}

}