► |  | The Racket Graphical Interface Toolkit

1 | Windowing
2 | Widget Gallery
3 | Windowing Classes
4 | Windowing Functions
5 | Editors
6 | Snip and Style Classes
7 | Editor Classes
8 | Editor Functions
9 | WXME Decoding
10 | Preferences
11 | Dynamic Loading
12 | Startup Actions
13 | Init Libraries
14 | Platform Dependencies
| Index

▼ | 3 | Windowing Classes

3.1 | area<%>
3.2 | area-container<%>
3.3 | area-container-window<%>
3.4 | button%
3.5 | canvas<%>
3.6 | canvas%
3.7 | check-box%
3.8 | checkable-menu-item%
3.9 | choice%
3.10 | clipboard-client%
3.11 | clipboard<%>
3.12 | combo-field%
3.13 | control<%>
3.14 | column-control-event%
3.15 | control-event%
3.16 | cursor%
3.17 | dialog%
3.18 | event%
3.19 | frame%
3.20 | gauge%
3.21 | group-box-panel%
3.22 | grow-box-spacer-pane%
3.23 | horizontal-pane%
3.24 | horizontal-panel%
3.25 | key-event%
3.26 | labelled-menu-item<%>
3.27 | list-box%
3.28 | list-control<%>
3.29 | menu%
3.30 | menu-bar%
3.31 | menu-item<%>
3.32 | menu-item%
3.33 | menu-item-container<%>
3.34 | message%
3.35 | mouse-event%
3.36 | pane%
3.37 | panel%
3.38 | popup-menu%
3.39 | printer-dc%
3.40 | radio-box%
3.41 | selectable-menu-item<%>
3.42 | separator-menu-item%
3.43 | scroll-event%
3.44 | slider%
3.45 | subarea<%>
3.46 | subwindow<%>
3.47 | tab-panel%
3.48 | text-field%
3.49 | timer%
3.50 | top-level-window<%>
3.51 | vertical-pane%
3.52 | vertical-panel%
3.53 | window<%>

On this page:

new
get-value
set-label
set-value

Inherited methods:
from control<%>
command
from subwindow<%>
reparent
from window<%>
accept-drop-files
client->screen
enable
focus
get-client-handle
get-client-size
get-cursor
get-handle
get-height
get-label
get-plain-label
get-size
get-width
get-x
get-y
has-focus?
is-enabled?
is-shown?
on-drop-file
on-focus
on-move
on-size
on-subwindow-char
on-subwindow-event
on-subwindow-focus
on-superwindow-enable
on-superwindow-show
popup-menu
refresh
screen->client
set-cursor
show
warp-pointer
from area<%>
get-graphical-min-size
get-parent
get-top-level-window
min-height
min-width
stretchable-height
stretchable-width
from subarea<%>
horiz-margin
vert-margin

top ← prev up next →

> class

> check-box% : class?

superclass: object%

extends: | control<%>

A check box is a labeled box which is either checked or unchecked.

Whenever a check box is clicked by the user, the check box’s value is toggled and its callback procedure is invoked. A callback procedure is provided as an initialization argument when each check box is created.

> > constructor

> > (new check-box% |
> > |  | [label label] |
> > |  | [parent parent] |
> > | [ | [callback callback] |
> > |  | [style style] |
> > |  | [value value] |
> > |  | [font font] |
> > |  | [enabled enabled] |
> > |  | [vert-margin vert-margin] |
> > |  | [horiz-margin horiz-margin] |
> > |  | [min-width min-width] |
> > |  | [min-height min-height] |
> > |  | [stretchable-width stretchable-width] |
> > |  | [stretchable-height stretchable-height]]) |

> → (is-a?/c check-box%)
> label : (or/c label-string? (is-a?/c bitmap%))

> parent

> :

> (or/c (is-a?/c frame%) (is-a?/c dialog%)
> (is-a?/c panel%) (is-a?/c pane%))

> callback

> :

> ((is-a?/c check-box%) (is-a?/c control-event%)
> . -> . any)

> |  |  | = |  | (lambda (c e) (void))

> style : (listof (or/c 'deleted)) = null
> value : any/c = #f
> font : (is-a?/c font%) = normal-control-font
> enabled : any/c = #t
> vert-margin : spacing-integer? = 2
> horiz-margin : spacing-integer? = 2
> min-width : (or/c dimension-integer? #f) = #f
> min-height : (or/c dimension-integer? #f) = #f
> stretchable-width : any/c = #f
> stretchable-height : any/c = #f

Creates a check box with a string or bitmap label. If label is a bitmap, and if the bitmap has a mask (see get-loaded-mask in bitmap%) that is the same size as the bitmap, then the mask is used for the label. Modifying a bitmap while it is used as a label has an unspecified effect on the displayed label.

If & occurs in label (when label is a string), it is specially parsed as for button%.

The callback procedure is called (with the event type 'check-box) whenever the user clicks the check box.

If style includes 'deleted, then the check box is created as hidden, and it does not affect its parent’s geometry; the check box can be made active later by calling parent’s add-child method.

If value is true, it is passed to set-value so that the box is initially checked.

The font argument determines the font for the control. For information about the enabled argument, see window<%>. For information about the horiz-margin and vert-margin arguments, see subarea<%>. For information about the min-width, min-height, stretchable-width, and stretchable-height arguments, see area<%>.

> > method

> > (send a-check-box get-value) → boolean?

Gets the state of the check box: #t if it is checked, #f otherwise.

> > method

> > (send a-check-box set-label label) → void?

> label : (or/c label-string? (is-a?/c bitmap%))

Overrides set-label in window<%>.
The same as set-label in window<%> when label is a string.

Otherwise, sets the bitmap label for a bitmap check box. Since label is a bitmap, if the bitmap has a mask (see get-loaded-mask in bitmap%) that is the same size as the bitmap, then the mask is used for the label. Modifying a bitmap while it is used as a label has an unspecified effect on the displayed label. The bitmap label is installed only if the control was originally created with a bitmap label.

> > method

> > (send a-check-box set-value state) → void?

> state : any/c

Sets the check box’s state. (The control’s callback procedure is not invoked.)

The check box’s state can be changed by the user clicking the control, and such changes do not go through this method; use the control callback procedure (provided as an initialization argument) to monitor state changes.

If state is #f, the box is unchecked, otherwise it is checked.
top ← prev up next →