3.12 combo-field%

► |  | 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
append
get-menu
on-popup

Inherited methods:
from text-field%
get-editor
get-field-background
get-value
set-field-background
set-value
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-activate
on-superwindow-enable
on-superwindow-show
popup-menu
refresh
screen->client
set-cursor
set-label
show
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 subarea<%>
horiz-margin
vert-margin

top contents ← prev up next →

class combo-field% : class?
superclass: text-field%

A combo-field% object is a text-field% object that also resembles a choice% object, because it has a small popup button to the right of the text field. Clicking the button pops up a menu, and selecting a menu item typically copies the item into the text field.

> > constructor
> > (new combo-field% |
> > |  | [label label] |
> > |  | [choices choices] |
> > |  | [parent parent] |
> > | [ | [callback callback] |
> > |  | [init-value init-value] |
> > |  | [style style] |
> > |  | [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 combo-field%)
> label : (or/c label-string? #f)
> choices : (listof label-string?)
> | parent |  | : |  |
> (or/c (is-a?/c frame%) (is-a?/c dialog%)
> (is-a?/c panel%) (is-a?/c pane%))
> | callback |  | : |  |
> ((is-a?/c combo-field%) (is-a?/c control-event%)
> . -> . any)
> |  |  | = |  | (lambda (c e) (void))
> init-value : string = ""
> | style |  | : |  |
> (listof (or/c 'horizontal-label 'vertical-label
> 'deleted))
> |  | = |  | null
> 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 = #t
> stretchable-height : any/c = #f

If label is not #f, it is used as the combo label. Otherwise, the combo does not display its label.

If & occurs in label, it is specially parsed as for button%.

The choices list specifies the initial list of items for the combo’s popup menu. The append method adds a new item to the menu with a callback to install the appended item into the combo’s text field. The get-menu method returns a menu that can be changed to adjust the content and actions of the combo’s menu.

The callback procedure is called when the user changes the text in the combo or presses the Enter key (and Enter is not handled by the combo’s frame or dialog; see on-traverse-char in top-level-window<%> ). If the user presses Enter, the type of event passed to the callback is 'text-field-enter, otherwise it is 'text-field.

If init-value is not "", the minimum width of the text item is made wide enough to show init-value. Otherwise, a built-in default width is selected.

If style includes 'vertical-label, then the combo is created with a label above the control; if style does not include 'vertical-label (and optionally includes 'horizontal-label), then the label is created to the left of the combo. If style includes 'deleted, then the combo is created as hidden, and it does not affect its parent’s geometry; the combo can be made active later by calling parent’s add-child method..

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-combo-field append l) → void?
> l : label-string?

Adds a new item to the combo’s popup menu. The given label is used for the item’s name, and the item’s callback installs the label into the combo’s text field.

> method (send a-combo-field get-menu) → (is-a?/c popup-menu%)

Returns a popup-menu% that is effectively copied into the combo’s popup menu when the combo is clicked. Only the labels and callbacks of the menu’s items are used; the enable state, submenus, or separators are ignored.

> method (send a-combo-field on-popup event) → void?
> event : (is-a?/c control-event%)

Specification: Called when the user clicks the combo’s popup button. Override this method to adjust the content of the combo menu on demand.

Default implementation: Does nothing.

top contents ← prev up next →