1.95.3 Instance variables

menu <- accelerator_font: font=font*

Font in which keyboard accelerators are annotated. When @nil, possible accelerators are not annotated. Used by class popup.

menu <- border: width=0..

Border (in pixels) between the item and its box if graphical<-pen is not zero. When graphical<-pen equals 0, border is only an additional gap.

See also

- menu->border
- menu-gap

menu <- columns: number=1..

Number of columns over which the menu-items are spread. See the class documentation for details.

Defaults: The default is 1

See also

- menu-layout
- class menu

menu-default: value=any|chain|function*

Initial value as well as the value to which the menu<-selection is restored by menu->restore. If the menu has menu<-multiple_selection: @off this is a single value, otherwise it is a chain of values.

The default value may also be a function object. In this case menu->restore evaluates this function and uses the result to set the menu<-selection.

menu <- feedback: feedback={box,image,show_selection_only}

Style parameter that determines the visual feedback for the selection. The possible values are:

show_selection_only

Only applicable when menu<->multiple_selection equals @off. In this mode, only the selected item is displayed. Used to implement menu<->kind.

box

Draw a box around the selected item(s). The thickness of the line equals the pen of the menu plus 1.

invert

Invert the selected item(s). Used to implement‘Menu menu->kind: choice’. Note that inverting images gives strange results on colour displays.

image

Indicate the selection by painting menu<-off_image left of not-selected items and menu<-on_image left of selected items. Used to implement menu->kindmarked or toggle`.

See also

- menu_item-selected
- menu-kind

menu <- format: alignment={left,center,right}

The layout of menu_items in a menu is a 1 or 2 dimensional table. The menu will first determine the number and size of the rectangular cells in this table. This parameter determines how the items are aligned in their cell.

See also

text-format

menu <- gap: size

Amount of white space between the items in both X- and Y-direction. Note that the menu<->border is between the item and its surrounding box, while menu<->gap defines the distance between the surrounding boxes of adjacent items.

See also

menu-border

menu <- item_offset: offset=point

Offset in pixels of the first item, relative to the origin of the menu. Normally not useful for application programmers.

See also

- menu-label_area
- menu-item_size

menu <- item_size: size=size

Size of the box in which each item is formatted. An item at location (X,Y) is located at x-pixel location:

Menu?x + Menu?item_offset?x +
X*(Menu?item_size?w + Menu?gap?w).

and similar for the y-coordinate.

See also

- menu-label_area
- menu-item_offset

menu <- kind: kind={cycle,marked,choice,toggle,popup,cycle_popup}

The kind attribute is a shorthand for setting various style attributes to some predefined value. The variable menu<-kind provides the argument of the latest menu->kind invocation. Note that the menu may look very different due to subsequent style-parameters changed.

See also

- menu->initialise
- menu->kind
- menu-feedback

menu <- label_area: area=area*

Pixel area relative to the origin of the menu for formatting the label. Only applicable if menu<->show_label equals @on.

See also

- menu-item_size
- menu-item_offset

dialog_item <- label_font: font*

Font used to format the label. Only applicable if menu<-show_label equals @on.

menu <- layout: orientation={horizontal,vertical}

Determines whether subsequent items are places left-to-right (horizontal) or top-to-bottom (vertical). If menu<-columns is greater than 1 and layout is horizontal, the items are placed in horizontal rows. If layout is vertical, the items are placed in vertical columns.

See also

menu-columns

menu <- left_offset: offset=0..

Left margin between the item-box and the item itself. Used to reserve space for placing the selection markers if present. Its value is 0 if both menu<-on_image and menu<-off_image equal @nil and the maximum width plus menu<-border if one or both of the markers are defined.

menu <- members: items=chain

Chain of menu-items that are part of the menu.

See also

- menu_item-menu
- menu->append

menu <- multiple_selection: multiple=bool

If @on, any item can be either selected or deselected. It @off, exactly one item has status menu_item<->selected.

See also

menu_item-selected

menu <- off_image: image=image|{marked}*

Image painted in front of items that have MenuItem<->selected: @off. When @nil, no image is painted before the item.

See also

menu-on_image

menu <- on_image: image=image|{marked}*

Image painted in front of items that have MenuItem<->selected: @on. When @nil, no image is painted before the item.

See also

menu-off_image

menu <- popup_image: image=image*

Image painted to the right of items that have a popup associated with them. Only applicable to popup menu's with pullright submenu's in them.

menu <- preview: item=menu_item*

Menu_item in the preview state. Currently only used for popup-menu's.

See also

menu-preview_feedback

menu <-> preview_feedback: feedback={box,rounded_box,inverted_rounded_box,invert,colour}

Visual feedback used to indicate the item that is in the preview state. Possible values:

box

Draw a box around the item (like menu->feedback)

invert

Invert the box in which the item is formatted. Similar to menu->feedback, but the latter only inverts the item.

See also

menu-preview

menu <- right_offset: offset=0..

Right-margin between the item and its surrounding box. Its value is 0 if menu<-popup_image equals @nil or there is no item in the menu that has a dialog_item<->popup. Otherwise it is the width of menu<-popup_image plus menu<-border.

menu <- show_label: show=bool

If @on, the label is formatted in dialog_item<-label_font in the box determined by menu<-label_area. Otherwise the label is invisible.

menu <- value_font: font=font

Default font used to display the text of the items. This font may be overruled for an individual item using menu_item<->font. The latter is often used for font-selectors to display each item in the font that will be selected.

See also

- menu_item-font
- menu_item->font

menu <- value_width: width=0..

Minimum width used for the value. It is used for two purposes:

• popup menu's It is defined for popup-menu's to avoid very small windows when only short options are provided.
• Alignment of menu's The automatic layout mechanism of dialog window will align the values of menu's displayed below each other if their layout is horizontal.

  See also

  dialog_item-auto_value_align