1.123.2 Send methods

popup ->close:

Remove the popup from the display. First it will popup->close possible open pullright menus. Then is removes the popup menu from its graphical<-window and adds the window to the pool of window objects used to display popup menu's.

This method is always called as a normal message and thus may be redefined.

popup ->drag: event, check_pullright=[bool]

Handle a drag event. This method is called from popup->event. It should not be used, nor be redefined, except for emergencies.

This method locates the current item using menu<-item_from_event and activates this using menu->preview. If the drag event is on an item with a menu_item<-popup and the event is near the popup marker (see menu<-popup_image), the pullright menu is activated by invoking popup->show_pullright_menu.

popup ->end_group: bool

If this is a pullright menu, set menu_item->end_group in the associated menu_item. This will put a line below the item.

popup ->event: event

Performs the following steps

• If the popup has a -pullright and the event is on an item of this menu, popup->close the pullright menu.
• If the popup has a -pullright and the event is a button-up of the same button that started the popup, assign popup<-selected_item with the pullright menu, assign -pullright with @nil and popup->close the pullright.
• If there is no -pullright and the event is the button-up event, assign popup<-selected_item with menu<-preview and popup->close the popup.
• If the event is a button-down, set popup<-selected_item to @nil and send popup<-button to the event<-button
• If the event is a drag event, update menu->preview. If a pullright area is entered, popup->update the pullright and popup->open it.

popup ->execute: context=[object]*

This method is normally invoked from popup_gesture->terminate. The argument (denoted context) is normally the object to which the popup menu is associated.

First it locates the selected menu_item object and the message to execute. This message is menu_item<-message if this does not yeild @default, otherwise dialog_item<-message. The forwarded arguments are:

• menu<-multiple_selection: @off using menu_item<-message

  @receiver:	The popup
  @arg1:	The context argument

• menu<-multiple_selection: @off using dialog_item<-message

  @receiver:	The popup
  @arg1	menu_item<-value
  @arg2:	The context argument

• menu<-multiple_selection: @on using menu_item<-message

  @receiver:	The popup
  @arg1:	menu_item<-selected
  @arg2:	The context argument

• menu<-multiple_selection: @on using dialog_item<-message

  @receiver:	The popup
  @arg1:	menu_item<-value
  @arg2:	menu_item<-selected
  @arg3:	The context argument

  See also

  popup_gesture->terminate

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

Create a popup menu from its name (which is only displayed if menu<-show_label equals @on) and a message. This message will be executed when a menu_item object is selected that has‘menu_item dialog_item<-message: @default’. Using a message at the popup (menu) level is commonly used if the menu selects from a value-set (fonts, colours, names. ...). If the menu is used to activate commands the actions are normally associated with the individual items.

popup ->open: on=graphical, offset=point, offset_is_pointer=[bool], warp=[bool], ensure_on_display=[bool]

Open a popup menu on the display. Normally invoked from a popup_gesture object. The arguments are:

• on Graphical (window) for which the popup is displayed (popup<-context)
• offset
• offset_is_pointer (default @on) Position of the top-left corner of the popup relative to the popup<-context iff offset_is_pointer equals @off, otherwise the position of the pointer.
• warp_pointer (default @on) If the popup is moved (see ensure_on_display), move the pointer accordingly.
• ensure_on_display (default @on) If @on, move the popup if it would otherwise be (partly) outside the display.

  See also

  popup_gesture->initiate

popup ->reset:

Equivalent to popup->close.

popup ->show_pullright_menu: item=menu_item, event=[event], context=[any]

Show pullright for this item. Called from popup->drag. item is the item for which to show a pullright menu. First updates the menu_item<-popup and -if the popup has menu<-members- opens the popup.

popup ->update: context=any

This behaviour is normally invoked just before the popup-menu is mapped on the display. This is done automatically for popups associated with menu_bars or managed by a popup_gesture (i.e. all normal ways to manage a popup).

Update first invokes popup<->update_message, providing its argument as @arg1. This message is supposed to update the available entries of the popup; not the activation status of the individual entries. Next, popup->update invokes menu->update, which takes care of activating the appropriate entries.

See also

- menu_item-condition
- menu->update
- popup-update_message
- popup_gesture->initiate