3.4 toggle-button-snip%

► |  | Embedded GUI: Widgets Within Editors

1 | Containers
2 | Controls
3 | Control Snips
4 | Helpers
5 | Snip Functions

▼ | 3 | Control Snips

3.1 | snip-wrapper%
3.2 | text-button-snip%
3.3 | button-snip%
3.4 | toggle-button-snip%

On this page:

new

Inherited methods:
from snip%
adjust-cursor
blink-caret
can-do-edit-operation?
copy
do-edit-operation
draw
equal-hash-code-of
equal-secondary-hash-code-of
equal-to?
find-scroll-step
get-admin
get-count
get-extent
get-flags
get-num-scroll-steps
get-scroll-step-offset
get-snipclass
get-style
get-text
get-text!
is-owned?
match?
merge-with
next
on-char
on-event
on-goodbye-event
other-equal-to?
own-caret
partial-offset
previous
release-from-owner
resize
set-admin
set-count
set-flags
set-snipclass
set-style
set-unmodified
size-cache-invalid
split
write

top ← prev up next →

class toggle-button-snip% : class?
superclass: snip%

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

> > constructor
> > (new toggle-button-snip% |
> > |  | [images-off images-off] |
> > |  | [images-on images-on] |
> > |  | [turn-on turn-on] |
> > |  | [turn-off turn-off] |
> > | [ | [state state]]) |
> → (is-a?/c toggle-button-snip%)
> 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 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 images-on argument similarly determines the images for then the button is checked.

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

The state argument determines whether the button is initially checked.
top ← prev up next →