3.8 checkable-menu-item%

► |  | 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
check
is-checked?

Inherited methods:
from selectable-menu-item<%>
command
get-shortcut
get-shortcut-prefix
set-shortcut
set-shortcut-prefix
from labelled-menu-item<%>
enable
get-help-string
get-label
get-plain-label
is-enabled?
on-demand
set-help-string
set-label
from menu-item<%>
delete
get-parent
is-deleted?
restore

top contents ← prev up next →

class checkable-menu-item% : class?
superclass: object%
extends: | selectable-menu-item<%>

A checkable-menu-item% is a string-labelled menu item that maintains a check mark. Its parent must be a menu% or popup-menu%. When the user selects the menu item, the item’s check mark is toggled and its callback procedure is called.

> > constructor
> > (new checkable-menu-item% |
> > |  | [label label] |
> > |  | [parent parent] |
> > | [ | [callback callback] |
> > |  | [shortcut shortcut] |
> > |  | [help-string help-string] |
> > |  | [demand-callback demand-callback] |
> > |  | [checked checked] |
> > |  | [shortcut-prefix shortcut-prefix]]) |
> → (is-a?/c checkable-menu-item%)
> label : label-string?
> parent : (or/c (is-a?/c menu%) (is-a?/c popup-menu%))
> | callback |  | : |  |
> ((is-a?/c checkable-menu-item%) (is-a?/c control-event%)
> . -> . any)
> |  |  | = |  | (lambda (i e) (void))
> shortcut : (or/c char? symbol? #f) = #f
> help-string : (or/c label-string? #f) = #f
> | demand-callback |  | : |  | ((is-a?/c menu-item%) . -> . any)
> |  |  | = |  | (lambda (i) (void))
> checked : any/c = #f
> | shortcut-prefix |  | : |  |
> (and/c (listof (or/c 'alt 'cmd 'meta 'ctl
> 'shift 'option))
> (λ (x) (implies (equal? 'unix (system-type))
> (not (and (member 'alt x)
> (member 'meta x)))))
> (λ (x) (equal? x (remove-duplicates x))))
> |  |  | = |  | (get-default-shortcut-prefix)

Creates a new menu item in parent. The item is initially shown, appended to the end of its parent, and unchecked. The callback procedure is called (with the event type 'menu) when the menu item is selected (either via a menu bar, popup-menu in window<%>, or popup-menu in editor-admin%).

See set-label for information about mnemonic &s in label.

If shortcut is not #f, the item has a shortcut. See get-shortcut for more information. The shortcut-prefix argument determines the set of modifier keys for the shortcut; see get-shortcut-prefix.

If help is not #f, the item has a help string. See get-help-string for more information.

The demand-callback procedure is called by the default on-demand method with the object itself.

By default, the menu item is initially unchecked. If checked is true, then check is called so that the menu item is initially checked.

> method (send a-checkable-menu-item check check?) → void?
> check? : any/c

Checks or unchecks the menu item.

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

> method (send a-checkable-menu-item is-checked?) → boolean?

Returns #t if the item is checked, #f otherwise.
top contents ← prev up next →