1.95.4 Send methods

menu ->_changed_item: changed=menu_item

Internal method to deal with changed items. When a menu-item is changed directly, it will send __changed_item_ to its menu.

menu ->active_all_items: active=bool

If @on, all items will be made active; otherwise all items will be made inactive.

See also

- menu->all_off
- menu_item-active
- menu->update

menu ->active_item: item=member:menu_item, active=bool

(De) activate a single item indicated by object. Object is either a menu_item or the value of a menu_item. Example:

?- new(M, menu(fill, marked)),
   send_list(M, append,
                         [ @nil,
                           @grey12_image,
                           @grey25_image
                         ]),
   send(M, active_item, @grey12_image, @off).

See also

- menu<-active_item
- menu->update

menu ->all_off:

Equivalent to

send(Menu, active_all_items, @off).

Available for backward compatibility.

See also

- menu->all_on
- menu->active_all_items

menu ->all_on:

Equivalent to

send(Menu, active_all_items, @on).

Available for backward compatibility.

See also

menu->all_off

menu ->append: item=menu_item

Append a menu-item to the menu. The appended item will always be the last. Note that class menu_item defines a conversion function that converts popups (for pullright menu's) and values into menu_items.

For popup objects, if the argument is the name gap, the last added item is sent menu_item->end_group. This inserts a group-separation line in the menu.

See also menu->members, menu->insert_before and send_list/3.

See also

- menu->prepend
- menu_item<-convert
- menu-members

menu ->apply: always=[bool]

If menu<-modified yields @on or always equals @on and menu<-selection succeeds, dialog_item<-message is forwarded with the following arguments:

@receiver	the menu
@arg1	menu<-selection.

See also dialog->apply.

menu ->border: width=0..

@see menu-border

menu ->clear:

Delete all items from the menu.

menu ->clear_selection:

Deselect all items. See also menu->selection.

See also

menu->selection

menu ->compute:

menu->compute recalculates various variables to speed-up redraw. These are menu<-label_area, menu<-item_offset, menu<-item_size, menu<-left_offset and menu<-right_offset.

menu ->delete: item=member:menu_item

Delete a menu_item or the menu_item that has the same menu<->value as the argument from the menu. Note that it is generally bad style to change the contents of menu's. Normally items that should not be activated in some context are made inactive.

menu ->event: event

First tries dialog_item->event. On failure it passes the event of @_button_gesture if graphical<-active equals @on. The real work is done by menu->execute.

See also

- menu<-item_from_event
- menu->execute

menu ->execute: event=[event]

Execution of a menu implies setting the selection and -if there is a message to execute-, execute this message. The exact behaviour is determined by various style parameter:

menu <-feedback: ->

equals show_selection_only Select the next item

menu <-multiple_selection: ->

== @on Toggle the graphical<->selected attribute of the item on which the event occurred.

menu <-multiple_selection: ->

== @off Make the selection of the menu the item on which the event occurred.

See also

menu->event

menu ->initialise: name=[name], kind=[name], message=[code]*

Create from its dialog_item->label, menu->kind and dialog_item->message. See class menu for details.

Defaults: The default dialog_item->label is the classname of the menu (menu). The default menu->kind is determined by the resource menu.kind. The default message is @default.

See also

- dialog_item-message
- menu-kind
- dialog_item-label
- class menu

menu ->insert_before: item=menu_item, before=name|menu_item

Insert item before another one. If before is a name, menu<-member is used to translate it into a menu_item. If before is not in the menu, the new item is menu->append’ed to the menu.

See also menu->append and menu->prepend.

menu ->is_off: item=member:menu_item

Find menu-item from object and test whether graphical<->active equals @off.

See also

menu->is_on

menu ->is_on: item=member:menu_item

Find menu-item from object and test whether graphical<->active equals @on.

See also

menu->is_off

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

The menu->kind method allows for the selection of some commonly occurring combinations of menu parameters with a single method. The available options are:

cycle

Only display the selection. Clicking on the menu selects the next right-item. The menu has a popup-menu associated that allows for an overview of all available items. Useful for not very commonly used menu's as it uses much less space on the screen.

marked

Single selection menu with markers (see menu<-on_image and menu<-off_image) to indicate the selected item.

toggle

As marked, but multiple items may be selected.

choice

As marked, but the selection is indicated by inverting the it.

popup

Used internally. Popup menus are implemented on top of class menu.

cycle_popup

Used internally for the popup of menu<-kind cycle menus.

See also

- menu-kind
- class menu

menu ->member: item=member:menu_item

Succeeds if the argument is a member menu_item.

Bugs: Used to set the notion of menu<->current in older versions. In its current definition it is not very useful. Use menu<-member to test membership.

See also

menu<-member

menu ->members: chain

menu->clear the menu and then use menu->append to add each member of the chain to the menu. This implies chain may contain both menu_item objects and plain names.

See also menu_item<-convert and send_list/3.

menu ->modified: modified=bool

Inherits description from: menu<-modified

menu ->next: direction=[{down,up}]

Selects the first item with menu_item<-active after the currently selected menu_item. When the currently selected item is the last or there is no currently selected item, the first active item is selected.

Used internally when menu<-show_selection_only equals @on (menu<->kind: cycle).

menu ->off: item=member:menu_item

Invokes menu_item->active on the indicated menu-item, making the indicated menu-item insensitive.

See also

- menu_item-condition
- menu_item-active
- menu->on
- menu<-member

menu ->on: item=member:menu_item

As menu->off, but activates the menu_item.

See also

menu->off

menu ->prepend: item=menu_item

Associate the argument menu_item as first rather than last item of the menu. See also menu->append and menu->insert_before.

See also

menu->append

menu ->selected: item=member:menu_item, selected=bool

Set menu_item<-selected of item. Equivalent to sending the message directly to the menu_item object, but type-conversion will convert a menu_item<-value to the corresponding menu_item.

menu ->selection: selection=member:menu_item|chain*

Select the specified menu_item or chain of menu_items. All other menu_items are deselected.

If the argument is @nil, this is equivalent to menu->clear_selection,

• unless* there is a menu_item with menu_item<-value. Backward compatibility.

  Bugs: Does not check menu<-multiple_selection, resulting in an inconsistent menu when multiple object are selected in a menu with menu<-multiple_selection: @off.

  See also

  - menu<-selection
  - menu_item-selected
  - menu->clear_selection

menu ->status: {inactive,active,preview,execute}

The dialog_item<-status of a menu is not used.

menu ->unlink:

Sets menu_item<-menu of all member items to @nil, clears menu->members and invokes menu->unlink on the super-class.

See also

graphical->unlink

menu ->update: context=[any]

Update the activation of the menu_items in this menu. For each menu_item that has a menu<->condition not equal to @nil, it invokes the menu_item<->condition attribute, providing the following context information:

@receiver	The menu_item
@arg1	The argument (i.e. the context)

If the message evaluates successfully, the menu_item is activated, otherwise it is deactivated.

See also

- menu->active_item
- menu->active_all_items
- popup->update