3.17 dialog%

► |  | 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
on-subwindow-char
show
show-without-yield

Inherited methods:
from top-level-window<%>
can-close?
can-exit?
center
display-changed
get-edit-target-object
get-edit-target-window
get-eventspace
get-focus-object
get-focus-window
move
on-activate
on-close
on-exit
on-message
on-system-menu-char
on-traverse-char
resize
set-icon
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-event
on-subwindow-focus
on-superwindow-activate
on-superwindow-enable
on-superwindow-show
popup-menu
refresh
screen->client
set-cursor
set-label
warp-pointer
wheel-event-mode
from area<%>
get-graphical-min-size
get-parent
get-top-level-window
min-height
min-width
stretchable-height
stretchable-width
from area-container<%>
add-child
after-new-child
begin-container-sequence
border
change-children
container-flow-modified
container-size
delete-child
end-container-sequence
get-alignment
get-children
place-children
reflow-container
set-alignment
spacing

Racket
top contents ← prev up next →

class dialog% : class?
superclass: object%
extends: | top-level-window<%>

A dialog is a top-level window that is modal: while the dialog is shown, key and mouse press/release events are disabled for all other top-level windows in the dialog’s eventspace.

> > constructor
> > (new dialog% |
> > |  | [label label] |
> > | [ | [parent parent] |
> > |  | [width width] |
> > |  | [height height] |
> > |  | [x x] |
> > |  | [y y] |
> > |  | [style style] |
> > |  | [enabled enabled] |
> > |  | [border border] |
> > |  | [spacing spacing] |
> > |  | [alignment alignment] |
> > |  | [min-width min-width] |
> > |  | [min-height min-height] |
> > |  | [stretchable-width stretchable-width] |
> > |  | [stretchable-height stretchable-height]]) |
> → (is-a?/c dialog%)
> label : label-string?
> parent : (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) = #f
> width : (or/c dimension-integer? #f) = #f
> height : (or/c dimension-integer? #f) = #f
> x : (or/c dimension-integer? #f) = #f
> y : (or/c dimension-integer? #f) = #f
> | style |  | : |  |
> (listof (or/c 'no-caption 'resize-border
> 'no-sheet 'close-button))
> |  | = |  | null
> enabled : any/c = #t
> border : spacing-integer? = 0
> spacing : spacing-integer? = 0
> | alignment |  | : |  |
> (list/c (or/c 'left 'center 'right)
> (or/c 'top 'center 'bottom))
> |  |  | = |  | '(center top)
> min-width : (or/c dimension-integer? #f) = #f
> min-height : (or/c dimension-integer? #f) = #f
> stretchable-width : any/c = #t
> stretchable-height : any/c = #t

The label string is used as the dialog’s title in its title bar. If the dialog’s label is changed (see set-label), the title bar is updated.

The parent argument can be #f or an existing frame or dialog. On Windows, if parent is not #f, the new dialog is always on top of its parent. On Windows and Unix, a dialog is iconized when its parent is iconized.

If parent is #f, then the eventspace for the new dialog is the current eventspace, as determined by current-eventspace. Otherwise, parent’s eventspace is the new dialog’s eventspace.

If the width or height argument is not #f, it specifies an initial size for the dialog (in pixels) assuming that it is larger than the minimum size, otherwise the minimum size is used. On Windows and Mac OS (and with some Unix window managers) dialogs are not resizeable.

If the x or y argument is not #f, it specifies an initial location for the dialog. Otherwise, if no location is set before the dialog is shown, it is centered (with respect parent if not #f, the screen otherwise).

The style flags adjust the appearance of the dialog on some platforms:

- 'no-caption — omits the title bar for the dialog (Windows)

- 'resize-border — adds a resizeable border around the window (Windows), ability to resize the window (Mac OS), or grow box in the bottom right corner (older Mac OS)

- 'no-sheet — uses a movable window for the dialog, even if a parent window is provided (Mac OS)

- 'close-button — include a close button in the dialog’s title bar, which would not normally be included (Mac OS)

Even if the dialog is not shown, a few notification events may be queued for the dialog on creation. Consequently, the new dialog’s resources (e.g., memory) cannot be reclaimed until some events are handled, or the dialog’s eventspace is shut down.

For information about the enabled argument, see window<%>. For information about the border, spacing, and alignment arguments, see area-container<%>. For information about the min-width, min-height, stretchable-width, and stretchable-height arguments, see area<%>.

> > method
> > (send a-dialog on-subwindow-char |  | receiver |  |  |  |
> > |  | event) |  | → |  | boolean?
> receiver : (is-a?/c window<%>)
> event : (is-a?/c key-event%)

Overrides on-subwindow-char in window<%>.
Returns the result of

> (or (send this on-system-menu-char event)
> (send this on-traverse-char event))

> method (send a-dialog show show?) → void?
> show? : any/c

Overrides show in top-level-window<%>.
If show? is true, the dialog is shown and all frames (and other dialogs) in the eventspace become disabled until the dialog is closed. Furthermore, the method does not immediately return. Instead, it loops with yield until the dialog is found to be hidden between calls to yield. An internal semaphore is used with yield to avoid a busy-wait, and to ensure that the show method returns as soon as possible after the dialog is hidden.

If show? is false, the dialog is hidden and other frames and dialogs are re-enabled (unless a different, pre-existing dialog is still shown).

> method (send a-dialog show-without-yield) → void?

Like (send a-dialog show #t), but returns immediately instead of yielding.
top contents ← prev up next →