"

 COPYRIGHT (c) 1998 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.

"

"{ Package: 'stx:libview2' }"

Object subclass:#MenuItem

	instanceVariableNames:'activeHelpKey enabled label itemValue nameKey translateLabel

		isButton startGroup isVisible hideMenuOnActivated triggerOnDown

		indication submenu submenuChannel submenuProvider shortcutKey

		labelImage accessCharacterPosition argument choice choiceValue

		font auxValue showBusyCursorWhilePerforming keepLinkedMenu

		horizontalLayout sendToOriginator ignoreMnemonicKeys

		ignoreShortcutKeys isMenuSlice uuid'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Support'

!

!MenuItem class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1998 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.

"

!

documentation

"

    not yet finished MenuItem class - this will eventually replace

    most of the MenuView and PopUpMenu stuff.

    (and hopefully be ST-80 compatible ...)

    For now, only a subset of the full protocol is implemented.

    [author:]

        Claus Gittinger

    [see also:]

        MenuItem

        PopUpMenu

"

! !

!MenuItem class methodsFor:'instance creation'!

label:aString

    "create and return a new menuItem, given a label string"

    ^ self new 

        label:aString;

        yourself

    "Created: / 14-08-1998 / 19:19:14 / cg"

!

label:labelString choice:choiceAspect choiceValue:selectorOrValue

    "create and return a new menuItem, given its label and choice/value.

     This will create a Radio-Button-like item."

    ^ (self new) 

        label:labelString; choice:choiceAspect; choiceValue:selectorOrValue; 

        yourself

    "Modified (format): / 26-04-2012 / 12:06:41 / cg"

!

label:labelString itemValue:selectorOrValue

    "create and return a new menuItem, given its label and value"

    ^ (self new) 

        label:labelString itemValue:selectorOrValue; 

        yourself

    "Created: / 09-09-2012 / 13:21:48 / cg"

!

label:labelString itemValue:selectorOrValue argument:messageArg

    "create and return a new menuItem, given its label and value

     and an argument to be passed with the action"

    ^ (self new) 

        label:labelString; 

        itemValue:selectorOrValue argument:messageArg;

        yourself

    "Created: / 09-09-2012 / 13:22:31 / cg"

!

label:labelString itemValue:selectorOrValue enabled:enabledHolder

    "create and return a new menuItem, given its label, value

     and enabled holder, which can be a boolean, a boolean valueHolder,

     a block or a selector (to be sent to the application)"

    ^ (self new) 

        label:labelString itemValue:selectorOrValue enabled:enabledHolder

    "Created: / 09-09-2012 / 13:23:05 / cg"

!

label:labelString itemValue:selectorOrValue translateLabel:translateLabel

    "create and return a new menuItem, given its label, value and translateLabel flag"

    ^ (self new) 

        label:labelString 

        itemValue:selectorOrValue 

        translateLabel:translateLabel

!

label:labelString submenuChannel:aSymbolOrValueHolder

    "create and return a new menuItem, given its label and value"

    ^ (self new) 

        label:labelString submenuChannel:aSymbolOrValueHolder; 

        yourself

!

label:labelString value:selectorOrValue

    <resource: #obsolete>

    "create and return a new menuItem, given its label and value"

    ^ self label:labelString itemValue:selectorOrValue

    "Created: / 04-08-1998 / 17:34:18 / cg"

!

label:labelString value:selectorOrValue argument:messageArg

    <resource: #obsolete>

    "create and return a new menuItem, given its label and value"

    ^ (self new) 

        label:labelString; value:selectorOrValue; argument:messageArg;

        yourself

    "Created: / 26-04-2012 / 12:06:34 / cg"

!

label:labelString value:selectorOrValue enabled:enabledHolder

    <resource: #obsolete>

    "create and return a new menuItem, given its label and value"

    ^ (self new) 

        label:labelString; value:selectorOrValue; 

        enabled:enabledHolder;

        yourself

    "Created: / 29-10-2010 / 12:21:27 / cg"

!

labeled:aString

    <resource: #obsolete>

    "create and return a new menuItem, given a label string"

    ^ self label:aString

    "Modified: / 26-04-2012 / 12:07:12 / cg"

!

separator

    "create and return a new menuItem for a separator"

    ^ self new 

        label:'-'; translateLabel:false;

        yourself

    "Modified: / 26-04-2012 / 12:07:04 / cg"

! !

!MenuItem class methodsFor:'constants'!

supportedStartGroupValues

    "start group #left #right #conditionalRight ...

     At the moment only #left/nil, #right/#conditionalRight are implemented.

     The meanings are:

        nil                 - default under control of the menu

        #left               - left align

        #right              - place at the right far end

        #conditionalRight   - controlled by a styleSheet variable;

                              like #right under all non-win32 systems,

                              ignored on win32.

                              Use with help-menu, which should be at the far right on some

                              viewStyles, but not under win32."

    ^ #(nil #left #right #conditionalRight)

    "Created: / 16-10-2006 / 13:09:27 / cg"

! !

!MenuItem methodsFor:'Compatibility-ST80'!

enablementSelector:aSymbol

    "dummy for now - for visualworks compatibility (specs)"

    "/ self halt.

!

helpText:aString

    "dummy for now - for visualworks compatibility (specs)"

    activeHelpKey := aString.

!

indicationSelector:aSymbol

    "dummy for now - for visualworks compatibility (specs)"

    "/ self halt.

!

isEnabled:aBoolean

    self enabled:aBoolean

    "Created: / 27.10.1997 / 16:34:55 / cg"

!

shortcutModifiers:something

    "dummy for now - for visualworks compatibility (specs)"

    "/ self halt.

!

value

    "obsolete - please use #itemValue (value is bad: it prevents us from using a valueHolder)"

    ^ itemValue

    "Created: 25.2.1997 / 19:50:14 / cg"

!

value:something

    "obsolete - please use #itemValue: (value is bad: it prevents us from using a valueHolder)"

    itemValue := something

    "Created: 25.2.1997 / 19:11:13 / cg"

! !

!MenuItem methodsFor:'accessing'!

accessCharacterPosition

    "get the index of the access character in the label text or string, or nil if none"

    ^ accessCharacterPosition

!

accessCharacterPosition:index 

    "set the index of the access character in the label text or string, or nil if none"

    accessCharacterPosition := index

!

activeHelpKey

    "the key used as index (and argument) to the help/flyByHelpSpec"

    ^ activeHelpKey

!

activeHelpKey:aKey

    "the key used as index (and argument) to the help/flyByHelpSpec"

    activeHelpKey := aKey

!

argument

    "get argument given to the value (selector)"

    ^ argument

!

argument:something 

    "set argument given to the value (selector)"

    |arg|

    (arg := something) notNil ifTrue:[

        arg isString ifTrue:[

            (arg size == 0 or:[ (arg indexOfNonSeparatorStartingAt:1) == 0 ]) ifTrue:[

                arg := nil

            ]

        ]

    ].

    argument := arg

!

auxValue

    "an additional, arbitrary value"

    ^ auxValue

!

auxValue:something 

    "set the auxValue - an arbitrary user value"

    auxValue := something

!

choice:something

    choice := something.

    "Created: / 14.8.1998 / 14:32:06 / cg"

!

choiceValue

    ^ choiceValue

    "Created: / 14.8.1998 / 15:39:26 / cg"

!

choiceValue:something

    choiceValue := something.

    "Created: / 14.8.1998 / 15:39:26 / cg"

!

font

    "get the specific font for an item or nil"

    ^ font

!

font:aFont 

    "set a specific font for an item"

    font := aFont.

!

hierarchicalUUID

    ^ self uuid

!

horizontalLayout

    "by default, submenus have a vertical layout;

     if true, the submenu has a horizontal layout."

    ^ horizontalLayout ? false

!

horizontalLayout:aBoolean 

    "by default, submenus have a vertical layout;

     if true, the submenu has a horizontal layout."

    horizontalLayout := aBoolean.

!

ignoreMnemonicKeys

    "if true, mnemonic (access character) in the submenus under the item are ignored;

     Set this to speedup accelerator key processing for slow dynamci menus.

     The default is set to false"

    ^ ignoreMnemonicKeys ? false

    "Modified (comment): / 08-09-2011 / 04:30:19 / cg"

!

ignoreMnemonicKeys:aBoolean 

    "if true, mnemonic (access character) in the submenus under the item are ignored;

     Set this to speedup accelerator key processing for slow dynamci menus.

     the default is set to false"

    ignoreMnemonicKeys := aBoolean.

    "Modified (comment): / 08-09-2011 / 04:52:23 / cg"

!

ignoreShortcutKeys

    "if true, shortcutKeys (accelerators) in the submenus under the item are ignored;

     the default is set to false"

    ^ ignoreShortcutKeys ? false

!

ignoreShortcutKeys:aBoolean 

    "if true, shortcutKeys (accelerators) in the submenus under the item are ignored;

     the default is set to false"

    ignoreShortcutKeys := aBoolean.

!

indication

    "value of the items on/off indicator (CheckToggle).

     Usually a valueHolder"

    ^ indication

    "Created: 25.2.1997 / 20:59:28 / cg"

!

indication:someValueHolder 

    "value of the items on/off indicator (CheckToggle).

     someValueHolder is usually a value holder"

    indication := someValueHolder.

    "Created: 25.2.1997 / 20:59:28 / cg"

!

isMenuSlice:aBoolean

    isMenuSlice := aBoolean.

!

isVisible

    "a visibility holder; either a block, boolean or value holder.

     If the menu is permanently visible, it should be a valueHolder,

     as the value is otherwise only checked for before the menu is opened"

    ^ isVisible ? true

!

isVisible:something

    "a visibility holder; either a block, boolean or value holder.

     If the menu is permanently visible, it should be a valueHolder,

     as the value is otherwise only checked for before the menu is opened"

    isVisible := something

!

itemValue

    "the item's action; if it is a block, that is evaluated;

     if a symbol, that message is sent to the menu's receiver"

    ^ itemValue

    "Created: 25.2.1997 / 19:50:14 / cg"

!

itemValue:aBlockOrSymbol

    "set the item's action; if it is a block, that is evaluated;

     if a symbol, that message is sent to the menu's receiver"

    itemValue := aBlockOrSymbol

    "Created: 25.2.1997 / 19:11:13 / cg"

!

itemValue:selectorOrBlock argument:anArgument

    "set the item's action and an argument; if it is ablock, that is evaluated;

     if a symbol, that message is sent to the menu's receiver"

    itemValue := selectorOrBlock.

    argument := anArgument

    "Created: / 09-09-2012 / 13:05:14 / cg"

!

keepLinkedMenu

    "if true, a linked submenu menu is only computed once (slightly faster),

     but then, the linked menu cannot be dynamic"

    ^ keepLinkedMenu ? false

!

keepLinkedMenu:aBoolean

    "if true, a linked submenu menu is only computed once (slightly faster),

     but then, the linked menu cannot be dynamic"

    keepLinkedMenu := aBoolean ? false.

!

label:aString icon:anImage

    self label:aString.

    self resourceRetriever: (ResourceRetriever icon:anImage string:'')

!

label:labelString itemValue:selectorOrBlock

    label := labelString.

    itemValue := selectorOrBlock

    "Created: / 09-09-2012 / 13:18:34 / cg"

!