Class: MenuEvent

• Inheritance
• Description
• Class protocol
  • instance creation
• Instance protocol
  • accessing
  • instance creation
• Private classes

Inheritance:

   Object
   |
   +--Message
      |
      +--MessageSend
         |
         +--Event
            |
            +--WindowEvent
               |
               +--WidgetEvent
                  |
                  +--MenuEvent
                     |
                     +--MenuEvent::MenuEnterItemEvent
                     |
                     +--MenuEvent::MenuHideEvent
                     |
                     +--MenuEvent::MenuLeaveItemEvent
                     |
                     +--MenuEvent::MenuSelectItemEvent
                     |
                     +--MenuEvent::MenuShowEvent

Package:

stx:libwidg

Category:

Views-Menus

Version:

rev: 1.4 date: 2019/12/13 20:31:33

user: cg

file: MenuEvent.st directory: libwidg

module: stx stc-classLibrary: libwidg

Description:

Internal menu events.
These have been added very lately to support capture & replay inside st/x applications.
They are used internally within a menu-widget instead of direct message sends, thus
allowing interception and synthetization.

Due to some historic leftover, there are two mechanisms for menus:
    1) the (very) old MenuView (which inherits from SelectionInListView)
    2) the new MenuPanel.

The menuView uses simple text and values and it is basically index-based.
The menuPanel uses instances of MenuItem which contain the action information.

The menuView should go away, as soon as someone finds time to convert all leftover uses
of it in the system (mostly popupMenus in text views).

copyright
COPYRIGHT (c) 2018 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 enterMenuItem: itemOrNil index: index text: textOrNil value: valueOrNil inMenu: aMenu menuReceiver: menuReceiver

 hideMenu: aMenu

 leaveMenuItem: itemOrNil index: index text: textOrNil value: valueOrNil inMenu: aMenu menuReceiver: menuReceiver

 selectMenuItem: itemOrNil index: indexOrNil text: textOrNil value: valueOrNil inMenu: aMenu menuReceiver: menuReceiver

 showMenu: aMenu

Instance protocol:

 item

attention: only menuPanels return something useful here;
menuview will return nil

 itemIndex

the index (1..) of the menu item

 itemLabel

the item's label text. Might be nil or non-string (image or labelAndIcon)

 itemValue

the item's value. That is completely up to the menu-widget's user.

 menu

the item's menu; either a menuPanel or a menuView

 menuReceiver

 item: itemArgOrNil index: indexArgOrNil text: textArgOrNil value: valueArgOrNil menu: aMenu menuReceiver: menuReceiverArg

Private classes:

    MenuEnterItemEvent
    MenuHideEvent
    MenuLeaveItemEvent
    MenuSelectItemEvent
    MenuShowEvent